批量查询扫描结果

最近更新时间:2018-12-20 21:12:25

1. 接口描述

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

用户通过CreateScanInstances接口提交应用进行风险批量扫描后,用此接口批量获取风险详细信息,包含漏洞信息,广告信息,插件信息和病毒信息

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeScanResults
Version String 公共参数,本接口取值:2018-04-08
Region String 公共参数,本接口不需要传递此参数。
ItemId String 任务唯一标识
AppMd5s.N Array of String 批量查询一个或者多个app的扫描结果,如果不传表示查询该任务下所提交的所有app

3. 输出参数

参数名称 类型 描述
ScanSet Array of ScanSetInfo 批量扫描的app结果集
TotalCount Integer 批量扫描结果的个数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询扫描结果

输入示例

https://ms.tencentcloudapi.com/?Action=DescribeScanResults
&ItemId=1shi2e-2387hjgus&AppMd5s.0=dd5b29a800246d7089febf228286d901
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "ScanSet": [
      {
        "VulInfo": {
          "VulFileScore": "0",
          "VulList": [
            {
              "VulName": "漏洞名称",
              "RiskLevel": "风险级别",
              "VulSolution": "修复建议",
              "VulSrcType": "漏洞来源类别",
              "VulCode": "漏洞代码",
              "VulDesc": "漏洞描述",
              "VulId": "漏洞id",
              "VulFilepath": "漏洞路径"
            }
          ]
        },
        "VirusInfo": {
          "VirusDesc": "病毒描述",
          "VirusName": "病毒名称",
          "SafeType": "安全类型"
        },
        "TaskStatus": 0,
        "AdInfo": {
          "BoutiqueRecommand": [],
          "NotifyBar": [],
          "Spot": [],
          "IntegralWall": [],
          "FloatWindows": [],
          "Banner": []
        },
        "TaskTime": 124545458,
        "AppDetailInfo": {
          "AppMd5": "dd5b29a800246d7089febf228286d901",
          "AppName": "微信",
          "AppVersion": "1.0",
          "AppSize": 1234565,
          "AppPkgName": "com.tencent.mm",
          "AppIconUrl": "https://example.com/1.png"
        }
      }
    ],
    "RequestId": "5e93a212-ca01-0fdc-eedd-5a1fce5e83e6"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.ServerError 服务端无法响应。
MissingParameter.MissingItemId 缺少ItemId字段。
ResourceNotFound.ItemIdNotFound ItemId不存在。