查询集群配置列表
更新时间：2023-12-29
该接口用于查询用户在该区域中的集群配置列表信息。
请求结构
Java
1GET /v{version}/configs HTTP/1.1
2Host: kafka-api.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，需要设置为配置ID |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量不超过1000，缺省值为1000 |
| state | String | 否 | Query参数 | 用于指定查询配置的状态，USED表示配置正在使用的配置，UNUSED表示未使用的配置。如果不传入该参数，则表示查询所有状态的配置。 |
| configName | String | 否 | Query参数 | 配置名称模糊匹配 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置，与请求接口时传入的marker参数值保持一致 |
| maxKeys | int | 每页包含的最大数量，，最大数量不超过1000，缺省值为1000 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 下一页所需要传递的marker值，当isTruncated为false时，该值为null |
| configs | List<ClusterConfig> | 集群配置信息列表，由 ClusterConfig 组成的集合 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
| INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
Java
1GET http://kafka-api.bj.baidubce.com/v2/configs
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 "marker": null,
9 "isTruncated": false,
10 "nextMarker": null,
11 "maxKeys": 1000,
12 "configs": [
13 {
14 "configId": "28c3658fecad4d3e811b2b522ad07b8e",
15 "name": "cluster_config_1",
16 "state": "USED",
17 "description": "配置详情",
18 "createTime": "2023-07-21T06:54:24Z"
19 },
20 {
21 "configId": "28c3658fecad4d3e811b2b522ad07b8f",
22 "name": "cluster_config_2",
23 "state": "UNUSED",
24 "description": "配置详情",
25 "createTime": "2023-07-21T06:54:24Z"
26 }
27 ]
28}