调用 DescribeTopic 接口，查询目标 Topic 的详情。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
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 使用的存储空间用量详情。 |
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" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。