调用 DescribeGroups 接口查看指定实例的 Group 列表。

使用说明

此接口用于获取指定实例的消费组列表，支持根据消费组 ID 和状态进行筛选。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

请求示例

POST /?Action=CreatePublicAddress&Version=2022-05-01 HTTP/1.1
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "kafka-cnng3s31v076****",
  "PageNumber": 1,
  "PageSize": 2
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240924161953BCB063444FF0D58D1CE9-b1349a",
        "Action": "DescribeGroups",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "GroupsInfo": [
            {
                "BalanceAlgorithm": "range",
                "Description": "",
                "GroupId": "kafka-cn-beijing-a",
                "ProtocolType": "consumer",
                "State": "Stable"
            }
        ],
        "Total": 1
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。