DescribeGroups - 查看 Group 列表--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

DescribeGroups - 查看 Group 列表

最近更新时间：2024.10.31 17:12:53首次发布时间：2023.03.30 19:59:26

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

使用说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeGroups	要执行的操作，取值：DescribeGroups。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
InstanceId	String	是	kafka-cnngbnnts****	实例 ID。
PageNumber	Integer	是	1	列表的页码，最小值为 1。
PageSize	Integer	是	10	列表中每一页的条目数量，取值范围为 1~100。
GroupId	String	否	Group1	根据 Group ID 筛选。
TagFilters	Array of Object	否	--	用于筛选 Group 的标签。标签键（Key）必填，标签值（Value）选填。标签值为空，则只根据标签建筛选 Topic。设置多个标签时，不同筛选条件之间为或关系，即满足任一标签筛选条件则匹配成功。

返回参数

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

参数	类型	示例值	描述
Total	Integer	10	Group 总数。
GroupsInfo	Array of Object	--	Group 列表。

请求示例

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
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
400	InvalidParameter.instance.id:{}	The instance ID is not available	实例 ID 不可用。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
404	InvalidGroupId.NotFound	The specified consumer group does not exist.	Group 不存在。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。