列出 kafka 集群 topic - ListUKafkaTopics

简介

展示kafka集群上所有topic

定义

公共参数

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `ListUKafkaTopics`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

请求参数

参数名	类型	描述信息	必填
Region	string	地域。参见地域和可用区列表	Yes
Zone	string	可用区。参见可用区列表	Yes
ProjectId	string	项目 ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList 接口	No
ClusterInstanceId	string	集群资源id	Yes

响应字段

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No
TopicList	array[TopicInfo]	topic 信息列表	Yes
Length	int	列表长度	No

数据模型

TopicInfo

字段名	类型	描述信息	必填
Topic	string	topic 名称	No
NumOfPartition	int	分区数量	No
NumOfOccupyBroker	int	占用 broker 数量	No
NumOfReplica	int	副本数量	No
UnderReplicasPer	float	落后副本占比	No
Status	string	topic 状态	No

示例

请求示例


https://api.tnqacloud.com/?Action=ListUKafkaTopics
&Zone=cn-zj-02
&ClusterInstanceId=ukafka-asje3q
&Region=cn-zj
&ProjectId=qVHhqxTv

响应示例


{
  "Action": "ListTopicsResponse",
  "Length": 3,
  "RetCode": 0,
  "TopicList": [
    {
      "allIsr": 9,
      "allReplicas": 9,
      "numOfOccupyBroker": 3,
      "numOfPartition": 3,
      "numOfReplica": 3,
      "topic": "nil",
      "underReplicasPer": 0
    },
    {
      "allIsr": 9,
      "allReplicas": 9,
      "numOfOccupyBroker": 3,
      "numOfPartition": 3,
      "numOfReplica": 3,
      "topic": "foo",
      "underReplicasPer": 0
    },
    {
      "allIsr": 3,
      "allReplicas": 3,
      "numOfOccupyBroker": 3,
      "numOfPartition": 1,
      "numOfReplica": 3,
      "topic": "bar",
      "underReplicasPer": 0
    }
  ]
}