Domain name for API request: tdmq.tencentcloudapi.com.
This API is used to get the list of clusters.
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: 2020-02-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
Offset | No | Integer | Start offset, which defaults to 0 if left empty. |
Limit | No | Integer | The number of results to be returned, which defaults to 10 if left empty. The maximum value is 20. |
ClusterIdList.N | No | Array of String | Filter by cluster ID. |
IsTagFilter | No | Boolean | Whether to filter by tag. |
Filters.N | No | Array of Filter | Filter. Currently, you can filter by tag. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The number of clusters. |
ClusterSet | Array of Cluster | Cluster information list |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tdmq.tencentcloudapi.com/?Action=DescribeClusters
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"ClusterSet": [
{
"MaxQps": 10000,
"HealthyInfo": "xx",
"MaxTopicNum": 1000,
"MaxStorageCapacity": 100,
"MaxMessageDelayInSeconds": 0,
"Version": "xx",
"Status": 1,
"Tags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"ClusterId": "xx",
"PayMode": 0,
"EndPointNum": 0,
"Healthy": 1,
"TopicNum": 0,
"Remark": "xx",
"NamespaceNum": 0,
"PublicEndPoint": "xx",
"MaxPublishRateInBytes": 0,
"VpcEndPoint": "xx",
"MaxDispatchRateInBytes": 0,
"PublicAccessEnabled": true,
"ClusterName": "xx",
"MaxPublishRateInMessages": 0,
"UsedStorageBudget": 0,
"MessageRetentionTime": 86400,
"MaxNamespaceNum": 10,
"CreateTime": "xx",
"MaxDispatchRateInMessages": 0
}
],
"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 |
---|---|
ResourceNotFound.Cluster | The cluster does not exist. |
Was this page helpful?