文档首页/应用与数据集成平台 ROMA Connect/API参考/消息集成API/消息管理/查询消息 - ShowMqsInstanceMessages
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询消息 - ShowMqsInstanceMessages

功能介绍

查询消息的偏移量和消息内容。

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目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参数不为空，该参数无效。

key

否

String

消息Key。

message_id

否

String

消息ID。

tag

否

String

消息标签。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

messages

Array of messages objects

消息列表。

total

Number

消息总数。

size

Number

返回总条数。

表5 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

集成应用key。

tag

String

消息标签。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

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
}

状态码：400

Bad Request

{
  "error_code" : 400,
  "error_msg" : "Bad Request"
}

状态码：403

Forbidden

{
  "error_code" : 403,
  "error_msg" : "Forbidden"
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

错误码

请参见错误码。

父主题：消息管理

相关文档