1. 接口描述
接口请求域名: ms.tencentcloudapi.com 。
本接口用于查看app列表。
可以通过指定任务唯一标识ItemId来查询指定app的详细信息,或通过设定过滤器来查询满足过滤条件的app的详细信息。 指定偏移(Offset)和限制(Limit)来选择结果中的一部分,默认返回满足条件的前20个app信息。(注意:根据国家互联网用户实名制相关要求,使用该产品前,需先完成实名认证。)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeShieldInstances。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Filters.N | 否 | Array of Filter | 支持通过app名称,app包名,加固的服务版本,提交的渠道进行筛选。 示例值:[ { "Name": "AppPkgName", "Value": "com.tencent.mm" }, { "Name": "AppName", "Value": "wechat" } ] |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
Limit | 否 | Integer | 数量限制,默认为20,最大值为100。 示例值:20 |
ItemIds.N | 否 | Array of String | 可以提供ItemId数组来查询一个或者多个结果。注意不可以同时指定ItemIds和Filters。 示例值:["com.tencent.demo"] |
OrderField | 否 | String | 按某个字段排序,目前仅支持TaskTime排序。 示例值:"TaskTime" |
OrderDirection | 否 | String | 升序(asc)还是降序(desc),默认:desc。 示例值:"desc" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合要求的app数量 示例值:10 |
AppSet | Array of AppSetInfo | 一个关于app详细信息的结构体,主要包括app的基本信息和加固信息。 示例值:[{ "ItemId": "1234-xcse-ddw1", "AppName": "微信", "AppPkgName": "com.tencent.mm", "AppVersion": "6.5", "AppMd5": "der2331ds", "AppSize": 123454, "ServiceEdition": "basic", "ShieldCode": 0, "AppUrl": "https://www.example.com/a.apk", "AppIconUrl": "https://wwww.example.com/12334", "ClientIp": "1.1.1.1", "ShieldMd5": "ae5df985a27b07f56d8c670fef70d7c9", "ShieldSize": 1193311, "TaskStatus": 1, "TaskTime": 1524744997 }] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询加固实例列表
根据加固实例的包名和名称进行筛选,并返回最新的20条记录
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeShieldInstances
<公共请求参数>
{
"Limit": "20",
"Filters": [
{
"Name": "AppPkgName",
"Value": "com.tencent.mm"
},
{
"Name": "AppName",
"Value": "wechat"
}
],
"Offset": "0"
}
输出示例
{
"Response": {
"RequestId": "5e93a212-ca01-0fdc-eedd-5a1fce5e83e6",
"TotalCount": 10,
"AppSet": [
{
"ItemId": "1234-xcse-ddw1",
"AppName": "微信",
"AppPkgName": "com.tencent.mm",
"AppVersion": "6.5",
"AppMd5": "der2331ds",
"AppSize": 123454,
"ServiceEdition": "basic",
"ShieldCode": 0,
"AppUrl": "https://www.example.com/a.apk",
"AppIconUrl": "https://wwww.example.com/12334",
"ClientIp": "1.1.1.1",
"ShieldMd5": "ae5df985a27b07f56d8c670fef70d7c9",
"ShieldSize": 1193311,
"TaskStatus": 1,
"TaskTime": 1524744997
}
]
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
InternalError.ServerError | 服务端无法响应。 |
InvalidParameterValue.InvalidCoexistItemIdsFilters | 不能同时指定ItemIds和Filters。 |
InvalidParameterValue.InvalidFilter | 无效的过滤器。 |
InvalidParameterValue.InvalidItemIds | ItemIds不合法。 |
InvalidParameterValue.InvalidLimit | Limit不是有效的数字。 |
InvalidParameterValue.InvalidOffset | Offset不是有效的数字。 |
InvalidParameterValue.InvalidOrderDirection | OrderDirection参数。 |
InvalidParameterValue.InvalidOrderField | OrderField取值不合法。 |
UnauthorizedOperation.NotWhiteUser | 不是白名单用户。 |