文档首页/ 云搜索服务 CSS/ 更多文档/ API参考（联盟区域）/ API V1/ 集群管理/ 安全模式修改
更新时间：2026-01-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

安全模式修改

功能介绍

该接口用于切换集群的安全模式。集群安全模式主要分为：

  • 安全模式+HTTP协议的集群：适合对安全性有一定要求，但对性能要求较高的场景。建议确认访问环境的安全性，勿将访问接口暴露到公网环境上。

  • 安全模式+HTTPS协议的集群：适合对安全性和数据传输加密要求较高、且需要公网访问的场景。

调用方法

请参见如何调用API。

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/mode/change

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

指定操作的集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

authority_enable

是

Boolean

参数解释：

集群是否开启安全模式。

约束限制：

Elasticsearch安全集群只有6.5.4及之后版本支持。

取值范围：

  • true: 开启安全模式。

  • false: 关闭安全模式。

默认取值：

true

admin_pwd

否

String

参数解释：

安全模式下集群密码。

约束限制：

Elasticsearch安全集群只有6.5.4及之后版本支持。

取值范围：

不涉及

默认取值：

不涉及

https_enable

是

Boolean

参数解释：

集群是否开启HTTPS。

约束限制：

  • Elasticsearch安全集群：只有6.5.4及之后版本支持。

  • OpenSearch安全集群：只有1.3.6和2.19.0版本支持关闭HTTPS访问，其他版本均强制启用HTTPS访问，不可关闭。

  • true: 开启HTTPS。

  • false: 关闭HTTPS。

取值范围：

默认取值：

true

响应参数

状态码：200

请求已成功。

无

请求示例

修改当前集群安全模式。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/mode/change

{
  "authority_enable" : true,
  "admin_pwd" : "admin@1234",
  "https_enable" : true
}

响应示例

无

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

404

所请求的资源不存在。

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

错误码

请参见错误码。

父主题： 集群管理