Domain name for API request: cynosdb.tencentcloudapi.com.
This API is used to the list of clusters.
A maximum of 1000 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: 2019-01-07. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
DbType | No | String | Engine type. Currently, MYSQL is supported. |
Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100 |
Offset | No | Integer | Record offset. Default value: 0 |
OrderBy | No | String | Sort by field. Valid values: |
OrderByType | No | String | Sorting order. Valid values: |
Filters.N | No | Array of QueryFilter | Filter. If more than one filter exists, the logical relationship between these filters is AND . |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of clusters |
ClusterSet | Array of CynosdbCluster | Cluster list |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusters
<Common request parameters>
{
"DbType": "MYSQL",
"Limit": "20",
"Filters": [
{
"Values": [
"cynosdbpg-ins-bzkxxrmt"
],
"Names": [
"InstanceId"
],
"ExactMatch": "true"
}
],
"Offset": "0"
}
{
"Response": {
"TotalCount": 597,
"ClusterSet": [
{
"ServerlessStatus": "xx",
"RenewFlag": 0,
"Zone": "xx",
"InstanceNum": 1,
"ClusterId": "xx",
"DbVersion": "xx",
"Storage": 0,
"StorageId": "xx",
"ProcessingTask": "xx",
"Status": "xx",
"PhysicalZone": "xx",
"UpdateTime": "xx",
"VpcId": "xx",
"Ability": [
{
"NonsupportSlaveZoneReason": "xx",
"IsSupportSlaveZone": "xx",
"IsSupportRo": "xx",
"NonsupportRoReason": "xx"
}
],
"StorageLimit": 30000,
"SlaveZones": [
"xx"
],
"DbMode": "xx",
"SubnetId": "xx",
"MinStorageSize": 10,
"MaxStorageSize": 30000,
"IsFreeze": "xx",
"Region": "xx",
"MasterZone": "xx",
"PayMode": 1,
"PeriodEndTime": "xx",
"ResourceTags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"CynosVersion": "xx",
"StatusDesc": "xx",
"StoragePayMode": 0,
"BusinessType": "xx",
"Tasks": [
{
"ObjectType": "xx",
"TaskStatus": "xx",
"ObjectId": "xx",
"TaskId": 0,
"TaskType": "xx"
}
],
"HasSlaveZone": "xx",
"ClusterName": "xx",
"ProjectID": 0,
"Uin": "xx",
"DbType": "xx",
"Vip": "xx",
"AppId": 251007582,
"OrderSource": "xx",
"Vport": 3306,
"CreateTime": "xx",
"NetAddrs": [
{
"WanStatus": "xx",
"Description": "xx",
"UniqVpcId": "xx",
"WanDomain": "xx",
"WanPort": 0,
"Vip": "xx",
"UniqSubnetId": "xx",
"NetType": "xx",
"WanIP": "xx",
"Vport": 3306
},
{
"WanStatus": "xx",
"Description": "xx",
"UniqVpcId": "xx",
"WanDomain": "xx",
"WanPort": 0,
"Vip": "xx",
"UniqSubnetId": "xx",
"NetType": "xx",
"WanIP": "xx",
"Vport": 3306
}
]
}
],
"RequestId": "xx"
}
}
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.CamCheckResourceError | Failed to get permissions. Please try again later. If the problem persists, please contact customer service. |
FailedOperation.DatabaseAccessError | Failed to access the database. Please try again later. If the problem persists, please contact customer service. |
InternalError.DbOperationFailed | Failed to query the database. |
InternalError.InternalHttpServerError | An exception occurred while executing the HTTP request. |
InternalError.SystemError | Internal system error. |
InternalError.UnknownError | Unknown internal error. |
InvalidParameterValue.IllegalOrderBy | Invalid sort by field. |
InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
InvalidParameterValue.ParamBothSetError | These two parameters cannot be set at the same time. |
UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?