查询分区指定时间段的消息
功能介绍
查询分区指定时间段的消息。
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
topic |
是 |
String |
参数解释: Topic名称。 约束限制: Topic名称必须以字母开头且只支持大小写字母、中横线、下划线以及数字。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start_time |
否 |
String |
参数解释: 查询起始时间,为Unix时间戳格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0。 |
end_time |
否 |
String |
参数解释: 查询结束时间,为Unix时间戳格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 系统当前时间。 |
limit |
否 |
Integer |
参数解释: 单页返回消息数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 10。 |
offset |
否 |
Integer |
参数解释: 偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 不涉及。 |
partition |
否 |
String |
参数解释: 分区编号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 默认值为-1,若传入值为-1,则查询所有分区。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
messages |
Array of messages objects |
参数解释: 消息列表。 |
messages_count |
Integer |
参数解释: 消息总数。 取值范围: 不涉及。 |
offsets_count |
Integer |
参数解释: 总页数。 取值范围: 不涉及。 |
offset |
Integer |
参数解释: 当前页数。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages
响应示例
状态码:200
查询分区指定时间段的消息成功。
{ "messages" : [ { "topic" : "mytest", "partition" : 0, "message_offset" : 7, "size" : 6, "timestamp" : 1568125036045 } ], "messages_count" : 1, "offsets_count" : 1, "offset" : 1 }
状态码
状态码 |
描述 |
---|---|
200 |
查询分区指定时间段的消息成功。 |
错误码
请参见错误码。