文档中心

消息队列 RocketMQ版

Topic管理

DescribeTopicDetail - 查询 Topic 详情

调用 DescribeTopicDetail 接口，查询 Topic 详情。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeTopicDetail

要执行的操作，取值：DescribeTopicDetail。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：rocketmq-cnai1f0c2****

实例 ID。

TopicName string 必选示例值：my_topic

Topic 名称。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：rocketmq-cnai1f0c2****

实例 ID。

TopicName string 示例值：my_topic

Topic 名称。

Description string 示例值：description_for_test

Topic 描述。

CreatedTime long 示例值：1751443856

Topic 创建时间。

InstanceName string 示例值：Instance_test

实例名称。

InstanceRegion string 示例值：cn-beijing

实例所在的地域。

TopicQueueNumber integer 示例值：2

队列数。

ServiceStatus string 示例值：Running

服务状态。

MessageType string 示例值：Common

消息类型。

请求示例

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"​
}​

返回示例

{​
  "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"​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
404	InvalidTopicName.NotFound	The specified topic does not exist.	Topic 不存在。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

最近更新时间：2026.04.22 17:38:53

这个页面对您有帮助吗？

有用

无用