接口介绍
通过消息ID查询消息信息。
接口约束
无。
URl
GET https://[endpoint].ctapi.ctyun.cn/v2/message/queryByMsgId
请求参数
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
msgId | 是 | url | String | 消息ID |
prodInstId | 是 | url | String | 实例ID |
groupName | 是 | url | String | 订阅组名字 |
响应参数
响应参数 | 参数类型 | 描述 |
---|---|---|
statusCode | String | 接口系统层面状态码。成功:800,失败:900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
返回值data参数说明
响应参数 | 参数类型 | 描述 |
---|---|---|
queueId | Int | 队列ID |
storeSize | Int | 消息大小 |
queueOffset | Long | 队列偏移量 |
sysFlag | Int | 系统标识 |
bornTimestamp | Long | 产生时间戳(毫秒) |
bornHost | String | 产生主机 |
storeTimestamp | Long | 存储时间戳(毫秒) |
msgId | String | 消息ID |
commitLogOffset | Long | 物理偏移量 |
bodyCRC | Int | 包体CRC |
reconsumeTimes | Int | 重试次数 |
preparedTransactionOffset | Long | 事务偏移量 |
properties | Map<String, String> | UNIQ_KEY:消息唯一key |
messageBody | String | 消息体 |
status | String | 消费状态:TO_CONSUME 未消费CONSUMING消费中CONSUMED已消费 |
请求示例
GET https://[endpoint].ctapi.ctyun.cn/v2/message/queryByMsgId?msgId=C0A847BC000020E600000000000045FE&prodInstId=70687660456281088&groupName=group
响应成功示例
{
"returnObj":{
"data":{
"queueId":3,
"storeSize":499,
"queueOffset":6,
"sysFlag":0,
"bornTimestamp":1661852864101,
"bornHost":"192.168.71.1:62644",
"storeTimestamp":1661852864113,
"storeHost":"192.168.71.188:8422",
"msgId":"C0A847BC000020E60000000000003FEE",
"commitLogOffset":16366,
"bodyCRC":1507589040,
"reconsumeTimes":0,
"preparedTransactionOffset":0,
"topic":"test",
"properties":{
"UNIQ_KEY":"050562442CE418B4AAC29929F6640000"
},
"messageBody":"9Y2nOMMHZQL3RpBO5MlRV3tJDQimX6Ee4pvcxQHeRbMWWrrOU1kkG0vknO8QfobqQTUxMO6oRNZKEzAqfTJ6ohYBQgeKVFMenNXpeqTBcbzEOFUi673TTphZjJ8WSftmvyKT0oH0j3LTQYcpVwYlC8iz0SpJh0KSeAnPJ3RMa6vH9qmGgveoGRm8cq4dl19rqYciBnvxaKCNi684ff8u4CrwDqrjlgW3tFRnZkRj5pIC8SjS26npRSXLKcQUHRPvGMHqlXTkY45WOUOJABhLI31pzJersz6tnOjGmQ0GNQb6VNNKTzqk2SbH3P6LKL7bJwdGs5bw1j43s2m5U9PZCiA0asasFF",
"status":"TO_CONSUME"
}
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}