查看Topic的订阅信息
更新时间 2025-11-26 16:27:22
最近更新时间: 2025-11-26 16:27:22
接口功能介绍
查看Topic的订阅信息
接口约束
无
URI
GET /v3/topic/subDetail
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| topicName | 是 | String | topic名字 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 200000002368 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功:800,失败:900 | 800 | |
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象。 | returnObj | |
| error | String | 错误码,只有非成功才有这个字段,方便快速定位问题 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 主题订阅信息 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| subscriptionDataList | Array of Objects | 订阅数据列表 | subscriptionData | |
| topic | String | 主题名称 | test | |
| prodInstId | String | 实例id | mq_test | |
| 表 subscriptionData |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| consumerGroup | String | 消费者组 | group | |
| subString | String | 订阅表达式 | * |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/topic/subDetail?prodInstId=70687660456281088&topicName=test
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"returnObj":{
"data":{
"subscriptionDataList":[
{
"consumerGroup":"group",
"subString":"*"
}
],
"topic":"test",
"prodInstId":"mq_test"
}
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码