Help Center>
Distributed Message Service for RocketMQ>
API Reference>
APIs V2 (Recommended)>
Lifecycle Management>
Querying the Broker List
Updated on 2022-07-07 GMT+08:00
Querying the Broker List
Function
This API is used to query the list of brokers.
URI
GET /v2/{project_id}/instances/{instance_id}/brokers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
brokers |
Array of brokers objects |
Broker list. |
Example Requests
Querying the broker list
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/brokers
Example Responses
Status code: 200
RocketMQ brokers queried successfully.
{ "brokers" : [ { "ids" : [ 0, 1, 2 ], "broker_name" : "broker-0" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
RocketMQ brokers queried successfully. |
Error Codes
See Error Codes.
Parent topic: Lifecycle Management
Feedback
Was this page helpful?
Provide feedback
Thank you very much for your feedback. We will continue working to improve the
documentation.
The system is busy. Please try again later.
For any further questions, feel free to contact us through the chatbot.
Chatbot