You need to enable JavaScript to run this app.
导航

DescribeTopics

最近更新时间2023.07.12 16:22:34

首次发布时间2023.07.12 16:22:34

调用 DescribeTopics 接口查看 Topic 列表。

使用说明

此接口用于查看指定实例的 Topic 列表,也可以用于查看某个 Topic 的基础信息。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

rocketmq-cnai1f0c29ca****

实例 ID。

PageNumber

Integer

1

列表的页码,最小值为 1。

PageSize

Integer

10

列表中每一页的条目数量,取值范围为 1~100。

TopicName

String

testtopic

Topic 名称,设置此参数表示根据指定的 Topic 名称进行筛选,支持模糊匹配。

SortBy

String

Status

实例查询结果排序字段。默认使用 CreateTime 进行排序。可设置为:

  • CreateTime:Topic 创建时间
  • QueueNumber:Topic 队列数量

SortOrder

String

Desc

实例查询使用的排序方式。默认为 Desc,即降序。

  • Asc:升序
  • Desc:降序。

MessageType

Integer

0

消息类型。设置此参数表示根据指定的消息类型筛选 Topic 列表。取值说明如下:

  • 0:普通消息
  • 1:事务消息
  • 2:分区顺序消息
  • 3:全局顺序消息
  • 4:延时消息

响应参数

参数

参数类型

示例值

说明

InstanceId

String

rocketmq-cnai1f0c29ca****

实例 ID。

TopicsInfo

Array of BasicTopicInfoObject

/

符合查询条件的Topic列表。详细信息请参考 BasicTopicInfoObject

Total

Integer

1

符合查询条件的 Topic 总数。

示例

请求示例

POST /?Action=DescribeTopics&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
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230508194531B669F5B5E629024918EB",
        "Action": "DescribeTopics",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "InstanceId": "rocketmq-cnai1f0c29ca****",
        "TopicsInfo": [
            {
                "CreateTime": "2023-01-09T06:30:18Z",
                "Description": "test",
                "MessageType": 0,
                "QueueNumber": 10,
                "TopicName": "rocketmq123"
            }
        ],
        "Total": 1
    }
}