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. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Number |
Total. |
next_offset |
Integer |
Offset of the next page. |
previous_offset |
Integer |
Offset of the previous page. |
brokers |
Array of brokers objects |
Broker list. |
Example Requests
Querying the broker list of a RocketMQ instance
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/brokers
Example Responses
Status code: 200
RocketMQ brokers queried successfully.
{ "total" : 1, "next_offset" : -1, "previous_offset" : -1, "brokers" : [ { "ids" : [ 0, 1, 2 ], "broker_name" : "broker-0" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
RocketMQ brokers queried successfully. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.