获取主题列表详情

最近更新时间:2020-03-04 17:55:50

1. 接口描述

接口请求域名: ckafka.tencentcloudapi.com 。

获取主题列表详情(仅控制台调用)

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:ckafka.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTopicDetail。
Version String 公共参数,本接口取值:2019-08-19。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例id
SearchWord String (过滤条件)按照topicName过滤,支持模糊查询
Offset Integer 偏移量,不填默认为0
Limit Integer 返回数量,不填则默认 10,最大值20,取值要大于0

3. 输出参数

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

4. 示例

示例1 获取实例列表详情

输入示例

https://ckafka.tencentcloudapi.com/?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"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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