调用GetConsumerList获取Group信息_云消息队列 Kafka 版-阿里云帮助中心

调用GetConsumerList获取Group信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	Group所属实例的ID。	alikafka_post-cn-v0h18sav****
RegionId	string	是	Group所属实例的地域ID。	cn-hangzhou
ConsumerId	string	否	指定Group的ID。如果不指定，则查询所有Group。	kafka-test

返回参数

名称	类型	描述	示例值
	object
Code	integer	返回码。返回200代表成功。	200
Message	string	返回信息。	operation success.
RequestId	string	请求ID。	808F042B-CB9A-4FBC-9009-00E7DDB6****
Success	boolean	调用是否成功。	true
ConsumerList	object []	Group列表。
ConsumerId	string	Group名称。	kafka-test
InstanceId	string	实例ID。	alikafka_post-cn-v0h18sav****
Remark	string	备注。	test
RegionId	string	地域ID。	cn-hangzhou
Tags	object []	标签。
Key	string	标签键。	test
Value	string	标签值。	test
AutomaticallyCreatedGroup	boolean	自动创建的Group

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "808F042B-CB9A-4FBC-9009-00E7DDB6****",
  "Success": true,
  "ConsumerList": {
    "ConsumerVO": [
      {
        "ConsumerId": "kafka-test",
        "InstanceId": "alikafka_post-cn-v0h18sav****",
        "Remark": "test",
        "RegionId": "cn-hangzhou",
        "Tags": {
          "TagVO": [
            {
              "Key": "test",
              "Value": "test"
            }
          ]
        },
        "AutomaticallyCreatedGroup": true
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2022-12-27

OpenAPI 返回结构发生变更

变更项	变更内容
出参	OpenAPI 返回结构发生变更