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

1. 接口描述

此接口处于预下线状态 。

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

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

由于该产品是线上免费使用产品,无企业版用户,升级迭代成本高及人力安排等原因,安全测评产品不再接入新用户,故下线。

本接口用于查看app列表。
可以通过指定任务唯一标识ItemId来查询指定app的详细信息,或通过设定过滤器来查询满足过滤条件的app的详细信息。 指定偏移(Offset)和限制(Limit)来选择结果中的一部分,默认返回满足条件的前20个app信息。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeScanInstances。
Version String 公共参数,本接口取值:2018-04-08。
Region String 公共参数,本接口不需要传递此参数。
Filters.N Array of Filter 支持通过app名称,app包名进行筛选
Offset Integer 偏移量,默认为0
Limit Integer 数量限制,默认为20,最大值为100。
ItemIds.N Array of String 可以提供ItemId数组来查询一个或者多个结果。注意不可以同时指定ItemIds和Filters。
OrderField String 按某个字段排序,目前仅支持TaskTime排序。
OrderDirection String 升序(asc)还是降序(desc),默认:desc。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合要求的app数量
ScanSet Array of AppScanSet 一个关于app详细信息的结构体,主要包括app的基本信息和扫描状态信息。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询扫描实例列表

根据提交实例的包名和名称进行筛选,并返回最新的20条记录

输入示例

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

{
    "Limit": "20",
    "Filters": [
        {
            "Name": "AppPkgName",
            "Value": "com.tencent.mm"
        },
        {
            "Name": "AppName",
            "Value": "wechat"
        }
    ],
    "Offset": "0"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "ScanSet": [
            {
                "ItemId": "xx",
                "AppMd5": "xx",
                "AppName": "xx",
                "ScanCode": 1,
                "AppVersion": "xx",
                "TaskStatus": 1,
                "AppSid": "xx",
                "TaskTime": 1,
                "VulCount": 1,
                "AppSize": 1,
                "AppPkgName": "xx",
                "AppIconUrl": "xx",
                "SafeType": 1
            }
        ],
        "RequestId": "xx"
    }
}

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 参数取值错误。
InvalidParameterValue.InvalidFilter 无效的过滤器。
InvalidParameterValue.InvalidItemIds ItemIds不合法。
InvalidParameterValue.InvalidLimit Limit不是有效的数字。
InvalidParameterValue.InvalidOffset Offset不是有效的数字。
InvalidParameterValue.InvalidOrderField OrderField取值不合法。
LimitExceeded 超过配额限制。
UnsupportedOperation 操作不支持。