文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（吉隆坡区域）/ API说明/ 逻辑集群管理/ 编辑逻辑集群
更新时间：2025-09-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

编辑逻辑集群

功能介绍

编辑修改逻辑集群。接口根据提交的请求体判断当前操作是逻辑集群缩容或者扩容。

场景一：原始的逻辑集群有6个节点（两个环），提交请求时的请求体只有1个环，此时为逻辑集群缩容。

场景二：原始的逻辑集群有6个节点（两个环），提交请求时的请求体中有3个环，此时为逻辑集群扩容。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

cluster_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

logical_cluster_id

是

String

参数解释：

指定待编辑逻辑集群的ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

cluster_rings

是

Array of ClusterRing objects

参数解释：

逻辑集群编辑环列表信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

mode

否

String

参数解释：

重分布模式。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

waiting_for_killing

否

Integer

参数解释：

查杀作业等待时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 ClusterRing

参数

是否必选

参数类型

描述

ring_hosts

是

Array of RingHost objects

参数解释：

集群主机信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

un_shrinkable_cluster_ring

否

Boolean

参数解释：

是否可以缩容。

约束限制：

不涉及。

取值范围：

false|true。

默认取值：

不涉及。
表4 RingHost

参数

是否必选

参数类型

描述

host_name

是

String

参数解释：

主机名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

back_ip

是

String

参数解释：

后端IP地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cpu_cores

是

Integer

参数解释：

主机CPU核数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

memory

是

Double

参数解释：

主机内存。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

disk_size

是

Double

参数解释：

主机磁盘大小。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

请求示例

提交逻辑集群缩容请求，操作后逻辑集群只有1个环（3个节点）。

PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-clusters/0b494d0d-8431-4c4f-8a06-2cc42d0d0c7d

{
  "cluster_rings" : [ {
    "ring_hosts" : [ {
      "host_name" : "host-172-16-20-246",
      "back_ip" : "172.16.73.90",
      "cpu_cores" : 8,
      "memory" : 32.0,
      "disk_size" : 800.0
    }, {
      "host_name" : "host-172-16-4-26",
      "back_ip" : "172.16.123.5",
      "cpu_cores" : 8,
      "memory" : 32.0,
      "disk_size" : 800.0
    }, {
      "host_name" : "host-172-16-43-90",
      "back_ip" : "172.16.92.175",
      "cpu_cores" : 8,
      "memory" : 32.0,
      "disk_size" : 800.0
    } ]
  } ],
  "mode" : null,
  "waiting_for_killing" : 0
}

响应示例

状态码：200

编辑逻辑集群请求提交成功。

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

状态码

状态码

描述

200

编辑逻辑集群请求提交成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

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