1. 接口描述
接口请求域名: ms.tencentcloudapi.com 。
该接口供渠道合作应用加固使用,接口调用有白名单用户限制。入参中的条件过滤字段均为精准匹配。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeEncryptPlan。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
PlatformType | 是 | Integer | 平台类型 1.android加固 2.ios源码混淆 3.sdk加固 4.applet小程序加固 示例值:1 |
OrderType | 是 | Integer | 订单采购类型 1-免费试用 2-按年收费 3-按次收费 示例值:1 |
EncryptOpType | 是 | Integer | 1-在线加固;2-输出工具 示例值:1 |
ResourceId | 是 | String | 本次加固使用的资源id 示例值:svmsref_xxxxx |
AppPkgName | 否 | String | (条件过滤字段)加固查询时,根据包名查询 示例值:com.tencent.demo |
AppType | 否 | String | (条件过滤字段)加固查询时,根据应用格式查询,枚举值:“apk”、“aab” 示例值:apk |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PlatformType | Integer | 平台类型整型值 示例值:apk |
PlatformTypeDesc | String | 平台类型描述 1.android加固 2.ios源码混淆 3.sdk加固 4.applet小程序加固 示例值:android加固 |
EncryptOpType | Integer | 1- 在线加固 2-输出工具加固 示例值:1 |
EncryptOpTypeDesc | String | 1- 在线加固 2-输出工具加固 示例值:在线加固 |
OrderType | Integer | 订单收费类型枚举值 示例值:1 |
OrderTypeDesc | String | 订单收费类型描述 示例值:免费试用 |
ResourceId | String | 资源id 示例值:svmsref_xxxxx |
AndroidPlan | AndroidPlan | 上次加固策略 示例值:{ "AppPkgName": "xxx.xx.xxr", "AppType": "apk", "EncryptParam": "{"dex":{"enable":1,"antiprotect":1,"antirepack":1,"dexsig":1,"antimonitor":1,"ptrace":1}}" } |
AppletPlan | AppletPlan | 上次小程序加固策略 示例值:{ "AppletLevel": 1, "PlanId": 11988 } |
IOSPlan | IOSPlan | 上次ios源码混淆加固配置 示例值:{ "PlanId": 1 } |
SDKPlan | SDKPlan | 上次sdk加固配置 示例值:{ "PlanId": 1 } |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 小程序在线加固
载入上次配置
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEncryptPlan
<公共请求参数>
{
"PlatformType": 4,
"OrderType": 1,
"EncryptOpType": 1,
"ResourceId": "XXXXXXXXXXXXXXXX"
}
输出示例
{
"Response": {
"AppletPlan": {
"AppletLevel": 1,
"PlanId": 11988
},
"ResourceId": "XXXXXXXXXXXXXXXX",
"OrderType": 1,
"OrderTypeDesc": "免费试用",
"EncryptOpType": 1,
"EncryptOpTypeDesc": "在线加固",
"PlatformType": 4,
"PlatformTypeDesc": "applet小程序加固",
"RequestId": "4fd83459-e0fc-4c1f-ab00-8f2c99f51bd4"
}
}
示例2 Android输出工具配置查询
Android输出工具配置查询
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEncryptPlan
<公共请求参数>
{
"PlatformType": 1,
"OrderType": 1,
"EncryptOpType": 2,
"ResourceId": "XXXXXXXXXXXXXXXX"
}
输出示例
{
"Response": {
"ResourceId": "XXXXXXXXXXXXXXXX",
"OrderType": 1,
"OrderTypeDesc": "免费试用",
"AndroidPlan": {
"AppPkgName": "com.tencent.demo",
"AppType": "apk",
"EncryptParam": "{\"dex\":{\"enable\":1,\"antiprotect\":1,\"antirepack\":1,\"dexsig\":1,\"antimonitor\":1,\"ptrace\":1}}",
"PlanId": 11981
},
"EncryptOpType": 2,
"EncryptOpTypeDesc": "输出工具",
"PlatformType": 1,
"PlatformTypeDesc": "android加固",
"RequestId": "a0d996fe-fa97-404a-87b0-b9690f92de26"
}
}
示例3 小程序在线加固载入上次配置实例
小程序在线加固载入上次配置实例
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEncryptPlan
<公共请求参数>
{
"PlatformType": 4,
"OrderType": 1,
"EncryptOpType": 1,
"ResourceId": "XXXXXXXXXXXXXXXX"
}
输出示例
{
"Response": {
"AppletPlan": {
"AppletLevel": 1,
"PlanId": 12012
},
"ResourceId": "XXXXXXXXXXXXXXXX",
"OrderType": 1,
"OrderTypeDesc": "免费试用",
"EncryptOpType": 1,
"EncryptOpTypeDesc": "在线加固",
"PlatformType": 4,
"PlatformTypeDesc": "applet小程序加固",
"RequestId": "323b8dda-4623-4b7b-bb54-8d0a90e90cb1"
}
}
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.InvalidAuthorization | CAM签名/鉴权错误。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
UnauthorizedOperation.AuthFailed | 鉴权失败。 |
UnauthorizedOperation.NotWhiteUser | 不是白名单用户。 |
UnsupportedOperation | 操作不支持。 |