调用 DescribeTopics 接口查看 Topic 列表。

使用说明

此接口用于查看指定实例的 Topic 列表，也可以用于查看某个 Topic 的基础信息。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeTopics

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

Version string 必选示例值：2022-05-01

API 的版本，取值：2022-05-01。

InstanceId string 必选示例值：kafka-cnngbnntswg1****

实例 ID。

PageNumber integer 必选示例值：1

列表的页码，最小值为 1。

PageSize integer 必选示例值：10

列表中每一页的条目数量，取值范围为 1~100。

TopicName string 可选示例值：my_topic

Topic 的名称。设置此参数表示根据指定的 Topic 名称进行筛选，支持模糊匹配。

PartitionNumber integer 可选示例值：10

分区个数。设置此参数表示根据指定的分区个数筛选 Topic 列表。

ReplicaNumber integer 可选示例值：2

Topic 副本个数。设置此参数表示根据指定的副本个数筛选 Topic 列表。

TagFilters object[] 可选示例值：--

用于筛选 Topic 的标签。

标签键（Key）必填，标签值（Value）选填。标签值为空，则只根据标签建筛选 Topic。

设置多个标签时，不同筛选条件之间为或关系，即满足任一标签筛选条件则匹配成功。

Key string 必选示例值：test-Key

标签的键。

Value string 必选示例值：test-value

标签的值。

返回参数

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

Total integer 示例值：2

符合查询条件的 Topic 总数。

TopicsInfo object[] 示例值：--

符合查询条件的 Topic 列表。

TopicName string 示例值：my_topic

Topic 名称。

Description string 示例值：newtopic

Topic 的描述信息。

CreateTime string 示例值：2023-03-06T12:47:44Z

Topic 的创建时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

Status string 示例值：Running

Topic 的状态。

PartitionNumber integer 示例值：12

Topic 的分区数量。

ReplicaNumber integer 示例值：3

Topic 的副本数量。

LogRetentionHours integer 示例值：72

消息保留时长，单位小时。

UsedStoragePercentageInInstance double 示例值：0.0039

当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。

UsedStorageSpaceInBytes long 示例值：2521825280

当前 Topic 已使用的总存储空间大小。

Tags object[] 示例值：--

Topic 的标签。

Key string 示例值：test-Key

标签的键。

Value string 示例值：test-value

标签的值。

CleanupPolicy string[] 示例值：["delete","compact"]

Topic 的消息清理策略，支持以下三种取值方式：

["delete"]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。

说明

Kafka 实例默认的磁盘清理水位为 90%，具体以实际为准，详情请参见设置磁盘清理水位。

["compact"]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。

["delete","compact"]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。

InstanceId string 示例值：kafka-cnngbnntswg1****

实例 ID。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
400	MissingParameter	The request body is missing a required parameter %s.	缺少 %s 参数。
400	InvalidParameter.Unsupported	The specified parameter %s is not supported.	不支持 %s 参数。
400	Forbidden.Authentication	This operation is forbidden by Realname Authentication system.	账户未实名认证。
400	InvalidParameter.Malformed	The specified parameter %s is Malformed.	%s 参数不符合规范。
400	OperationDenied.InstanceClosed	The operation is not permitted due to the instance has overdue or expired.	当前实例已关停，无法执行该操作。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	InvalidParameter.PageNumber	The specified parameter PageNumber is not valid.	参数值 PageNumber 无效，请检查后重试。
400	InvalidParameter.PageSize	The specified parameter PageSize is not valid.	参数值 PageSize 无效，请检查后重试。
400	InvalidParameter.InstanceId	The specified parameter InstanceId is not valid.	参数值 InstanceId 无效，请检查后重试。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	实例当前状态下不支持的操作
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
404	InvalidTopicName.NotFound	The specified topic does not exist.	Topic 不存在。
404	InvalidInstance.NotFound	The specified instance does not exist.	该实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。
500	ServiceBusy	The service is busy. Try again later.	服务繁忙，请稍后重试。

消息队列 Kafka版