查询消息
功能介绍
查询消息。
URI
GET /v2/{engine}/{project_id}/instances/{instance_id}/messages
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| engine | 是 | String | 消息引擎。 缺省值：reliability |
| project_id | 是 | String | 项目ID。 |
| instance_id | 是 | String | 实例ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| topic | 是 | String | 主题名称。 |
| limit | 否 | String | 查询数量。 |
| offset | 否 | String | 偏移量，表示从此偏移量开始查询， offset大于等于0。 |
| start_time | 否 | String | 开始时间（不按msg_id查询时需要填写开始时间）。 |
| end_time | 否 | String | 结束时间（不按msg_id查询时需要填写结束时间）。 |
| msg_id | 否 | String | 消息ID。 |
请求参数
无
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| messages | Array of Message objects | 消息列表。 |
| total | Number | 消息总数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| msg_id | String | 消息ID。 |
| instance_id | String | 实例ID。 |
| topic | String | 主题名称。 |
| store_timestamp | Number | 存储消息的时间。 |
| born_timestamp | Number | 产生消息的时间。 |
| reconsume_times | String | 重试次数。 |
| body | String | 消息体。 |
| body_crc | Number | 消息体校验和。 |
| store_size | Number | 存储大小。 |
| property_list | Array of property_list objects | 消息属性列表。 |
| born_host | String | 产生消息的主机IP。 |
| store_host | String | 存储消息的主机IP。 |
| queue_id | String | 队列ID。 |
| queue_offset | String | 在队列中的偏移量。 |
请求示例
查询消息。
GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/messages 响应示例
状态码： 200
查询消息成功。
{
"messages" : [ {
"msg_id" : "C0A807C9000027740000000000000030",
"instance_id" : "11c45539-xxxx-xxxx-xxxx-812c41f61f30",
"topic" : "topic-test",
"store_timestamp" : 1648888166319,
"born_timestamp" : 1648888166275,
"reconsume_times" : 0,
"body" : "xxxx",
"body_crc" : 1932557065,
"store_size" : 175,
"property_list" : [ {
"name" : "KEYS",
"value" : ""
}, {
"name" : "UNIQ_KEY",
"value" : "7F00000123DC6E0BE85808B037820000"
}, {
"name" : "CLUSTER",
"value" : "DmsCluster"
}, {
"name" : "TAGS",
"value" : ""
} ],
"born_host" : "192.168.0.66:50098",
"store_host" : "192.168.7.201:10100",
"queue_id" : 2,
"queue_offset" : 0
} ],
"total" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询消息成功。 |
错误码
请参见错误码。
