1. 接口描述
接口请求域名： postgres.tencentcloudapi.com 。
查询专属集群
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDedicatedClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 按照一个或者多个过滤条件进行查询，目前支持的过滤条件有： dedicated-cluster-id: 按照专属集群ID筛选，类型为string 示例值：[{"Values": ["dedicatedCluster-gz" ], "Name": "dedicated-cluster-id" } ] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DedicatedClusterSet | Array of DedicatedCluster | 专属集群信息 示例值：[{"DedicatedClusterId":"dedicatedCluster-gz","name":"TestDedicatedClusterName","Zone":"ap-guangzhou","StandbyDedicatedClusterSet":["dedicatedCluster-sh"],InstanceCount:1,CpuTotal:10,CpuAvailable:10,MemTotal:10,MemAvailable:10,DiskTotal:10,DiskAvailable:10}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询所有专属集群
查询所有专属集群
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDedicatedClusters
<公共请求参数>
{}输出示例
{
"Response": {
"DedicatedClusterSet": [
{
"CpuAvailable": 192,
"CpuTotal": 192,
"DedicatedClusterId": "cluster-0jend45y",
"DiskAvailable": 1000,
"DiskTotal": 1000,
"InstanceCount": 0,
"MemAvailable": 512,
"MemTotal": 512,
"Name": "",
"StandbyDedicatedClusterSet": [
"[\"cluster-0jend45y\"",
"\"cluster-d8htgb6k\"]"
],
"Zone": "ap-guangzhou-2"
},
{
"CpuAvailable": 192,
"CpuTotal": 192,
"DedicatedClusterId": "cluster-d8htgb6k",
"DiskAvailable": 1000,
"DiskTotal": 1000,
"InstanceCount": 0,
"MemAvailable": 512,
"MemTotal": 512,
"Name": "",
"StandbyDedicatedClusterSet": [
"[\"cluster-0jend45y\"",
"\"cluster-d8htgb6k\"]"
],
"Zone": "ap-guangzhou-2"
}
],
"RequestId": "187a6206-4811-447d-b223-87a8dd470c8c"
}
}示例2 查询特定专属集群
查询专属集群cluster-0jend45y
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDedicatedClusters
<公共请求参数>
{
"Filters": [
{
"Name": "dedicated-cluster-id",
"Values": [
"cluster-0jend45y"
]
}
]
}输出示例
{
"Response": {
"DedicatedClusterSet": [
{
"CpuAvailable": 192,
"CpuTotal": 192,
"DedicatedClusterId": "cluster-0jend45y",
"DiskAvailable": 1000,
"DiskTotal": 1000,
"InstanceCount": 0,
"MemAvailable": 512,
"MemTotal": 512,
"Name": "",
"StandbyDedicatedClusterSet": [
"[\"cluster-0jend45y\"",
"\"cluster-d8htgb6k\"]"
],
"Zone": "ap-guangzhou-2"
}
],
"RequestId": "04fcd633-8e56-4c2f-9783-7c49e00647f6"
}
}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.DatabaseAffectedError | 数据操作失败，请联系客服进行处理。 |
| FailedOperation.FailedOperationError | 操作失败，请稍后重试。 |
| FailedOperation.ServiceAccessError | 访问内部服务失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InternalError.JsonParseError | Json数据解析失败，请联系客服进行处理。 |
| InvalidParameter.ParameterCheckError | 参数检查失败。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
