1. 接口描述
接口请求域名： tdcpg.tencentcloudapi.com 。
查询集群
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| PageNumber | 否 | Integer | 页码，取值范围为[1,INF)，默认值为1 示例值：1 |
| PageSize | 否 | Integer | 每页条数，取值范围为默认为[1,100]，默认值为20 示例值：10 |
| Filters.N | 否 | Array of Filter | 目前支持查询条件包括： - ClusterId : 集群ID - ClusterName : 集群名 - ProjectId : 项目ID - Status : 集群状态 - PayMode : 付费模式 |
| OrderBy | 否 | String | 排序字段，可选字段： - CreateTime : 集群创建时间(默认值) - PayPeriodEndTime : 集群过期时间 示例值：CLUSTER_CREATE_TIME |
| OrderByType | 否 | String | 排序方式，可选字段： - DESC : 降序(默认值) - ASC : 升序 示例值：DESC |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总条数 示例值：100 |
| ClusterSet | Array of Cluster | 集群列表信息 示例值：[] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群
输入示例
POST / HTTP/1.1
Host: tdcpg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusters
<公共请求参数>
{
"OrderBy": "CreateTime",
"OrderByType": "DESC",
"PageNumber": 1,
"Filters": [
{
"Values": [
"tdcpg-77iesdqa"
],
"Name": "ClusterId",
"ExactMatch": true
}
],
"PageSize": 10
}输出示例
{
"Response": {
"ClusterSet": [
{
"AutoRenewFlag": 0,
"ClusterId": "tdcpg-77iesdqa",
"ClusterName": "tdcpg-77iesdqa",
"CreateTime": "2021-12-08T19:50:55+08:00",
"DBCharset": "UTF8",
"DBMajorVersion": "10",
"DBVersion": "10.17",
"DBKernelVersion": "v10.17_r1.4",
"EndpointSet": [
{
"ClusterId": "tdcpg-77iesdqa",
"EndpointId": "tdcpg-ep-6c6xs52r",
"EndpointName": "tdcpg-ep-6c6xs52r",
"EndpointType": "RW",
"PrivateIp": "10.0.64.20",
"PrivatePort": 5432,
"SubnetId": "subnet-5wnhtsmw",
"VpcId": "vpc-l0ee2prd",
"WanDomain": "",
"WanIp": "",
"WanPort": 0
},
{
"ClusterId": "tdcpg-77iesdqa",
"EndpointId": "tdcpg-ep-ffscxj6f",
"EndpointName": "tdcpg-ep-ffscxj6f",
"EndpointType": "RO",
"PrivateIp": "10.0.64.24",
"PrivatePort": 5432,
"SubnetId": "subnet-5wnhtsmw",
"VpcId": "vpc-l0ee2prd",
"WanDomain": "",
"WanIp": "",
"WanPort": 0
}
],
"InstanceCount": 2,
"PayMode": "PREPAID",
"PayPeriodEndTime": "2022-01-08T19:50:54+08:00",
"ProjectId": 0,
"Region": "ap-guangzhou",
"Status": "running",
"StatusDesc": "运行中",
"StorageLimit": 2048,
"StorageUsed": 0.14,
"Zone": "ap-guangzhou-3"
}
],
"RequestId": "c644d6ec-0743-4ba3-916a-e30c5a00ada1",
"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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.DatabaseAccessError | 元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidParameterValueError | 传入的参数非法。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.PermissionDenied | 未经授权的操作。 |