Updated on 2025-04-01 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

Table 1 Path Parameters

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

Table 2 Response body parameters

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.

Table 3 brokers

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.

{
  "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.