1. 接口描述
接口请求域名： cdc.tencentcloudapi.com 。
查询专用集群订单列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDedicatedClusterOrders。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-14。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DedicatedClusterIds.N | 否 | Array of String | 按照专用集群id过滤 示例值：["cluster-xh37dh"] |
| DedicatedClusterOrderIds | 否 | String | 按照专用集群订单id过滤 示例值：["ord-xjehslf"] |
| Offset | 否 | Integer | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。示例值：20 |
| Status | 否 | String | 订单状态为过滤条件：PENDING INCONSTRUCTION DELIVERING DELIVERED EXPIRED CANCELLED OFFLINE 示例值：DELIVERED |
| ActionType | 否 | String | 订单类型为过滤条件：CREATE EXTEND 示例值：CREATE |
| OrderTypes.N | 否 | Array of String | 订单类型列表 示例值：["PUSH"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DedicatedClusterOrderSet | Array of DedicatedClusterOrder | 专用集群订单列表 示例值：[ { "Action": "CREATE", "CheckExpectTime": "0000-00-00 00:00:00", "CheckFinishTime": "0000-00-00 00:00:00", "CheckStatus": "DELIVERING", "Cpu": 0, "CreateTime": "2024-10-30T09:14:13Z", "DedicatedClusterId": "cluster-262n63e8", "DedicatedClusterOrderId": "ord-rd0ty398", "DedicatedClusterOrderItems": [ { "ComputeFormat": "1 SA5t.60XLARGE1076", "Count": 1, "CreateTime": "2024-10-30 17:14:13", "DedicatedClusterTypeId": "dctype-00100001", "Description": "基础底座", "Name": "基础底座", "PowerDraw": 0, "SubOrderId": "sord-e3t9jkm2", "SubOrderPayStatus": 0, "SubOrderStatus": "PENDING", "SupportedInstanceFamily": [], "SupportedStorageType": [], "SupportedUplinkSpeed": [ 10, 25, 40, 100 ], "TotalCpu": 0, "TotalGpu": 0, "TotalMem": 0, "TypeFamily": "CUSTOM", "TypeName": "BASE_EQUIPMENT.BASE_FOUNDATION", "Weight": 0 } ], "DedicatedClusterTypeId": "None", "DeliverExpectTime": "0000-00-00 00:00:00", "DeliverFinishTime": "0000-00-00 00:00:00", "Gpu": 0, "Mem": 0, "OrderPayPlan": null, "OrderSLA": null, "OrderStatus": "PENDING", "OrderType": "PUSH", "PayStatus": 0, "PayType": "ONEOFF", "PowerDraw": 0, "SupportedInstanceFamily": [ "None" ], "SupportedStorageType": [ "None" ], "SupportedUplinkSpeed": [ -1 ], "TimeSpan": 3, "TimeUnit": "YEAR", "Weight": 0 } ] |
| TotalCount | Integer | 符合条件的专用集群订单总数 示例值：20 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询专用集群订单列表
查询专用集群订单列表
输入示例
POST / HTTP/1.1
Host: cdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDedicatedClusterOrders
<公共请求参数>
{
"DedicatedClusterIds": [
"cluster-262n63e8"
],
"Offset": 0,
"Limit": 1,
"ActionType": "CREATE",
"OrderTypes": [
"PUSH"
]
}输出示例
{
"Response": {
"DedicatedClusterOrderSet": [
{
"Action": "CREATE",
"CheckExpectTime": "0000-00-00 00:00:00",
"CheckFinishTime": "0000-00-00 00:00:00",
"CheckStatus": "DELIVERING",
"Cpu": 0,
"CreateTime": "2024-09-22T00:00:00+00:00",
"DedicatedClusterId": "cluster-262n63e8",
"DedicatedClusterOrderId": "ord-rd0ty398",
"DedicatedClusterOrderItems": [
{
"ComputeFormat": "1 SA5t.60XLARGE1076",
"Count": 1,
"CreateTime": "2024-09-22T00:00:00+00:00",
"DedicatedClusterTypeId": "dctype-00100001",
"Description": "基础底座",
"Name": "基础底座",
"PowerDraw": 0,
"SubOrderId": "sord-e3t9jkm2",
"SubOrderPayStatus": 0,
"SubOrderStatus": "PENDING",
"SupportedInstanceFamily": [],
"SupportedStorageType": [],
"SupportedUplinkSpeed": [
10,
25,
40,
100
],
"TotalCpu": 0,
"TotalGpu": 0,
"TotalMem": 0,
"TypeFamily": "CUSTOM",
"TypeName": "BASE_EQUIPMENT.BASE_FOUNDATION",
"Weight": 0
}
],
"DedicatedClusterTypeId": "None",
"DeliverExpectTime": "0000-00-00 00:00:00",
"DeliverFinishTime": "0000-00-00 00:00:00",
"Gpu": 0,
"Mem": 0,
"OrderPayPlan": null,
"OrderSLA": null,
"OrderStatus": "PENDING",
"OrderType": "PUSH",
"PayStatus": 0,
"PayType": "ONEOFF",
"PowerDraw": 0,
"SupportedInstanceFamily": [
"None"
],
"SupportedStorageType": [
"None"
],
"SupportedUplinkSpeed": [
-1
],
"TimeSpan": 3,
"TimeUnit": "YEAR",
"Weight": 0
}
],
"RequestId": "3da146fc-0136-4386-b632-9dbef7f06431",
"TotalCount": 30
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidAppIdFormat | 无效的AppId |
