通过MsgId查询消息
更新时间 2025-11-20 11:12:44
最近更新时间: 2025-11-20 11:12:44
接口功能介绍
根据msgId查询消息详情
接口约束
无
URI
GET /v3/message/queryByMsgId
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| msgId | 是 | String | 消息ID |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 100054c0416811e9a6690242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功:800,失败:"900" | 800 | |
| message | String | 描述状态 | success | |
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码,描述错误信息 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 消息详情数据对象 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| brokerName | String | Broker名称 | broker_1 | |
| queueId | Integer | 队列ID | 0 | |
| storeSize | Integer | 存储大小 | 1240 | |
| queueOffset | Integer | 队列偏移量 | 0 | |
| sysFlag | Integer | 系统标识 | 0 | |
| bornTimestamp | Long | 消息生成时间戳 | 1763433803612 | |
| bornHost | String | 消息生成主机地址及端口 | 192.168.1.138:63894 | |
| storeTimestamp | Long | 消息存储时间戳 | 1763433803618 | |
| storeHost | String | 消息存储主机地址及端口 | 192.168.1.140:9600 | |
| msgId | String | 消息唯一标识 | C0A8018C00002580000000257833D8FF | |
| commitLogOffset | Long | 提交日志偏移量 | 160930453759 | |
| bodyCRC | Integer | 消息体CRC校验值 | 183478142 | |
| reconsumeTimes | Integer | 重新消费次数 | 0 | |
| preparedTransactionOffset | Integer | 预处理事务偏移量 | 0 | |
| topic | String | 消息主题 | topicTest | |
| properties | Object | 消息属性集合 | properties | |
| messageBody | String | 消息体内容 | WebTestTools | |
| status | String | 消息状态 | TO_CONSUME | |
| messageBodyPath | String | 消息体路径 | null | |
| bodySize | Integer | 消息体大小 | 1024 | |
| 表 properties |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| KEYS | String | keys | webtest | |
| UNIQ_KEY | String | 消息唯一键 | 21000DF61BD505EF04B559D9275C0000 | |
| CLUSTER | String | 集群ID | d7ed2dbad63843f4bcb3b9dc0955a617 | |
| TAGS | String | 消息标签 | 1763433803606_0 | |
| WAIT | String | 是否等待标识 | true | |
| DELAY | String | 延迟时间 | 0 | |
| BUYER_ID | String | 买家ID | null |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/message/queryByMsgId?prodInstId=70687660456281088&msgId=xxx
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"message": "success",
"returnObj": {
"data": {
"brokerName": "broker_1",
"queueId": 0,
"storeSize": 1240,
"queueOffset": 0,
"sysFlag": 0,
"bornTimestamp": 1763433803612,
"bornHost": "192.168.1.138:63894",
"storeTimestamp": 1763433803618,
"storeHost": "192.168.1.140:9600",
"msgId": "C0A8018C00002580000000257833D8FF",
"commitLogOffset": 160930453759,
"bodyCRC": 183478142,
"reconsumeTimes": 0,
"preparedTransactionOffset": 0,
"topic": "topicTest",
"properties": {
"KEYS": "webtest",
"UNIQ_KEY": "21000DF61BD505EF04B559D9275C0000",
"CLUSTER": "d7ed2dbad63843f4bcb3b9dc0955a617",
"TAGS": "1763433803606_0",
"WAIT": "true",
"DELAY": "0",
"BUYER_ID": null
},
"messageBody": "WebTestTools",
"status": "TO_CONSUME",
"messageBodyPath": null,
"bodySize": 1024
}
},
"statusCode": 800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码