更新时间:2026-01-12 GMT+08:00

为集群打开或关闭负载均衡器

功能介绍

该接口为集群打开或关闭负载均衡器

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定更改的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

enable

Boolean

参数解释

打开或关闭es负载均衡器。

约束限制

不涉及

取值范围

  • true:开启。

  • false:关闭。

默认取值

不涉及

agency

String

参数解释

用于配置负载均衡的委托名称,当enable为true时必选。

约束限制

不涉及

取值范围

不涉及

默认值

不涉及

elb_id

String

参数解释

负载均衡器ID,当enable为true时必选。

约束限制

不涉及

取值范围

不涉及

默认值

不涉及

type

String

参数解释

负载均衡器类型。当用于可观测集群时:不需要配置此参数。

约束限制

不涉及

取值范围

  • searchTool:打开或关闭Elasticsearch/Opensearch负载均衡器。

  • viewTool:打开或关闭Kibana/Opensearch Dashboard负载均衡器。

默认值

searchTool

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

elb_id

String

负载均衡器ID。

请求示例

开启负载均衡器。

POST https://{Endpoint}/v1.0/{project_id}/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/loadbalancers/es-switch

{
  "enable" : true,
  "elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
  "agency" : "css_elb_agency"
}

响应示例

状态码:200

请求已成功。

{
  "elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268"
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码