查询消息

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

topic

是

String

参数解释：

Topic名称。

约束限制：

Topic名称必须以字母开头且只支持大小写字母、中横线、下划线以及数字。

取值范围：

不涉及。

默认取值：

不涉及。

asc

否

Boolean

参数解释：

是否按照时间排序。

约束限制：

不涉及。

取值范围：

• true：按照时间排序。

• false：不按照时间排序。

默认取值：

不涉及。

start_time

否

String

参数解释：

开始时间。

Unix毫秒时间戳。

约束限制：

查询消息偏移量时，为必选参数。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

否

String

参数解释：

结束时间。

Unix毫秒时间戳。

约束限制：

查询消息偏移量时，为必选参数。

取值范围：

不涉及。

默认取值：

不涉及。

limit

否

String

参数解释：

每一页显示的消息数量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

String

参数解释：

页数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

download

否

Boolean

参数解释：

是否下载消息到本地。

约束限制：

不涉及。

取值范围：

• true：下载。

• false：不下载。

默认取值：

不涉及。

message_offset

否

String

参数解释：

消息偏移量。

约束限制：

查询消息内容时，为必选参数。

若start_time、end_time参数不为空，该参数无效。

取值范围：

不涉及。

默认取值：

不涉及。

partition

否

String

参数解释：

分区。

约束限制：

查询消息内容时，为必选参数。

若start_time、end_time参数不为空，该参数无效。

取值范围：

不涉及。

默认取值：

不涉及。

keyword

否

String

参数解释：

设置查询消息的关键词。

约束限制：

不涉及。

取值范围：

0~50字符。

默认取值：

不涉及。

messages

Array of MessagesEntity objects

参数解释：

消息列表。

total

Long

参数解释：

消息总条数。

取值范围：

不涉及。

size

Long

参数解释：

每页消息条数。

取值范围：

不涉及。

topic

String

参数解释：

Topic名称。

取值范围：

不涉及。

partition

Integer

参数解释：

消息所在的分区。

取值范围：

不涉及。

key

String

参数解释：

消息key。

取值范围：

不涉及。

value

String

参数解释：

消息内容。

取值范围：

不涉及。

size

Integer

参数解释：

消息大小。

取值范围：

不涉及。

timestamp

Long

参数解释：

生产消息的时间。 格式为Unix时间戳。单位为毫秒。

取值范围：

不涉及。

huge_message

Boolean

参数解释：

大数据标识。

取值范围：

不涉及。

message_offset

Long

参数解释：

消息偏移量。

取值范围：

不涉及。

message_id

String

参数解释：

消息ID。

取值范围：

不涉及。

app_id

String

参数解释：

应用ID。

取值范围：

不涉及。

tag

String

参数解释：

消息标签。

取值范围：

不涉及。

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

200

查询成功。

400

参数无效。

403

鉴权失败。