列出 Kafka 消费组 - ListUKafkaConsumers

简介

列出 Kafka 消费组

定义

公共参数

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

请求参数

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

响应字段

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

数据模型

Group

字段名	类型	描述信息	必填
GroupName	string	消费者组组名	No
Type	string	消费者组类型	No
NumOfTopics	int	订阅 Topic 数量	No

示例

请求示例


https://api.tnqacloud.com/?Action=ListUKafkaConsumers
&Region=befZCCUI
&Zone=boqlDiIv
&ProjectId=aTyyvWoG
&ClusterInstanceId=yUHbmMXE
&ConsumerGroup=LgcijwcM
&Type=ZK

响应示例


{
  "Action": "ListUKafkaConsumersResponse",
  "Groups": [
    {
      "GroupName": "your_group",
      "NumOfTopics": 1,
      "Type": "ZK"
    },
    {
      "GroupName": "group1",
      "NumOfTopics": 2,
      "Type": "ZK"
    },
    {
      "GroupName": "console-consumer-15031",
      "NumOfTopics": 1,
      "Type": "KF"
    },
    {
      "GroupName": "c-group-no.1",
      "NumOfTopics": 7,
      "Type": "KF"
    },
    {
      "GroupName": "console-consumer-49808",
      "NumOfTopics": 1,
      "Type": "KF"
    },
    {
      "GroupName": "console-consumer-66549",
      "NumOfTopics": 7,
      "Type": "KF"
    },
    {
      "GroupName": "console-consumer-27520",
      "NumOfTopics": 1,
      "Type": "KF"
    },
    {
      "GroupName": "console-consumer-6519",
      "NumOfTopics": 1,
      "Type": "KF"
    }
  ],
  "RetCode": 0
}