文档首页/ 分布式消息服务RocketMQ版/ API参考 (巴黎区域)/ API V2（推荐）/ 生命周期管理/ 查询代理列表
更新时间：2023-08-16 GMT+08:00
查看PDF
分享

查询代理列表

功能介绍

查询代理列表。

URI

GET /v2/{project_id}/instances/{instance_id}/brokers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

brokers

Array of brokers objects

代理列表。
表3 brokers

参数

参数类型

描述

ids

Array of numbers

全部代理ID。

broker_name

String

节点名称。

请求示例

查询RocketMQ实例的代理列表。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/brokers

响应示例

状态码： 200

查询RocketMQ代理列表成功。

{
  "brokers" : [ {
    "ids" : [ 0, 1, 2 ],
    "broker_name" : "broker-0"
  } ]
}

状态码

状态码

描述

200

查询RocketMQ代理列表成功。

错误码

请参见错误码。

父主题： 生命周期管理