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 |
---|---|---|
brokers | Array of brokers objects | Broker list. |
Parameter | Type | Description |
---|---|---|
ids | Array of numbers | All broker IDs. |
broker_name | String | Broker name. |
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.
{"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
- URI