分布式消息服务-RocketMQ

获取Topic列表信息

2024-07-02 09:06:02

接口介绍

获取主题列表信息。

接口约束

无。

URl

GET       https://[endpoint]/v2/topic/list

请求参数

请求参数

是否必填

位置

参数类型

说明

prodInstId

url

String

实例ID

topicName

url

String

topic名字

响应参数

响应参数

参数类型

描述

statusCode

String

接口系统层面状态码。成功:800,失败:900

message

String

描述状态

returnObj

String

返回对象。此参数所包含的参数请见“响应示例"里面的注释

返回值returnObj参数说明

响应参数

参数类型

描述

total

Integer

主题总数

rows

List

消息列表

返回值rows参数说明

响应参数

参数类型

描述

topicName

String

主题名称

readQueueNums

Integer

读队列数

writeQueueNums

Integer

写队列数

perm

Integer

权限

topicSysFlag

Integer

主题系统标识

order

Boolean

是否有序 true有序  false无序

clusterName

String

实例ID

brokerName

String

Broker名称

brokerId

Long

BrokerId

 

请求示例

GET       https://[endpoint]/v2/topic/list?prodInstId=70687660456281088

响应成功示例

{

    "returnObj":{

        "total":1,

        "rows":[

            {

                "topicName":"test",

                "readQueueNums":4,

                "writeQueueNums":4,

                "perm":6,

                "topicSysFlag":0,

                "order":false,

                "clusterName":"mq_test",

                "brokerName":"mq_test_broker_1",

                "brokerId":0

            }

        ]

    },

    "message":"success",

    "statusCode":800

}

响应失败示例

{

    "returnObj": {},

    "message": "...",

    "statusCode": "900"

}

 


77cGN.uh1qZe