1. 接口描述
接口请求域名: ms.tencentcloudapi.com 。
对资源进行策略新增。(注意:根据国家互联网用户实名制相关要求,使用该产品前,需先完成实名认证。)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateShieldPlanInstance。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ResourceId | 是 | String | 资源id 示例值:127500-shi |
PlanName | 是 | String | 策略名称 示例值:默认加固策略 |
PlanInfo | 是 | PlanInfo | 策略具体信息 示例值:{ "AntiRoot":"0", "FileSign": "0", "SetFile":"0", "Dex": "1", "SoType": [ "1" ], "AntiLogLeak": "0", "ApkSizeOpt": "1", "SoInfo": { "SoFileNames": [ "a.so" ] }, "AntiQemuRoot": "0", "AntiVMP": "0", "Db": "0", "SeperateDex": "0", "AntiScreenshot": "0", "So": "1", "AntiRepack": "1", "AntiAssets": "0", "DexSig": "1", "Bugly": "0", "AntiSSL": "0" } |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PlanId | Integer | 策略id 示例值:1 |
Progress | Integer | 任务状态: 1-已完成,2-处理中,3-处理出错,4-处理超时 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新增加固策略
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateShieldPlanInstance
<公共请求参数>
{
"PlanName": "默认加固策略",
"ResourceId": "127500-shi",
"PlanInfo": {
"AntiRoot": "0",
"FileSign": "0",
"SetFile": "0",
"Dex": "1",
"SoType": [
"1"
],
"AntiLogLeak": "0",
"ApkSizeOpt": "1",
"SoInfo": {
"SoFileNames": [
"a.so"
]
},
"AntiQemuRoot": "0",
"AntiVMP": "0",
"Db": "0",
"SeperateDex": "0",
"AntiScreenshot": "0",
"So": "1",
"AntiRepack": "1",
"AntiAssets": "0",
"DexSig": "1",
"Bugly": "0",
"AntiSSL": "0"
}
}
输出示例
{
"Response": {
"RequestId": "5e93a212-ca01-0fdc-eedd-5a1fce5e83e6",
"Progress": 1,
"PlanId": 1
}
}
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 | 内部错误。 |
InternalError.ServerError | 服务端无法响应。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.NotFound | 找不到该资源。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NotWhiteUser | 不是白名单用户。 |