1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
获取集群列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Offset | 否 | Integer | 起始下标，不填默认为0。 示例值：0 |
| Limit | 否 | Integer | 返回数量，不填则默认为10，最大值为20。 示例值：0 |
| ClusterIdList.N | 否 | Array of String | 集群ID列表过滤 |
| IsTagFilter | 否 | Boolean | 是否标签过滤 示例值：true |
| Filters.N | 否 | Array of Filter | 过滤器。目前支持按标签过滤。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 集群列表数量 示例值：1 |
| ClusterSet | Array of Cluster | 集群信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取集群列表
输入示例
https://tdmq.tencentcloudapi.com/?Action=DescribeClusters
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"ClusterSet": [
{
"MaxQps": 10000,
"HealthyInfo": "xx",
"MaxTopicNum": 1000,
"MaxStorageCapacity": 100,
"MaxMessageDelayInSeconds": 0,
"Version": "xx",
"Status": 1,
"Tags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"ClusterId": "xx",
"PayMode": 0,
"EndPointNum": 0,
"Healthy": 1,
"TopicNum": 0,
"Remark": "xx",
"NamespaceNum": 0,
"PublicEndPoint": "xx",
"MaxPublishRateInBytes": 0,
"VpcEndPoint": "xx",
"MaxDispatchRateInBytes": 0,
"PublicAccessEnabled": true,
"ClusterName": "xx",
"MaxPublishRateInMessages": 0,
"UsedStorageBudget": 0,
"MessageRetentionTime": 86400,
"MaxNamespaceNum": 10,
"CreateTime": "xx",
"MaxDispatchRateInMessages": 0
}
],
"RequestId": "xx"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.Cluster | 集群不存在。 |