全部产品
Search
文档中心

消息队列Kafka版:GetConsumerList - 获取Consumer Group信息

更新时间:Nov 18, 2022

调用GetConsumerList获取Group信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alikafka:ListGroupRead
  • AliKafka
    acs:alikafka:*:*:*

请求参数

名称类型必填描述示例值
InstanceIdstring

Group所属实例的ID。

alikafka_post-cn-v0h18sav****
RegionIdstring

Group所属实例的地域ID。

cn-hangzhou
ConsumerIdstring

指定Group的ID。如果不指定,则查询所有Group。

kafka-test

返回参数

名称类型描述示例值
object
Codeinteger

返回码。返回200代表成功。

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求ID。

808F042B-CB9A-4FBC-9009-00E7DDB6****
Successboolean

调用是否成功。

true
ConsumerListarray

Group列表。

object
ConsumerIdstring

Group名称。

kafka-test
InstanceIdstring

实例ID。

alikafka_post-cn-v0h18sav****
Remarkstring

备注。

test
RegionIdstring

地域ID。

cn-hangzhou
Tagsarray

标签。

object
Keystring

标签键。

test
Valuestring

标签值。

test

示例

正常返回示例

JSON格式

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

错误码

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