接口介绍
查询指定时间段内主题的消息。
接口约束
无。
URl
GET https://[endpoint]/v2/message/queryByTime
请求参数
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
prodInstId | 是 | url | String | 实例ID |
topicName | 是 | url | String | 主题名字 |
beginTime | 是 | url | long | 开始时间的毫秒时间戳 |
endTime | 是 | url | long | 结束时间的毫秒时间戳 |
响应参数
响应参数 | 参数类型 | 描述 |
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> | MIN_OFFSET:最小偏移量 MAX_OFFSET:最大偏移量 UNIQ_KEY：消息唯一key |
messageBody | String | 消息体 |
status | String | 消费状态： TO_CONSUME 未消费 CONSUMING 消费中 CONSUMED 已消费 |
请求示例
GET https://[endpoint]/v2/message/ queryByKey? topicName=test_key&prodInstId=70687660456281088&beginTime=1652841984000group&endTime=1652842984000
响应成功示例
{
"returnObj":{
"total":1,
"rows":[
{
"queueId":0,
"storeSize":967,
"queueOffset":4,
"sysFlag":0,
"bornTimestamp":1660564149558,
"bornHost":"192.168.71.1:60905",
"storeTimestamp":1660564149566,
"storeHost":"192.168.71.188:8422",
"msgId":"C0A847BC000020E60000000000003C27",
"commitLogOffset":15399,
"bodyCRC":1729222146,
"reconsumeTimes":0,
"preparedTransactionOffset":0,
"topic":"test",
"properties":{
"MIN_OFFSET":"0",
"MAX_OFFSET":"6",
"UNIQ_KEY":"0505CD4343C018B4AAC24C59BD360002"
},
"messageBody":"mmfyJPna5ArnW0KcqP5QQErMYmfdYMVSn699eWZqLFk07AjzBN2eTK0cEtcicngBvKMegX76OwddTRqkdOxVMgLLNdqTG41UwLKJt1a4NnuWDiiyXklnMZ0ZC1ftWEgvdggeJu8k9hhK2wBQZrbfFIX0VrvINXqj0M77mQ8NA6QLojhUlzdbvSZT3mAsZUY3j45jAKFrCgnlGKdzgIz9s5vELpb3N6pyrSeKBrTaQV0wVEG4rzPRMQcfmYMy9bneQLVMZDp7bIsFdE8cpsktR0Uk58ofP0U3KTEkcg3Tkrtx6Hd7eFKUtS7Kxuci18V9BCisO6gKBUpVyKsWP4eB9FJ4r2Jo5oFNLotl3gq9nPhrpkgSIV3TzBINCokLzTAHrpftt3W3VU4OrRcpFFAMcDWlVDWfpG8VXm1QjnVJCWsDIeMAvEUuauU9D8vkHeYen7uR9a3dCgFiwWQOO6MXPxAiV5XFaz3Tmo87G9J01SdH3o1B2p8E67f2zdVoqU1RxrzTnar3ubbTabMs6B6gjfuoA0QZcaTtROseYsGu8uKrVVRqL3fgB5XbGWULQ8AFEOn3MsEEaNe5HxchutMAf0uj2GhYg7SyDp832OXaBzbRu07cI3BA7P2pa0nNPBprwB0YYNLZLOaf5nYOY3sytbIQdy7CH9YqRcEgUK0NWXAtqlnYhdVFzRSaWEwhvuCn1mISWik4HhfhFepmpZztB5dsII8F4LpjIk4e0iDDtXDZGtPFlpTaLaSFEPRfuPWkWK7VkHL5NHk86b9uFIlXlPJC5SoXp6c2Gyh34ZufH63aHJv7kM",
"status":null
}
]
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}