批量提交安全扫描

最近更新时间:2019-07-24 15:28:32

1. 接口描述

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

用户通过该接口批量提交应用进行应用扫描,扫描后需通过DescribeScanResults接口查询扫描结果

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateScanInstances
Version String 公共参数,本接口取值:2018-04-08
Region String 公共参数,本接口不需要传递此参数。
AppInfos.N Array of AppInfo 待扫描的app信息列表,一次最多提交20个
ScanInfo ScanInfo 扫描信息

3. 输出参数

参数名称 类型 描述
ItemId String 任务唯一标识
Progress Integer 任务状态: 1-已完成,2-处理中,3-处理出错,4-处理超时
AppMd5s Array of String 提交成功的app的md5集合
LimitCount Integer 剩余可用次数
LimitTime Integer 到期时间
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 提交一个app进行扫描

通过该接口提交要扫描的app信息(示例中的AppUrl和CallbackUrl仅示例,实际无法使用,请用实际可用的url进行替换)

输入示例

https://ms.tencentcloudapi.com/?Action=CreateScanInstances
&AppInfos.0.AppUrl=http://example.com/1.apk
&AppInfos.0.AppMd5=dd5b29a800246d7089febf228286d901
&AppInfos.0.AppSize=1024
&ScanInfo.CallbackUrl=http://example.com/cb
&ScanInfo.ScanTypes.0=ADSCAN
&ScanInfo.ScanTypes.1=VULSCAN
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "5e93a212-ca01-0fdc-eedd-5a1fce5e83e6",
    "Progress": 1,
    "ItemId": "shgugu-hiw72-334kd",
    "AppMd5s": [
      "sashiuashiah",
      "hugugusaw76712"
    ],
    "LimitTime": 0,
    "LimitCount": 0
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.ServerError 服务端无法响应。
LimitExceeded 超过配额限制
MissingParameter.MissingAppInfo AppInfo结构体参数缺失。