查看站点列表

最近更新时间:2018-10-26 15:31:56

1. 接口描述

接口请求域名: cws.tencentcloudapi.com 。

本接口 (DescribeSites) 用于查询一个或多个站点的详细信息。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSites
Version String 公共参数,本接口取值:2018-03-12
Region String 公共参数,本接口不需要传递此参数。
SiteIds.N Array of Integer 站点ID列表
Filters.N Array of Filter 过滤条件
Offset Integer 偏移量,默认为0
Limit Integer 返回数量,默认为10,最大值为100

3. 输出参数

参数名称 类型 描述
TotalCount Integer 站点数量。
Sites Array of Site 站点信息列表。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 查看站点列表

输入示例

https://cws.tencentcloudapi.com/?Action=DescribeSites
&Filters.0.Name=Name
&Filters.0.Values.0=QQ
&Filters.0.Values.1=微信
&Filters.1.Name=Url
&Filters.1.Values.0=http%3A%2F%2Fdemo.aisec.cn
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "Sites": [
      {
        "Appid": 1251001047,
        "CreatedAt": "2018-03-19T16:33:45+08:00",
        "Id": 4,
        "LastScanCancelTime": "",
        "LastScanExtsCount": "",
        "LastScanFinishTime": "2018-03-19T17:38:56+08:00",
        "LastScanNoticeNum": 1,
        "LastScanPageCount": 0,
        "LastScanScannerType": "",
        "LastScanStartTime": "2018-03-22T00:00:00+08:00",
        "LastScanTaskId": 0,
        "LastScanVulsHighNum": 0,
        "LastScanVulsLowNum": 0,
        "LastScanVulsMiddleNum": 0,
        "LastScanVulsNoticeNum": 0,
        "LastScanVulsNum": 10,
        "LoginCheckKw": "",
        "LoginCheckUrl": "",
        "LoginCookie": "",
        "LoginCookieValid": 0,
        "MonitorId": 0,
        "MonitorStatus": 0,
        "Name": "Spqs6w6el",
        "NeedLogin": 0,
        "Progress": 0,
        "ScanDisallow": "",
        "ScanStatus": 0,
        "UpdatedAt": "2018-03-19T17:38:56+08:00",
        "Url": "http://demo.aisec.cn/demo/aisec/",
        "UserAgent": "",
        "VerifyStatus": 0
      }
    ],
    "TotalCount": 1
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter.Malformed 错误的数据格式。
InvalidParameter.NotFound 请求的数据不存在。