文档首页> 应用与数据集成平台 ROMA Connect> API参考（阿布扎比区域）> 消息集成API> 消息管理> 查询消息
更新时间：2022-12-05 GMT+08:00
查看PDF

查询消息

功能介绍

查询消息的偏移量和消息内容。 先根据时间戳查询消息的偏移量，再根据偏移量查询消息内容。

URI

GET /v2/{project_id}/mqs/instances/{instance_id}/messages

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户的项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

topic

是

String

topic名称。

asc

否

Boolean

是否按照时间排序。

start_time

否

String

开始时间。Unix毫秒时间戳。 查询消息偏移量时，为必选参数。

end_time

否

String

开始时间。Unix毫秒时间戳。 查询消息偏移量时，为必选参数。

limit

否

String

查询消息的数量。

offset

否

String

查询的偏移量。

download

否

Boolean

是否下载。

message_offset

否

String

消息偏移量。 查询消息内容时，为必选参数。 若start_time、end_time参数不为空，该参数无效。

partition

否

String

分区。 查询消息内容时，为必选参数。 若start_time、end_time参数不为空，该参数无效。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

messages

Array<Object>

消息列表。

total

Number

消息总数。

size

Number

返回总条数。
表4 messages

参数

参数类型

描述

topic

String

topic名称。

partition

Integer

消息所在的分区。

key

String

消息key。

value

String

消息内容。

size

Integer

消息大小。

timestamp

Integer

topic名称。

huge_message

Boolean

大数据标识。

message_offset

Integer

消息偏移量。

message_id

String

消息ID。

app_id

String

应用ID。

tag

String

消息标签。

请求示例

  • 查询消息偏移量。

    GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messages?asc=false&end_time=1608609032042&limit=10&offset=0&start_time=1608608432042&topic=topic-test-mqs

  • 查询消息内容。

    GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messagesdownload=false&message_offset=0&partition=0&topic=topic-test-mqs

响应示例

状态码： 200

OK

{
  "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

OK

400

Bad Request

403

Forbidden

错误码

请参见错误码。

父主题： 消息管理