Release Notes and Announcements

Release Notes

Announcements

Product Introduction

Introduction and Selection of the TDMQ Product Series

What Is TDMQ for RocketMQ

Strengths

Scenarios

Product Series

Comparison with Open-Source RocketMQ

High Availability

Quotas and Limits

Supported Regions

Basic Concepts

Billing

Billing Overview

Pricing

Billing Examples

Pay-as-you-go Switch to Monthly Subscription (5.x)

Renewal

Viewing Consumption Details

Refund

Overdue Payments

Getting Started

Getting Started Guide

Preparations

Step 1: Creating TDMQ for RocketMQ Resources

Step 2: Using the SDK to Send and Receive Messages (Recommended)

Step 2: Running the TDMQ for RocketMQ Client (Optional)

Step 3: Querying Messages

Step 4: Deleting Resources

User Guide

Usage Process Guide

Configuring Account Permissions

Creating the Cluster

Configuring the Namespace

Configuring the Topic

Configuring the Group

Connecting to the Cluster

Managing Messages

Managing the Cluster

Viewing Monitoring Data and Configuring Alarms

Cross-Cluster Message Replication

Use Cases

Naming Conventions for Common Concepts of TDMQ for RocketMQ

RocketMQ Client Use Cases

RocketMQ Performance Load Testing and Capacity Assessment

Access over HTTP

Client Risk Descriptions and Update Guide

Migration Guide for TencentCloud API Operations Related to RocketMQ 4.x Cluster Roles

Migration Guide

Disruptive Migration

Seamless Migration

Developer Guide

Message Types

Message Filtering

Message Retries

POP Consumption Mode (5.x)

Clustering Consumption and Broadcasting Consumption

Subscription Relationship Consistency

Traffic Throttling

API Reference(5.x)

History

API Category

Making API Requests

Topic APIs

Consumer Group APIs

Message APIs

Role Authentication APIs

Hitless Migration APIs

Cloud Migration APIs

Cluster APIs

Data Types

Error Codes

API Reference(4.x)

SDK Reference

SDK Overview

5.x SDK

4.x SDK

Security and Compliance

Permission Management

CloudAudit

Deletion Protection

FAQs

4.x Instance FAQs

Agreements

TDMQ for RocketMQ Service Level Agreement

DescribeInstanceList

PDF

Mode fokus

Ukuran font

Terakhir diperbarui: 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.

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

tencent cloud

TDMQ for RocketMQ