1. 接口描述
接口请求域名: ms.tencentcloudapi.com 。
通过唯一标识获取加固的结果。(注意:根据国家互联网用户实名制相关要求,使用该产品前,需先完成实名认证。)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeShieldResult。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ItemId | 是 | String | 任务唯一标识 示例值:1shi2e-2387hjgus |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskStatus | Integer | 任务状态: 0-请返回,1-已完成,2-处理中,3-处理出错,4-处理超时 示例值:0 |
AppDetailInfo | AppDetailInfo | app加固前的详细信息 示例值:{ "AppIconUrl": "https://ms-shield-logo-1251001047-1252181758.cosgz.myqcloud.com/0/881ac0a49b3ae9967022217730cc0da8/onetools.apklogo", "AppMd5": "881ac0a49b3ae9967022217730cc0da8", "AppName": "一个木函", "AppPkgName": "com.One.WoodenLetter", "AppSize": 4743475, "AppVersion": "7.8.1", "FileName": "onetools.apk" } |
ShieldInfo | ShieldInfo | app加固后的详细信息 示例值:{ "AppUrl": "https://ms-shield-1251001047-1252181758.cos.ap-guangzhou.myqcloud.com/encrypt_dist/881ac0a49b3ae9967022217730cc0da8.20220412121930.apk?sign=q-sign-algorithm%3Dsha1%26q-ak%3D************************************************************%26q-sign-time%3D1650339239%3B1650342839%26q-key-time%3D1650339239%3B1650342839%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Dfbf5764a72c6e42c97aeb53c6cf6e6b85f6e7689%00", "ItemId": "0b5465636cac72bb98e24b6aa4f4c488", "ServiceEdition": "basic", "ShieldCode": 0, "ShieldMd5": "5c5d992097727c2f9789fea97441bd52", "ShieldSize": 5373548, "TaskTime": 1649737137 } |
StatusDesc | String | 状态描述 示例值:成功 |
StatusRef | String | 状态指引 示例值:加固成功 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 返回
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeShieldResult
<公共请求参数>
{
"ItemId": "0b5465636cac72bb98e24b6aa4f4c488"
}
输出示例
{
"Response": {
"AppDetailInfo": {
"AppIconUrl": "https://ms-shield-logo-1251001047-1252181758.cosgz.myqcloud.com/0/881ac0a49b3ae9967022217730cc0da8/onetools.apklogo",
"AppMd5": "881ac0a49b3ae9967022217730cc0da8",
"AppName": "一个木函",
"AppPkgName": "com.One.WoodenLetter",
"AppSize": 4743475,
"AppVersion": "7.8.1",
"FileName": "onetools.apk"
},
"RequestId": "5bcf07de-03fe-4f8b-b859-9b7b47316045",
"ShieldInfo": {
"AppUrl": "https://ms-shield-1251001047-1252181758.cos.ap-guangzhou.myqcloud.com/encrypt_dist/881ac0a49b3ae9967022217730cc0da8.20220412121930.apk?sign=q-sign-algorithm%3Dsha1%26q-ak%3D************************************************************%26q-sign-time%3D1650339239%3B1650342839%26q-key-time%3D1650339239%3B1650342839%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Dfbf5764a72c6e42c97aeb53c6cf6e6b85f6e7689%00",
"ItemId": "0b5465636cac72bb98e24b6aa4f4c488",
"ServiceEdition": "basic",
"ShieldCode": 0,
"ShieldMd5": "5c5d992097727c2f9789fea97441bd52",
"ShieldSize": 5373548,
"TaskTime": 1649737137
},
"StatusDesc": "成功",
"StatusRef": "加固成功",
"TaskStatus": 1
}
}
示例2 查询加固结果
通过唯一标识获取加固的结果,唯一标识ItemId通过请求加固接口返回
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeShieldResult
<公共请求参数>
{
"ItemId": "1shi2e-2387hjgus"
}
输出示例
{
"Response": {
"RequestId": "5e93a212-ca01-0fdc-eedd-5a1fce5e83e6",
"TaskStatus": 0,
"StatusDesc": "成功",
"StatusRef": "加固成功",
"AppDetailInfo": {
"AppName": "微信",
"AppPkgName": "com.tencent.mm",
"AppVersion": "1.0",
"AppSize": 1234565,
"AppMd5": "dd5b29a800246d7089febf228286d901",
"FileName": "onetools.apk",
"AppIconUrl": "https://example.com/1.png"
},
"ShieldInfo": {
"ShieldCode": 1,
"ShieldSize": 1024,
"ShieldMd5": "25787jhids",
"AppUrl": "https://example.com/1.apk",
"TaskTime": 1245478744,
"ItemId": "hji452-huhsxqwq1212",
"ServiceEdition": "enterprise"
}
}
}
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 | 服务端无法响应。 |
MissingParameter.MissingItemId | 缺少ItemId字段。 |
ResourceNotFound.ItemIdNotFound | ItemId不存在。 |
UnauthorizedOperation.NotWhiteUser | 不是白名单用户。 |
UnsupportedOperation | 操作不支持。 |