根据MessageKey查询消息
更新时间 2025-11-27 16:49:32
最近更新时间: 2025-11-27 16:49:32
接口功能介绍
根据MessageKey查询消息
接口约束
无
URI
GET /v3/message/queryByKey
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| topicName | 是 | String | 主题名字 | ||
| key | 是 | String | 用于查询的消息KEY值 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 200000002368 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | ||
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码，只有非成功才有这个字段，方便快速定位问题 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总记录数。 | 1 | |
| rows | Array of Objects | 消息详情列表。 | rows | |
| 表 rows |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| queueId | Integer | 队列ID。 | 3 | |
| storeSize | Integer | 存储大小。 | 485 | |
| queueOffset | Integer | 队列偏移量。 | 7 | |
| sysFlag | Integer | 系统标记。 | 0 | |
| bornTimestamp | Long | 消息生成时间戳。 | 1661857434591 | |
| bornHost | String | 消息生成主机地址。 | 192.168.71.1:55492 | |
| storeTimestamp | Long | 消息存储时间戳。 | 1661857434599 | |
| storeHost | String | 消息存储主机地址。 | 192.168.71.188:8422 | |
| msgId | String | 消息ID。 | C0A847BC000020E600000000000045FE | |
| commitLogOffset | Long | 提交日志偏移量。 | 17918 | |
| bodyCRC | Integer | 消息体CRC校验值。 | 979262990 | |
| reconsumeTimes | Integer | 重试次数。 | 0 | |
| preparedTransactionOffset | Long | 预处理事务偏移量。 | 0 | |
| topic | String | 主题名称。 | test | |
| properties | Map of String | 消息属性。 | properties | |
| messageBody | String | 消息体内容。 | ||
| status | String | 消息状态。 | null |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/message/queryByKey?key=test_key&prodInstId=70687660456281088&groupName=group
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"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": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码
