Help Center/ Distributed Message Service for RocketMQ/ API Reference (ME-Abu Dhabi Region)/ APIs V2 (Recommended)/ Topic Management/ Querying a Topic
Updated on 2023-05-06 GMT+08:00
View PDF
Share

Querying a Topic

Function

This API is used to query a topic.

URI

GET /v2/{project_id}/instances/{instance_id}/topics/{topic}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID.

topic

Yes

String

Topic name.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total_read_queue_num

Number

Total number of read queues.

total_write_queue_num

Number

Total number of write queues.

permission

String

Permissions.

brokers

Array of brokers objects

Associated brokers.
Table 3 brokers

Parameter

Type

Description

broker_name

String

Broker name.

read_queue_num

Number

Number of read queues.

write_queue_num

Number

Number of write queues.

Example Requests

Querying a topic

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}

Example Responses

Status code: 200

Topic queried successfully.

{
  "total_read_queue_num" : 3,
  "total_write_queue_num" : 3,
  "permission" : "all",
  "brokers" : [ {
    "broker_name" : "broker-0",
    "read_queue_num" : 3,
    "write_queue_num" : 3
  } ]
}

Status Codes

Status Code

Description

200

Topic queried successfully.

Error Codes

See Error Codes.

Parent topic: Topic Management