文档中心

云原生消息引擎

Topic 管理

DescribeTopic - 查询 Topic 详情

调用 DescribeTopic 接口，查询目标 Topic 的详情。

请求说明

请求方式：GET

请求地址：https://open.volcengineapi.com?Action=DescribeTopic&Version=2023-06-01

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeTopic

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

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

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

TopicId string 可选示例值：677bb****b1e406797e87e309785c4e6

需要查询的 Topic ID。

说明

如果不使用 TopicId 查询 Topic，InstanceId 和 TopicName 需要同时填写。

InstanceId string 可选示例值：o-00c0****m46c

实例 ID。

TopicName string 可选示例值：topic-test

需要查询的 Topic 名称。

返回参数

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

Usage object 示例值：\-

Topic 使用的存储空间用量详情。

TopicId string

分区 ID

CfsDataUsage long

cfs的数据使用量

Status string 示例值：RUNNING

Topic 状态。

TopicId string 示例值：677bb****b1e406797e87e309785c4e6

Topic ID。

OwnerName string 示例值：wu****an@bytedance.com

Topic 所属用户。

Retention integer 示例值：96

消息在 Topic 中的保留时长，单位为小时。

TopicName string 示例值：topic-1

Topic 名称。

CreateTime string 示例值：2024-12-06T14:00:00

Topic 创建时间。

InstanceId string 示例值：o-0c0c****bm46c

Topic 所属实例 ID。

Partitions integer 示例值：12

Topic 分区数。

Description string 示例值：测试使用

Topic 描述语句。

请求示例

POST /?Action=DescribeTopic&Version=2023-06-011&TopicId=677bbdd**e309785c4e6 HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241112T082812Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=AK********/20241112/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********​
​
{}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202412061442309D5987A622DFD2E5****",​
        "Action": "DescribeTopic",​
        "Version": "2023-06-01",​
        "Service": "bmq",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "TopicId": "677bb****b1e406797e87e309785c4e6",​
        "InstanceId": "o-00c0****m46c",​
        "TopicName": "topic-test",​
        "Status": "RUNNING",​
        "Partitions": 12,​
        "Retention": 72,​
        "Description": "测试使用",​
        "Usage": {​
            "TopicId": "677bb****b1e406797e87e309785c4e6",​
            "CfsDataUsage": 12724260​
        },​
        "OwnerId": "36****65",​
        "OwnerName": "wu****an@bytedance.com",​
        "CreateTime": "2024-12-06T14:00:00"​
    }​
}​

错误码

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

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

最近更新时间：2025.08.05 18:34:37

这个页面对您有帮助吗？

有用

无用