DescribeInstanceList

最后更新时间：2026-01-13 21:52:18

DescribeInstanceList

最后更新时间： 2026-01-13 21:52:18

1. API Description

Domain name for API request: trocket.intl.tencentcloudapi.com.

This API is used to describe clusters. It only supports 5.x clusters. Description of the Filters parameter use is as follows:.

-InstanceName Cluster name, supports fuzzy search.

InstanceId The Tencent Cloud RocketMQ instance ID, obtained from the DescribeFusionInstanceList API or console.
InstanceType cluster type, see InstanceItem data structure, supports multiple selections.
-InstanceStatus cluster status, see InstanceItem data structure, supports multiple selections.

This API is used to demonstrate Filters.
[{
"Name": "InstanceId",
"Values": ["rmq-72mo3a9o"]
}]

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: DescribeInstanceList.
Version	Yes	String	Common Params. The value used for this API: 2023-03-08.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
Filters.N	No	Array of Filter	Filtering condition list. See the description of the API using this parameter for the usage method.
TagFilters.N	No	Array of TagFilter	Tag filter
Offset	No	Integer	Starting position of the query. Default value: 0.
Limit	No	Integer	Maximum number of queried results. Default value: 20.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total query count
Data	Array of InstanceItem	Instance 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 Query a Cluster List

This example shows you how to inquiry the cluster list of RocketMQ 5.X.

Input Example

POST / HTTP/1.1
Host: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceList
<Common request parameters>

{
    "Offset": 0,
    "Limit": 20
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Data": [
            {
                "ExpiryTime": 1683601674000,
                "GroupNum": 10,
                "GroupNumLimit": 500,
                "InstanceId": "rmq-72mo3a9o",
                "InstanceName": "test_instance5x",
                "InstanceStatus": "RUNNING",
                "InstanceType": "EXPERIMENT",
                "MaxMessageDelay": 48,
                "MessageRetention": 72,
                "PayMode": "POSTPAID",
"Remark": "Version 5.X test cluster"
                "ScaledTpsLimit": 0,
                "SkuCode": "experiment_500",
                "TagList": [
                    {
                        "TagKey": "test_tag_key",
                        "TagValue": "test_tag_value"
                    }
                ],
                "TopicNum": 10,
                "TopicNumLimit": 50,
                "TpsLimit": 500,
                "Version": "5.0"
            }
        ],
        "RequestId": "561a34ff-965b-4a2d-852e-973c0b2a6f01",
        "TotalCount": 1
    }
}

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

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud