查询主题订阅详情
更新时间：2024-01-03
该接口用于查询集群中指定消费组对指定主题（topic）各个分区的订阅详细信息。
请求结构
GET /v{version}/clusters/{clusterId}/topics/{topicName}/consumer-groups/{groupName}/subscribe-details HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clusterId | String | 是 | URL参数 | 待查询的集群ID |
| topicName | String | 是 | URL参数 | 待查询topic的名称 |
| groupName | String | 是 | URL参数 | 待查询的消费组名称 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| subscribePartitions | List<GroupTopicPartition> | 消费组对topic各个分区的订阅详细信息，由 GroupTopicPartition 组成的集合 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 描述 |
|---|---|---|---|
| ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
| CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
| CLUSTER_HAD_DELETED | 集群已删除 | 451 | 集群已删除 |
| CLUSTER_NOT_BELONGED | 未拥有该集群 | 451 | 未拥有该集群 |
| CLUSTER_NOT_AVAILABLE | 集群不可用 | 451 | 集群不可用 |
| TOPIC_NOT_EXIST | 主题不存在 | 451 | 主题不存在 |
| INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
GET http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/topics/test/consumer-groups/group-id-test/subscribe-details
Authorization: bce-auth-v1/ec7f277752364a61af9f3bcb10eb803e/2023-05-08T09:39:11Z/3600/host;x-bce-console-rpc-id;x-bce-date/b8f6045003584ec16618f7aac47a8af72bea075ccc7576e8763838bc6a3d86fb
Host: kafka-api.bd.baidubce.com
x-bce-console-rpc-id: cf57b4b1-a86f-4423-86fb-736c22068d84
x-bce-date: 2023-05-08T09:39:11Z返回示例
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
{
"subscribePartitions": [
{
"partitionId": 0,
"topicName": "test",
"consumerId": "client-id-test-67c2a19f-45e3-4ffd-bfc3-17a0efc65b65",
"clientId": "client-id",
"host": "192.168.1.1"
"maxOffset": 66,
"committedOffset": 66,
"lag": 0,
"lastConsumeTime": "2023-05-10T03:06:25Z"
},
{
"partitionId": 1,
"topicName": "test",
"consumerId": "client-id-test-67c2a19f-45e3-4ffd-bfc3-17a0efc65b65",
"clientId": "client-id",
"host": "192.168.1.1"
"maxOffset": 62,
"committedOffset": 62,
"lag": 0,
"lastConsumeTime": "2023-05-10T03:06:25Z"
},
{
"partitionId": 2,
"topicName": "test",
"consumerId": "client-id-test-67c2a19f-45e3-4ffd-bfc3-17a0efc65b65",
"clientId": "client-id",
"host": "192.168.1.1"
"maxOffset": 61,
"committedOffset": 61,
"lag": 0,
"lastConsumeTime": "2023-05-10T03:06:25Z"
}
]
}