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
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
Parameter |
Type |
Description |
---|---|---|
brokers |
Array of brokers objects |
Brokers. |
Parameter |
Type |
Description |
---|---|---|
queues |
Array of queues objects |
Queue list. |
broker_name |
String |
Broker name. |
Example Requests
Querying the number of messages in a topic
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}/status
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
The number of messages in the topic queried successfully. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.