Querying the Broker List

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	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

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
total	Number	Definition Total number. Constraints N/A Range N/A Default Value N/A
next_offset	Integer	Definition Offset of the next page. Constraints N/A Range N/A Default Value N/A
previous_offset	Integer	Definition Offset of the previous page. Constraints N/A Range N/A Default Value N/A
brokers	Array of brokers objects	Definition Broker list. Constraints N/A Range N/A Default Value N/A

**Table 3** brokers
Parameter	Type	Description
ids	Array of numbers	Definition All broker IDs. Constraints N/A Range N/A Default Value N/A
broker_name	String	Definition Node name. Constraints N/A Range N/A Default Value N/A

Querying the broker list of a RocketMQ instance

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

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 Code	Description
200	RocketMQ brokers queried successfully.

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

The system is busy. Please try again later.