GetConsumerList - 获取Consumer Group信息

调用GetConsumerList获取Group信息。

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
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

示例

请求示例

http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=GetConsumerList
&InstanceId=alikafka_post-cn-v0h18sav****
&RegionId=cn-hangzhou
&ConsumerId=kafka-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"
                }
            ]
        }
    ]
}

XML格式

<GetConsumerListResponse>
    <Code>200</Code>
    <Message>operation success.</Message>
    <RequestId>808F042B-CB9A-4FBC-9009-00E7DDB6****</RequestId>
    <Success>true</Success>
    <ConsumerList>
        <ConsumerId>kafka-test</ConsumerId>
        <InstanceId>alikafka_post-cn-v0h18sav****</InstanceId>
        <Remark>test</Remark>
        <RegionId>cn-hangzhou</RegionId>
        <Tags>
            <Key>test</Key>
            <Value>test</Value>
        </Tags>
    </ConsumerList>
</GetConsumerListResponse>

错误码

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

阿里云首页 消息队列Kafka版 相关技术圈