1. 接口描述
接口请求域名: ms.tencentcloudapi.com 。
用户通过该接口提交应用进行应用加固,加固后需通过DescribeShieldResult接口查询加固结果。(注意:根据国家互联网用户实名制相关要求,使用该产品前,需先完成实名认证。)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateShieldInstance。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
AppInfo | 是 | AppInfo | 待加固的应用信息 示例值:{ "AppMd5": "dd5b29a800246d7089febf228286d901", "AppUrl": "http://example.com/1.apk", "AppSize": "1024" } |
ServiceInfo | 是 | ServiceInfo | 加固服务信息 示例值:{ "CallbackUrl": "http://example.com/cb", "SubmitSource": "MC", "ServiceEdition": "basic" } |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Progress | Integer | 任务状态: 1-已完成,2-处理中,3-处理出错,4-处理超时 示例值:1 |
ItemId | String | 任务唯一标识 示例值:shgugu-hiw72-334kd |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交一个app进行加固
通过该接口提交要加固的app信息(示例中的AppUrl和CallbackUrl仅示例,实际无法使用,请用实际可用的url进行替换)
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateShieldInstance
<公共请求参数>
{
"AppInfo": {
"AppMd5": "dd5b29a800246d7089febf228286d901",
"AppUrl": "http://example.com/1.apk",
"AppSize": "1024"
},
"ServiceInfo": {
"CallbackUrl": "http://example.com/cb",
"SubmitSource": "MC",
"ServiceEdition": "basic"
}
}
输出示例
{
"Response": {
"RequestId": "5e93a212-ca01-0fdc-eedd-5a1fce5e83e6",
"Progress": 1,
"ItemId": "shgugu-hiw72-334kd"
}
}
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 | 服务端无法响应。 |
InvalidParameter.MissingServiceInfo | ServiceInfo结构体参数缺失。 |
InvalidParameter.PlanIdNotFound | 不能找到指定的加固策略。 |
LimitExceeded | 超过配额限制。 |
MissingParameter.MissingAppInfo | AppInfo结构体参数缺失。 |
ResourceNotFound.PlanIdNotFound | 无法找到指定的加固策略。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.NotFound | 找不到该资源。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NotWhiteUser | 不是白名单用户。 |