DescribeClusters

Last updated: 2025-11-25 10:54:14

DescribeClusters

Last updated: 2025-11-25 10:54:14

1. API Description

Domain name for API request: tdmq.intl.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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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	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.
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.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	The number of clusters.
ClusterSet	Array of Cluster	Cluster information list
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.

4. Example

Example1 Obtain Cluster List

Input Example

https://tdmq.intl.tencentcloudapi.com/?Action=DescribeClusters
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "ClusterSet": [
            {
                "MaxQps": 10000,
                "HealthyInfo": "ok",
                "MaxTopicNum": 1000,
                "MaxStorageCapacity": 100,
                "MaxMessageDelayInSeconds": 0,
                "Version": "v1",
                "Status": 1,
                "Tags": [
                    {
                        "TagKey": "tag1",
                        "TagValue": "value1"
                    }
                ],
                "ClusterId": "pulsar-xk3ne8k2qkp8",
                "PayMode": 0,
                "EndPointNum": 0,
                "Healthy": 1,
                "TopicNum": 0,
                "Remark": "beizhu",
                "NamespaceNum": 0,
                "PublicEndPoint": "http://mq.public.endpoint",
                "MaxPublishRateInBytes": 0,
                "VpcEndPoint": "http://mq.tencent.vpc.end.point",
                "MaxDispatchRateInBytes": 0,
                "PublicAccessEnabled": true,
                "ClusterName": "mq-cluster",
                "MaxPublishRateInMessages": 0,
                "UsedStorageBudget": 0,
                "MessageRetentionTime": 86400,
                "MaxNamespaceNum": 10,
                "CreateTime": "2024-10-08 11:38:48,068",
                "MaxDispatchRateInMessages": 0
            }
        ],
        "RequestId": "4446732a-8d0a-4549-9fb3-79949a788fc0"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.CloudService	Third-Party cloud service exception. try again later.
FailedOperation.OperateLater	Task in progress. please try again later.
ResourceNotFound.Cluster	The cluster does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud