查询集群参数
该接口用于查询集群中目前使用的集群参数信息。
请求结构
GET /v{version}/clusters/{clusterId}/configurations HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clusterId | String | 是 | Query参数 | 集群ID |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| context | List<ClusterConfigOption> | 集群中使用的参数信息 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
| CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
| INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
GET http://kafka-api.bj.baidubce.com/v2/clusters/6bc4775ffb9b4523833e54d802d53598/configurations
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
{
"context": [
{
"name": "auto.create.topics.enable",
"description": "是否允许自动创建 topic",
"updateMode": "STATIC",
"scope": [
true,
false
],
"defaultValue": false,
"currentValue": false,
"type": "BOOLEAN",
"unit": null,
"category": "主题",
"overrideMode": "REQUIRED"
},
{
"name": "log.retention.hours",
"description": "消息保留时长（小时）",
"updateMode": "STATIC",
"scope": [
1,
2147483646
],
"defaultValue": 168,
"currentValue": 133,
"type": "INT",
"unit": "hour",
"category": "消息",
"overrideMode": "REQUIRED"
}
]
}