更新时间：2023-08-16 GMT+08:00
查询分区指定时间段的消息
功能介绍
查询分区指定时间段的消息。
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID。 |
|
topic |
是 |
String |
Topic名称。 Topic名称必现以字母开头且只支持大小写字母、中横线、下划线以及数字。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
start_time |
否 |
String |
查询起始时间，为unix时间戳格式，默认值为0。 |
|
end_time |
否 |
String |
查询结束时间，为unix时间戳格式，默认值为系统当前时间。 |
|
limit |
否 |
Integer |
单页返回消息数，默认值为10。 |
|
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询， offset大于等于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 |
查询分区指定时间段的消息成功。 |
错误码
请参见错误码。
父主题： 消息查询
