根据msgId查询消息消息轨迹
更新时间 2025-11-18 17:46:22
最近更新时间: 2025-11-18 17:46:22
接口功能介绍
根据msgId查询消息消息轨迹
接口约束
无
URI
GET /v3/message/getTrace
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| msgId | 是 | String | 消息ID |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 100054c0416811e9a6690242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | ||
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象。此参数所包含的参数请见“响应示例'里面的注释 | returnObj | |
| error | String | 错误码，只有非成功才有这个字段，方便快速定位问题 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 消息生产消费轨迹数据对象 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| topic | String | 消息主题名 | topicTest | |
| tags | String | 标签 | ||
| keys | String | 消息索引值 | ||
| groupName | String | 生产者名 | ||
| msgType | String | 消息类型 | ||
| msgId | String | 消息id | ||
| costTime | String | 耗时 | ||
| status | String | 发送状态 | SEND_SUCCESS | |
| pubTime | String | 发送时间戳 | ||
| arrivedServerTime | String | 消息到达服务端时间戳 | ||
| clientHost | String | 客户端主机地址 | ||
| subTraceList | Array of Objects | 消息堆积列表 | subTrace | |
| 表 subTrace |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| groupName | String | 消费组名 | ||
| traceLogList | Array of Objects | 消费轨迹日志列表 | traceLog | |
| 表 traceLog |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| msgId | String | 消息id | ||
| clientHost | String | 客户端主机地址 | ||
| costTime | String | 消费耗时（毫秒） | ||
| subTime | String | 消费时间戳 | ||
| status | String | 消费状态 CONSUME_SUCCESS-消费成功;RECONSUME_LATER - 稍后重试 | CONSUME_SUCCESS |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/message/getTrace?prodInstId=70687660456281088&msgId=xxx
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"returnObj":{
{
"message": "success",
"data": {
"topic": "TopicTest1234",
"keys": "OrderID188",
"tags": "TagA",
"groupName": "ProducerGroupName",
"msgType": "NORMAL",
"msgId": "C0A8016400002AA00000000000000000",
"costTime": 51,
"status": "SEND_SUCCESS",
"pubTime": 1693231023742,
"arrivedServerTime": 0,
"clientHost": "192.168.1.100",
"subTraceList": [
{
"groupName": "CID_JODIE_1",
"traceLogList": [
{
"msgId": "C0A8016400002AA00000000000000000",
"clientHost": "192.168.1.100",
"costTime": 4,
"subTime": 1693232037955,
"status": "CONSUME_SUCCESS"
}
]
}
]
}
"statusCode": 800
}
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码
