1. 接口描述
接口请求域名: ms.tencentcloudapi.com 。
该接口供渠道合作应用加固使用,接口调用有白名单用户限制。 接口返回的结果为:创建订单后,订单审批状态信息,以及与订单关联的资源状态等信息,入参中的条件过滤字段均为精准匹配.
接口功能点:
1.支持多订单分页查询;
2.支持唯一订单号精准匹配查询;
3.支持唯一资源号精准匹配查询;
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeOrderInstances。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
PageNumber | 否 | Integer | 页码 示例值:1 |
PageSize | 否 | Integer | 每页展示数量 示例值:10 |
OrderField | 否 | String | 按某个字段排序,目前仅支持CreateTime排序。 示例值:"CreateTime" |
OrderDirection | 否 | String | 升序(asc)还是降序(desc),默认:desc。 示例值:“desc” |
PlatformType | 否 | Integer | (条件过滤字段)平台类型 1.android加固 2.ios源码混淆 3.sdk加固 4.applet小程序加固 示例值:1 |
OrderType | 否 | Integer | (条件过滤字段)订单采购类型 1-免费试用 2-按年收费 3-按次收费 示例值:1 |
ApprovalStatus | 否 | Integer | (条件过滤字段)订单审批状态: 示例值:0 |
ResourceStatus | 否 | Integer | (条件过滤字段)资源状态: 示例值:1 |
OrderId | 否 | String | (条件过滤字段)订单ID 示例值:20230602_xxxxx |
ResourceId | 否 | String | (条件过滤字段)资源ID 示例值:20230602_xxxxx |
AppPkgName | 否 | String | (条件过滤字段)包名,查询android加固订单时使用 示例值:com.tencent.com |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总记录数 示例值:1 |
Orders | Array of Orders | 订单信息 示例值:[ { "AppPkgName": "com.tencent.demo", "ApprovalStatus": 1, "ApprovalStatusDesc": "审批通过", "ApprovalTime": "2023-06-02 17:51:55", "Approver": "xxxxxx", "CreateTime": "2023-06-02 17:42:06", "ExpireTime": "0000-00-00 00:00:00", "OrderId": "20230602_03702020-0a90-4f46-8f20-XXXXXXXXX", "OrderType": 3, "OrderTypeDesc": "按次收费", "PlatformType": 1, "PlatformTypeDesc": "android加固", "ResourceId": "20230602_03702020-0a90-4f46-8f20-XXXXXXXXX_0", "ResourceStatus": 1, "ResourceStatusDesc": "生效中", "TestTimes": 0, "TimesTaskFailCount": 6, "TimesTaskSuccessCount": 2, "TimesTaskTotalCount": 8, "ValidTime": "0000-00-00 00:00:00" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据订单id查订单资源信息
根据订单id查订单资源信息
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrderInstances
<公共请求参数>
{
"OrderId": "20230602_03702020-0a90-4f46-8f20-XXXXXXXXX"
}
输出示例
{
"Response": {
"Orders": [
{
"AppPkgName": "com.tencent.demo",
"ApprovalStatus": 1,
"ApprovalStatusDesc": "审批通过",
"ApprovalTime": "2023-06-02 17:51:55",
"Approver": "lili",
"CreateTime": "2023-06-02 17:42:06",
"ExpireTime": "0000-00-00 00:00:00",
"OrderId": "20230602_03702020-0a90-4f46-8f20-XXXXXXXXX",
"OrderType": 3,
"OrderTypeDesc": "按次收费",
"PlatformType": 1,
"PlatformTypeDesc": "android加固",
"ResourceId": "20230602_03702020-0a90-4f46-8f20-XXXXXXXXX_0",
"ResourceStatus": 1,
"ResourceStatusDesc": "生效中",
"TestTimes": 0,
"TimesTaskFailCount": 6,
"TimesTaskSuccessCount": 2,
"TimesTaskTotalCount": 8,
"ValidTime": "0000-00-00 00:00:00"
}
],
"RequestId": "c3af1139-4146-4a17-a4f7-395933351a5f",
"TotalCount": 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.InvalidAuthorization | CAM签名/鉴权错误。 |
InternalError | 内部错误。 |
UnauthorizedOperation.AuthFailed | 鉴权失败。 |
UnauthorizedOperation.NotWhiteUser | 不是白名单用户。 |
UnsupportedOperation | 操作不支持。 |