Querying the Broker List

Updated on 2022-09-14 GMT+08:00

View PDF

This API is used to query the list of brokers.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
brokers	Array of brokers objects	Broker list.

**Table 3** brokers
Parameter	Type	Description
ids	Array of numbers	All broker IDs.
broker_name	String	Broker name.

Querying the broker list

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

Status code: 200

RocketMQ brokers queried successfully.

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

Status Code	Description
200	RocketMQ brokers queried successfully.

Parent topic: Lifecycle Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel