查询消息
功能介绍
查询消息的偏移量和消息内容。 先根据时间戳查询消息的偏移量，再根据偏移量查询消息内容。
URI
GET /v2/{project_id}/instances/{instance_id}/messages
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID，获取方式请参见获取项目ID。 |
| instance_id | 是 | String | 实例ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| topic | 是 | String | Topic名称。 Topic名称必须以字母开头且只支持大小写字母、中横线、下划线以及数字。 |
| asc | 否 | Boolean | 是否按照时间排序。 |
| start_time | 否 | String | 开始时间。 Unix毫秒时间戳。 查询消息偏移量时，为必选参数。 |
| end_time | 否 | String | 结束时间。 Unix毫秒时间戳。 查询消息偏移量时，为必选参数。 |
| limit | 否 | String | 每一页显示的message数量。 |
| offset | 否 | String | 页数。 |
| download | 否 | Boolean | 是否下载。 |
| message_offset | 否 | String | 消息偏移量。 查询消息内容时，为必选参数。 若start_time、end_time参数不为空，该参数无效。 |
| partition | 否 | String | 分区。 查询消息内容时，为必选参数。 若start_time、end_time参数不为空，该参数无效。 |
| keyword | 否 | String | 关键词。 取值范围为0~50。 最小长度：0 最大长度：50 |
请求参数
无
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| messages | Array of MessagesEntity objects | 消息列表。 |
| total | Long | 消息总条数。 |
| size | Long | 每页消息条数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| topic | String | topic名称。 |
| partition | Integer | 消息所在的分区。 |
| key | String | 消息key。 |
| value | String | 消息内容。 |
| size | Integer | 消息大小。 |
| timestamp | Long | topic名称。 |
| huge_message | Boolean | 大数据标识。 |
| message_offset | Integer | 消息偏移量。 |
| message_id | String | 消息ID。 |
| app_id | String | 应用ID。 |
| tag | String | 消息标签。 |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码： 403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
-
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages?asc=false&end_time=1608609032042&limit=10&offset=0&start_time=1608608432042&topic=topic-test -
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages?download=false&message_offset=0&partition=0&topic=topic-test
响应示例
状态码： 200
查询成功。
{
"messages" : [ {
"topic" : "topic-test",
"partition" : 0,
"value" : "hello world",
"size" : 21,
"timestamp" : 1607598463502,
"huge_message" : false,
"message_offset" : 4,
"message_id" : "",
"app_id" : "",
"tag" : ""
} ],
"total" : 1,
"size" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功。 |
| 400 | 参数无效。 |
| 403 | 鉴权失败。 |
错误码
请参见错误码。
