产品动态
公告
Domain name for API request: ctsdb.intl.tencentcloudapi.com.
This API is used to query the instance list and details.
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: DescribeClusters. |
| Version | Yes | String | Common Params. The value used for this API: 2023-02-02. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| PageNumber | Yes | Integer | Current page number. |
| PageSize | Yes | Integer | Page size. |
| Filters.N | No | Array of Filter | Query parameter: Filtering and querying by instance ID (cluster_id) and instance name (name) are supported. |
| Orders.N | No | Array of Order | Sorting parameter: Sorting by the creation time field (created_at) is supported. The value of Type can be set to DESC (descending order) or ASC (ascending order). |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of records under current conditions. Note: This field may return null, indicating that no valid values can be obtained. |
| Clusters | Array of Cluster | List of instances meeting the conditions. Note: This field may return null, indicating that no valid values can be obtained. |
| 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 the instance list.
POST / HTTP/1.1
Host: ctsdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusters
<Common request parameters>
{
"PageNumber": 1,
"PageSize": 10,
"Filters": [
{
"Name": "cluster_id",
"Op": "=",
"Values": [
"ctsdbi-xxxxxxx"
]
}
],
"Orders": [
{
"Name": "created_at",
"Type": "DESC"
}
]
}{
"Response": {
"TotalCount": 1,
"Clusters": [
{
"AppID": 123456789,
"ClusterID": "ctsdbi-xxxxxxx",
"AccountID": "xxxxxx==",
"Name": "Test instance",
"Region": "guangzhou",
"Zones": "guangzhou-3",
"Networks": [
{
"VIP": "10.0.0.x",
"Port": 8086,
"VpcId": "332211",
"SubnetId": "55321"
}
],
"Spec": {
"RequestUnit": 1,
"PayMode": 1,
"CpuLimit": 1,
"MemoryLimit": 4,
"DiskLimit": 100,
"Shards": 3,
"Replicas": 1
},
"Status": 1,
"Period": {
"StartTime": "2020-09-22T00:00:00+00:00",
"EndTime": "2020-09-22T00:00:00+00:00"
},
"CreatedAt": "2020-09-22T00:00:00+00:00",
"UpdatedAt": "2020-09-22T00:00:00+00:00",
"Tenant": {},
"Tags": [
{
"Key": "test",
"Value": "Example"
}
],
"Security": [
"test"
]
}
],
"RequestId": "requestxxxxxxxxxx"
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
文档反馈