GetConsumerList - API参考| 阿里云

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetConsumerList	系统规定参数。取值：GetConsumerList。
InstanceId	String	是	alikafka_post-cn-v0h18sav****	Group所属实例的ID。
RegionId	String	是	cn-hangzhou	Group所属实例的地域ID。
ConsumerId	String	否	kafka-test	指定Group的ID。如果不指定，则查询所有Group。

返回数据


名称	类型	示例值	描述
Code	Integer	200	返回码。返回200代表成功。
Message	String	operation success.	返回信息。
RequestId	String	808F042B-CB9A-4FBC-9009-00E7DDB6****	请求ID。
Success	Boolean	true	调用是否成功。
ConsumerList	Array of ConsumerVO		Group列表。
ConsumerVO
ConsumerId	String	kafka-test	Group名称。
InstanceId	String	alikafka_post-cn-v0h18sav****	实例ID。
Remark	String	test	备注。
RegionId	String	cn-hangzhou	地域ID。
Tags	Array of TagVO		标签。
TagVO
Key	String	test	标签键。
Value	String	test	标签值。

示例

请求示例

http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=GetConsumerList
&InstanceId=alikafka_post-cn-v0h18sav****
&RegionId=cn-hangzhou
&ConsumerId=kafka-test
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/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>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
    } ]
  } ]
}

错误码

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