Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to query an exclusive cluster.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDedicatedClusters. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| Filters.N | No | Array of Filter | Query using one or more filter criteria. filter criteria currently supported include:. dedicated-cluster-id: filters by dedicated cluster id. string type. |
| Parameter Name | Type | Description |
|---|---|---|
| DedicatedClusterSet | Array of DedicatedCluster | Exclusive cluster information. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query all dedicated clusters.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDedicatedClusters
<Common request parameters>
{}
{
"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"
}
}
This example shows you how to query the exclusive cluster cluster-0jend45y.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDedicatedClusters
<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.DatabaseAffectedError | Data operation failed. Please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| FailedOperation.ServiceAccessError | Failed to access internal service. Please try again later. If the problem persists, please contact customer service. |
| InternalError.JsonParseError | Json data parsing failed. contact our customer service for assistance. |
| InvalidParameter.ParameterCheckError | Failed to check the parameter. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback