1. 接口描述
接口请求域名： cdc.tencentcloudapi.com 。
查询专用集群列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDedicatedClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-14。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DedicatedClusterIds.N | 否 | Array of String | 按照一个或者多个实例ID查询。实例ID形如：cluster-xxxxxxxx示例值：["cluster-du3hdu"] |
| Zones.N | 否 | Array of String | 按照可用区名称过滤 示例值：ap-guangzhou |
| SiteIds.N | 否 | Array of String | 按照站点id过滤 示例值：site-378xs3g |
| LifecycleStatuses.N | 否 | Array of String | 按照专用集群生命周期过滤 示例值：Pending |
| Name | 否 | String | 模糊匹配专用集群名称 示例值：my-cluster |
| Offset | 否 | Integer | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DedicatedClusterSet | Array of DedicatedCluster | 符合查询条件的专用集群列表 示例值：[{ "DedicatedClusterId": "cluster-e88qh1ue", "Zone": "ap-guangzhou-2", "Description": "this is a description", "Name": "wechen-first-dc", "LifecycleStatus": "PENDING", "CreateTime": "2020-12-10T06:15:43Z", "SiteId": "site-38d9ck" }] |
| 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: DescribeDedicatedClusters
<公共请求参数>
{}输出示例
{
"Response": {
"DedicatedClusterSet": [
{
"DedicatedClusterId": "cluster-e88qh1ue",
"Zone": "ap-guangzhou-2",
"Description": "this is a description",
"Name": "wechen-first-dc",
"LifecycleStatus": "PENDING",
"CreateTime": "2020-12-10T06:15:43Z",
"SiteId": "site-38d9ck"
},
{
"DedicatedClusterId": "cluster-1hza0fbu",
"Zone": "ap-guangzhou-2",
"Description": "this is a description",
"Name": "wechen-first-dc",
"LifecycleStatus": "PENDING",
"CreateTime": "2020-12-10T06:15:50Z",
"SiteId": "site-38d9ck"
},
{
"DedicatedClusterId": "cluster-ptrfvhyw",
"Zone": "ap-guangzhou-2",
"Description": "this is a description",
"Name": "wechen-first-dc",
"LifecycleStatus": "PENDING",
"CreateTime": "2020-12-10T06:17:26Z",
"SiteId": "site-38d9ck"
}
],
"TotalCount": 3,
"RequestId": "92b47775-2f39-4ad0-b5dd-0a93a8f12636"
}
}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 |
| InvalidParameterValue.LimitExceeded | 超出大小限制。 |
