Help Center> Distributed Message Service for RocketMQ> API Reference> APIs V2 (Recommended)> Topic Management> Querying the Number of Messages in a Topic
Updated on 2022-11-07 GMT+08:00
View PDF

Querying the Number of Messages in a Topic

Function

This API is used to query the number of messages in a topic.

URI

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

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

brokers

Array of brokers objects

Brokers.
Table 3 brokers

Parameter

Type

Description

queues

Array of queues objects

Queue list.

broker_name

String

Broker name.
Table 4 queues

Parameter

Type

Description

id

Integer

Queue ID.

min_offset

Integer

Minimum offset.

max_offset

Integer

Maximum offset.

last_message_time

Integer

Time of the last message.

Example Requests

Querying the number of messages in a topic

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

Example Responses

Status code: 200

The number of messages in the topic queried successfully.

{
  "brokers" : {
    "queues" : [ {
      "id" : 0,
      "min_offset" : 0,
      "max_offset" : 2,
      "last_message_time" : 1662689877152
    } ],
    "broker_name" : "broker-0"
  }
}

Status Codes

Status Code

Description

200

The number of messages in the topic queried successfully.

Error Codes

See Error Codes.

Parent topic: Topic Management