查询主题分区列表
更新时间:2023-06-30
该接口用于查询指定集群的主题的所有分区信息。
请求结构
Java
1GET /v{version}/clusters/{clusterId}/topics/{topicName}/partitions/statuses HTTP/1.1
2Host: kafka-api.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其他特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
clusterId | String | 是 | URL参数 | 待查询的集群ID |
topicName | String | 是 | URL参数 | 待查询的主题名称 |
pageNo | int | 是 | Query参数 | 批量获取列表的查询的起始位置 |
pageSize | int | 是 | Query参数 | 每页包含的最大数量,最大数量不超过20,缺省值为10 |
返回头域
除公共头域外,无其他特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
pageNo | int | 批量获取列表的查询的起始位置 |
pageSize | int | 每页包含的最大数量,最大数量不超过20,缺省值为10 |
total | int | 主题总共包含的分区数 |
partitions | List<TopicPartition> | 主题分区信息列表,由 TopicPartition 组成的集合 |
错误码
错误码 | 错误描述 | HTTP状态码 | 中文解释 |
---|---|---|---|
ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
CLUSTER_HAD_DELETED | 集群已删除 | 451 | 集群已删除 |
CLUSTER_NOT_BELONGED | 未拥有该集群 | 451 | 未拥有该集群 |
CLUSTER_NOT_AVAILABLE | 集群不可用 | 451 | 集群不可用 |
TOPIC_NOT_EXIST | 主题不存在 | 451 | 主题不存在 |
TOPIC_LIST_PARTITION_LIMIT_EXCEEDED_ERROR | 获取Topic分区数量超过限制 | 451 | 获取Topic分区数量超过限制 |
INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
Java
1GET http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/topics/demo-topic-test/partitions/statuses?pageNo=0&pageSize=10
2Authorization: bce-auth-v1/ALTAKaiKeDfBD880eMWBE5oIGE/2023-05-08T11:43:45Z/1800/host;x-bce-date/322f3f98ce57d296c0f5abc64e5554b640ea035c5cb462fcaeab54b9810a3c61
3Host: kafka-api.bj.baidubce.com
返回示例
Java
1HTTP/1.1 200 OK
2x-bce-request-id: 97e6d4ad-6fca-4609-ad4d-9a27c4d1a362
3Date: Mon, 08 May 2023 09:39:11 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "pageNo": 0,
9 "pageSize": 10,
10 "totalCount": 2,
11 "partitions": [{
12 "topicName": "test",
13 "partitionId": 1,
14 "leaderId": 1027,
15 "replicas": [1027,1011,1009],
16 "inSyncReplicas": [1027,1011,1009],
17 "minOffset": 0,
18 "maxOffset": 1024,
19 "messageNum": 1024,
20 "lastUpdateTime": "2023-05-10T03:06:25Z"
21 },
22 {
23 "topicName": "test",
24 "partitionId": 2,
25 "leaderId": 1003,
26 "replicas": [1003,1008,1039],
27 "inSyncReplicas": [1003,1008,1039],
28 "minOffset": 0,
29 "maxOffset": 1024,
30 "messageNum": 1024,
31 "lastUpdateTime": "2023-05-10T03:06:25Z"
32 }
33 ]
34}