查询集群参数
更新时间:2024-01-03
该接口用于查询集群中目前使用的集群参数信息。
请求结构
                Java
                
            
            1GET /v{version}/clusters/{clusterId}/configurations HTTP/1.1
2Host: kafka-api.bj.baidubce.com
3Authorization: authorization string
            请求头域
除公共头域外,无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 | 
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 | 
| clusterId | String | 是 | Query参数 | 集群ID | 
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| context | List<ClusterConfigOption> | 集群中使用的参数信息 | 
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 | 
|---|---|---|---|
| ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 | 
| CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 | 
| INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 | 
请求示例
                Java
                
            
            1GET http://kafka-api.bj.baidubce.com/v2/clusters/6bc4775ffb9b4523833e54d802d53598/configurations
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    "context": [
9        {
10            "name": "auto.create.topics.enable",
11            "description": "是否允许自动创建 topic",
12            "updateMode": "STATIC",
13            "scope": [
14                true,
15                false
16            ],
17            "defaultValue": false,
18            "currentValue": false,
19            "type": "BOOLEAN",
20            "unit": null,
21            "category": "主题",
22            "overrideMode": "REQUIRED"
23        },
24        {
25            "name": "log.retention.hours",
26            "description": "消息保留时长(小时)",
27            "updateMode": "STATIC",
28            "scope": [
29                1,
30                2147483646
31            ],
32            "defaultValue": 168,
33            "currentValue": 133,
34            "type": "INT",
35            "unit": "hour",
36            "category": "消息",
37            "overrideMode": "REQUIRED"
38        }
39    ]
40}
            