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 |
Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
|
instance_id |
Yes |
String |
Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Number |
Definition Total number. Range N/A |
|
next_offset |
Integer |
Definition Offset of the next page. Range N/A |
|
previous_offset |
Integer |
Definition Offset of the previous page. Range N/A |
|
brokers |
Array of brokers objects |
Definition 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,
"brokers" : [ {
"ids" : [ 0, 1, 2 ],
"broker_name" : "broker-0"
} ],
"next_offset" : -1,
"previous_offset" : -1
}
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.
