更新时间:2026-04-03 GMT+08:00

查询主题的消息数

功能介绍

查询主题的消息数。

URI

GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

topic

String

参数解释

主题名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

max_offset

Integer

参数解释

最大偏移量。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

min_offset

Integer

参数解释

最小偏移量。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

brokers

Array of brokers objects

参数解释

代理。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 brokers

参数

参数类型

描述

queues

Array of queues objects

参数解释

队列列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

broker_name

String

参数解释

节点名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 queues

参数

参数类型

描述

id

Integer

参数解释

队列ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

min_offset

Integer

参数解释

最小偏移量。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

max_offset

Integer

参数解释

最大偏移量。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

last_message_time

Long

参数解释

最后一条消息的时间。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求示例

查询指定主题的消息数。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}/status

响应示例

状态码:200

查询成功

查询主题的消息数成功。

{
  "brokers" : {
    "queues" : [ {
      "id" : 0,
      "min_offset" : 0,
      "max_offset" : 2,
      "last_message_time" : 1662689877152
    } ],
    "broker_name" : "broker-0"
  }
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码