文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（阿布扎比区域）/ API说明/ 逻辑集群管理/ 切换逻辑集群开关
更新时间：2025-09-23 GMT+08:00
在线调试
CLI示例
查看PDF
分享

切换逻辑集群开关

功能介绍

切换逻辑集群开关，仅用于控制逻辑集群相关功能模块是否在页面展示。

在集群已经是逻辑集群的场景下，修改该接口无任何作用及影响。

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/clusters/{cluster_id}/logical-clusters/enable

表1 路径参数

参数

是否必选

参数类型

描述

cluster_id

是

String

参数解释：

集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

enable

是

Boolean

参数解释：

切换逻辑集群开关请求。

约束限制：

不涉及。

取值范围：

true：打开开关

false：关闭开关

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

请求示例

切换逻辑集群开关。

PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-clusters/enable

{
  "enable" : true
}

响应示例

状态码：200

切换集群开关成功。

{
  "error_code" : "DWS.0000",
  "error_msg" : null
}

状态码

状态码

描述

200

切换集群开关成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。
父主题： 逻辑集群管理