获取Topic列表信息
更新时间 2025-11-26 15:24:15
最近更新时间: 2025-11-26 15:24:15
接口功能介绍
获取Topic列表信息
接口约束
无
URI
GET /v3/topic/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| topicName | 否 | String | topic名字 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 100054c0416811e9a6690242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功:800,失败:900 | ||
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码,只有非成功才有这个字段,方便快速定位问题 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| rows | Array of Objects | 主题信息列表 | rows | |
| total | Integer | 主题总数量 | 2 | |
| 表 rows |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| topicName | String | 主题名称 | topic001 | |
| readQueueNums | Integer | 读队列数量 | 4 | |
| writeQueueNums | Integer | 写队列数量 | 4 | |
| perm | Integer | 读写权限 2 | 6 | |
| topicFilterType | String | 主题过滤标志 | ||
| topicSysFlag | Integer | 主题系统标识 | ||
| 0 - 表示非系统主题 | ||||
| 1 - 系统内部主题 | 0 | |||
| order | Boolean | 是否为顺序消息 | false | |
| remark | String | 备注 | ||
| clusterName | String | 集群名 | ||
| brokerName | String | 集群名称 | ||
| brokerId | String | 代理id | 0 | |
| messageType | String | 消息类型 | ||
| NORMAL-普通消息 | NORMAL |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/topic/list?prodInstId=70687660456281088
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"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": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码