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