1. 接口描述
接口请求域名: cdc.api3.fincloud.tencent.cn。
查询专用集群订单列表
默认接口请求频率限制:10次/秒。
接口更新时间:2023-08-28 15:50:59。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeDedicatedClusterOrders |
| Version | 是 | 否 | String | 公共参数,本接口取值:2020-12-14 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| DedicatedClusterIds | 否 | 否 | Array of String | 专用集群id 示例值: ["cluster-xh37dh"] |
| DedicatedClusterOrderIds | 否 | 否 | String | 按照专用集群订单id过滤 示例值: ["ord-xjehslf"] |
| Offset | 否 | 否 | Int64 | 偏移量,默认为0 示例值: 0 |
| Limit | 否 | 否 | Int64 | 返回数量,默认为20,最大值为100 示例值: 20 |
| Status | 否 | 否 | String | 订单状态为过滤条件:PENDING INCONSTRUCTION DELIVERING DELIVERED EXPIRED CANCELLED OFFLINE 示例值: DELIVERED |
| ActionType | 否 | 否 | String | 订单类型为过滤条件:CREATE EXTEND 示例值: CREATE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DedicatedClusterOrderSet | Array of DedicatedClusterOrder | 专用集群订单列表 示例值:查看 |
| TotalCount | Int64 | 符合条件的专用集群订单总数 示例值: 20 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidAppIdFormat | ccdb返回结果不为0 |
| InvalidParameterValue.LimitExceeded | 超出大小限制。 |
| ResourceNotFound.InvalidDedicatedClusterId | 该资源没有找到。 |
5. 示例
该接口暂无示例。