集群公网开关
更新时间：2024-01-03
该接口用于变更集群公网开关。
请求结构
PUT /v{version}/clusters/{clusterId}/eips/switch HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clusterId | String | 是 | URL参数 | 集群ID |
| publicIpBandwidth | Integer | 否 | Request Body参数 | 公网带宽值，publicIpEnabled = true 时有效 |
| publicIpEnabled | Boolean | 是 | Request Body参数 | 公网开关 |
| aclEnabled | Boolean | 否 | Request Body参数 | 公网开关 |
| authenticationMode | List< String > | 否 | Request Body参数 | 开关公网会影响集群所使用的认证方式，此处允许用户选择新的认证方式用以变更。 可选的值为：Node（无需身份认证）、SASL_SCRAM（使用SASL/SCRAM机制进行身份认证）、SASL_PLAIN（使用SASL/PLAIN机制进行身份认证）、SSL（使用SSL证书进行双向认证）。 可不传，会依据公网开关自动选择认证方式默认值，公网开启时，会默认增加SASL_SCRAM认证方式；公网关闭时，不会更改当前认证方式。 |
| couponIds | List< String > | 否 | Request Body参数 | 使用代金券时，可以指定使用哪些代金券。开启公网时，才需要使用代金券。 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| clusterId | String | 集群ID |
| jobId | String | 变更任务ID |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 描述 |
|---|---|---|---|
| ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
| CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
| CLUSTER_NOT_ACTIVE | 集群非运行状态 | 451 | 集群非运行状态 |
| UPDATE_CLUSTER_FORBIDDEN | 集群不可执行更新操作 | 451 | 集群不可执行更新操作 |
| CLUSTER_PUBLIC_IP_DISABLED | 集群未开启公网访问 | 451 | 集群未开启公网访问 |
| CLUSTER_PUBLIC_IP_ENABLED | 集群已开启公网访问 | 451 | 集群已开启公网访问 |
| CLUSTER_PUBLIC_IP_BANDWIDTH_ILLEGAL | 公网带宽参数错误 | 451 | 公网带宽参数错误 |
| CLUSTER_AUTHENTICATION_MODE_ILLEGAL | 集群认证模式错误 | 451 | 集群认证模式错误 |
| UPDATE_CLUSTER_ORDER_FAILED | 集群更新下单失败 | 451 | 集群更新下单失败 |
| INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
PUT http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/eips/switch
Authorization: bce-auth-v1/ALTAKaiKeDfBD880eMWBE5oIGE/2023-05-08T11:43:45Z/1800/host;x-bce-date/322f3f98ce57d296c0f5abc64e5554b640ea035c5cb462fcaeab54b9810a3c61
Host: kafka-api.bj.baidubce.com
{
"publicIpEnabled": true,
"publicIpBandwidth": 5,
"couponIds": [
"xxxxx"
]
}返回示例
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
{
"clusterId": "33a168bb70c0459787416077114ab233",
"jobId": "16411be300de729baaee9b4dc3f0e4cd"
}