接口介绍
根据消息key查询消息信息。
接口约束
无。
URl
GET https://[endpoint]/v2/message/queryByKey
请求参数
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
prodInstId | 是 | url | String | 实例ID |
topicName | 是 | url | String | 主题名字 |
key | 是 | url | String | 用于查询的消息KEY值 |
响应参数
响应参数 | 参数类型 | 描述 |
statusCode | String | 接口系统层面状态码。成功：800，失败：900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
返回值returnObj参数说明
响应参数 | 参数类型 | 描述 |
total | Int | 总数 |
rows | List | 消息列表 |
返回值rows参数说明
响应参数 | 参数类型 | 描述 |
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> | KEYS:消息key UNIQ_KEY：消息唯一key |
messageBody | String | 消息体 |
status | String | 消费状态： TO_CONSUME 未消费 CONSUMING 消费中 CONSUMED 已消费 |
请求示例
GET https://[endpoint]/v2/message/ queryByKey?key=test_key&prodInstId=70687660456281088&groupName=group
响应成功示例
{
"returnObj":{
"total":1,
"rows":[
{
"queueId":3,
"storeSize":485,
"queueOffset":7,
"sysFlag":0,
"bornTimestamp":1661857434591,
"bornHost":"192.168.71.1:55492",
"storeTimestamp":1661857434599,
"storeHost":"192.168.71.188:8422",
"msgId":"C0A847BC000020E600000000000045FE",
"commitLogOffset":17918,
"bodyCRC":979262990,
"reconsumeTimes":0,
"preparedTransactionOffset":0,
"topic":"test",
"properties":{
"KEYS":"test_key",
"UNIQ_KEY":"050562443C7018B4AAC2996FB3DE0000"
},
"messageBody":"D8SQN8VlDr1ZD4r4KVtse9Zczg5A9FA2nT7vu7LwLZ2w6oQnnXSmARpRJgHA8VJ6akEtHcm470kilKhE4pGgTKoXf5fF0kpzLc3ek01dafpJsdyZgFjmk18RtqPdk68LVNZ6p5FuE0c8qMxDBZzMv462KdJtJC1FBbbeuKoBVtHb7wYf79uY4uKKZOE9l1dkLaV0dS4gQSCCQVcRNswNNRbcVZGFP2iYcsxAqkeTENxqhUOEvQm4kIAbbWl4cK9gOMpUnchJSpEd48gv9gcHHB5FGY0umLtbcUGDM3aR8mfjDEeWAjm8g4o3dl7ptwakDKVIDDTe",
"status":null
}
]
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}