Docs

Message Queue for RocketMQ

Topic management

DescribeTopicDetail - Query topic details

Call the DescribeTopicDetail API to query topic details.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.

Action string required Example: DescribeTopicDetail

Action to perform: DescribeTopicDetail.

Version string required Example: 2023-01-01

API version, value: 2023-01-01.

InstanceId string required Example: rocketmq-cnai1f0c2****

Instance ID.

TopicName string required Example: my_topic

Topic name.

Response parameters

Only the unique response parameters of this API are listed below. For more details, see response structure.

InstanceId string Example: rocketmq-cnai1f0c2****

Instance ID.

TopicName string Example: my_topic

Topic name.

Description string Example: description_for_test

Topic description.

CreatedTime long Example: 1751443856

Topic creation time.

InstanceName string Example: Instance_test

Instance name.

InstanceRegion string Example: cn-beijing

The region where the instance is located.

TopicQueueNumber integer Example: 2

Queue count.

ServiceStatus string Example: Running

Service status.

MessageType string Example: Common

Message type.

Request example

POST /?Action=DescribeTopicDetail&Version=2023-01-01 HTTP/1.1​
Host: rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260422T090516Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260422/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "rocketmq-cnai1f0c2****",​
  "TopicName": "my_topic"​
}​

Response example

{​
  "ResponseMetadata": {​
    "RequestId": "2026042217052222304104421802****",​
    "Action": "DescribeTopicDetail",​
    "Version": "2023-01-01",​
    "Service": "RocketMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "InstanceId": "rocketmq-cnai1f0c2****",​
    "TopicName": "my_topic",​
    "Description": "description_for_test",​
    "CreatedTime": 1751443856,​
    "InstanceName": "Instance_test",​
    "InstanceRegion": "cn-beijing",​
    "TopicQueueNumber": 2,​
    "ServiceStatus": "Running",​
    "MessageType": "Common"​
  }​
}​

Error code

The following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.

Status code	Error code	Error message	description
200	OK	OK	Success.
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	Instance does not exist.
404	InvalidTopicName.NotFound	The specified topic does not exist.	Topic does not exist.
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	Internal service error.
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	The current service is temporarily unavailable.

Last updated: 2026.04.22 17:43:21