有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

此接口处于预下线状态 。

预计下线时间:2023-06-12 17:34:34

接口请求域名: 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进行替换)

输入示例

POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateScanInstances
<公共请求参数>

{
    "ScanInfo": {
        "ScanTypes": [
            "VULSCAN",
            "ADSCAN"
        ],
        "CallbackUrl": "http://example.com/cb"
    },
    "AppInfos": [
        {
            "AppMd5": "dd5b29a800246d7089febf228286d901",
            "AppUrl": "http://example.com/1.apk",
            "AppSize": "1024"
        }
    ]
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.ServerError 服务端无法响应。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter.MissingAppInfo AppInfo结构体参数缺失。
UnsupportedOperation 操作不支持。