调用 DescribeTopicQueue 接口获取 Topic 的队列信息。
请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。
此接口用于查看指定 Topic 的队列数量、最小偏移量、最大偏移量、消息更新时间等信息。
参数 | 参数类型 | 是否必选 | 示例值 | 说明 |
|---|---|---|---|---|
InstanceId | String | 是 | rocketmq-cnai1f0c29ca**** | 实例 ID。 |
PageNumber | Integer | 是 | 1 | 列表的页码，最小值为 1。 |
PageSize | Integer | 是 | 10 | 列表中每一页的条目数量，取值范围为 1~100。 |
TopicName | String | 是 | newtopic | Topic 名称，设置此参数表示根据指定的 Topic 名称进行筛选，支持模糊匹配。 |
QueueIds | Array of String | 否 | [rocketmq-cnai1f0c29ca****-broker-0-3,rocketmq-cnai1f0c29ca****-broker-0-4] | 队列 ID，若未指定，表示查看所有队列信息。 |
参数 | 参数类型 | 示例值 | 说明 |
|---|---|---|---|
Total | Integer | 2 | 符合查询条件的队列总数。 |
QueuesInfo | Array of BasicQueueInfo | / | 符合查询条件的队列列表。详细信息请参考【BasicQueueInfo】。 |
POST /?Action=DescribeTopicQueue&Version=2023-01-01 HTTP/1.1 Content-Type: application/json Host: rocketmq.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=******** { "InstanceId": "rocketmq-cnai1f0c29ca****", "TopicName": "rocketmq123", "PageSize": 10, "PageNumber": 1, "QueueIds": ["rocketmq-cnai1f0c29ca****-broker-0-0","rocketmq-cnai1f0c29ca****-broker-0-1"] }
{ "ResponseMetadata": { "RequestId": "2023050819513665E9F4E9FEA5154976C4", "Action": "DescribeTopicQueue", "Version": "2023-01-01", "Service": "RocketMQ", "Region": "cn-shanghai" }, "Result": { "QueuesInfo": [ { "EndOffset": 1133024483, "LastUpdateTimestamp": "2023-01-09T06:30:18Z", "MessageCount": 95492440, "QueueId": "rocketmq-cnai1f0c29ca****-broker-0-0", "StartOffset": 1037532043 }, { "EndOffset": 300284751, "LastUpdateTimestamp": "2023-01-09T06:30:18Z", "MessageCount": 592318, "QueueId": "rocketmq-cnai1f0c29ca****-broker-0-1", "StartOffset": 299692433 } ], "Total": 2 } }