获取主题列表详情

最近更新时间: 2026-09-17 00:01:30

1. 接口描述

接口请求域名： ckafka.api3.fincloud.tencent.cn。

获取主题列表详情（仅控制台调用）

默认接口请求频率限制：100次/秒。

接口更新时间：2025-08-21 17:11:52。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeTopicDetail
Version	是	否	String	公共参数，本接口取值：2019-08-19
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	实例id 示例值： ckafka-test
SearchWord	否	否	String	（过滤条件）按照topicName过滤，支持模糊查询示例值： search-test
Offset	否	否	Int64	偏移量，不填默认为0 示例值： 0
Limit	否	否	Int64	返回数量，不填则默认 10，最大值20，取值要大于0 示例值： 10

3. 输出参数

参数名称	类型	描述
Result	TopicDetailResponse	返回的主题详情实体示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
InvalidParameterValue.WrongAction	Action参数取值错误。
InvalidParameterValue.InstanceNotExist	实例不存在。
UnauthorizedOperation	未授权操作。
UnsupportedOperation.OssReject	Oss拒绝该操作
InvalidParameterValue.SubnetNotBelongToZone	子网不属于zone
InternalError	内部错误。
ResourceUnavailable	资源不可用。

5. 示例

示例1 获取实例列表详情

输入示例

https://ckafka.api3.{{conf.domain_main}}/?Action=DescribeTopicDetail
&InstanceId=ckafka-xxooa0
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TopicList": [
                {
                    "TopicName": "test",
                    "TopicId": "inter-topic-d7a2f7fq",
                    "PartitionNum": 3,
                    "ReplicaNum": 2,
                    "Note": "",
                    "CreateTime": 1561637447,
                    "EnableWhiteList": false,
                    "IpWhiteListCount": 0,
                    "ForwardCosBucket": "",
                    "ForwardStatus": 1,
                    "ForwardInterval": 0,
                    "Config": {
                        "Retention": 300000000
                    }
                }
            ],
            "TotalCount": 12
        },
        "RequestId": "98fdae03-9bc2-4c2e-b429-0a96cca7144b"
    }
}