查询消费组列表
更新时间：2023-06-30
该接口用于查询集群中的消费组列表信息。
请求结构
GET /v{version}/clusters/{clusterId}/consumer-groups HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clusterId | String | 是 | URL参数 | 待查询的集群ID |
| groupName | String | 否 | Query参数 | 消费组名称，用于模糊匹配 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groups | List<Group> | 消费组列表信息，由 Group 组成的集合 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 描述 |
|---|---|---|---|
| CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
| CLUSTER_HAD_DELETED | 集群已删除 | 451 | 集群已删除 |
| CLUSTER_NOT_BELONGED | 未拥有该集群 | 451 | 未拥有该集群 |
| CLUSTER_NOT_AVAILABLE | 集群不可用 | 451 | 集群不可用 |
| INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
GET http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/consumer-groups
Authorization: bce-auth-v1/ALTAKaiKeDfBD880eMWBE5oIGE/2023-05-08T11:43:45Z/1800/host;x-bce-date/322f3f98ce57d296c0f5abc64e5554b640ea035c5cb462fcaeab54b9810a3c61
Host: kafka-api.bj.baidubce.com返回示例
HTTP/1.1 200 OK
x-bce-request-id: 97e6d4ad-6fca-4609-ad4d-9a27c4d1a362
Date: Mon, 08 May 2023 09:39:11 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"groups": [
{
"groupName": "group-id3-test",
"updateTime": "2023-05-10T03:06:25Z"
},
{
"groupName": "group-id2-test",
"updateTime": "2023-05-10T03:06:01Z"
},
{
"groupName": "group-id1-test",
"updateTime": "2023-05-10T03:05:48Z"
}
]
}