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

集群缩容前检查

功能介绍

缩容前检查，确保缩容前、缩容后均满足正常操作要求。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/clusters/{cluster_id}/shrink-check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_id

是

String

参数解释：

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

约束限制：

必须是有效的dws集群ID。

取值范围：

36位UUID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

check_item

是

String

参数解释：

检查项，取值当前仅包含3种。

约束限制：

不涉及。

取值范围：

guc：检查当前guc参数是否满足缩容条件。

schema：检查所有schema下有无影响缩容的表。

disk：检查缩容后磁盘容量是否满足要求。

默认取值：

不涉及。

shrink_count

是

Integer

参数解释：

待缩容节点数。

约束限制：

不涉及。

取值范围：

最小值为3，最大值为当前节点总数减3。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

is_passed

Boolean

参数解释：

检查是否通过。如不通过，需要调整缩容节点数重试，或者是当前集群就不满足缩容前置条件。

取值范围：

不涉及。

请求示例

  • 缩容3节点，检查项为guc参数。

    POST https://{Endpoint} /v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink-check?check_item=guc&shrink_count=3

  • 缩容3节点，检查项为schema。

    POST https://{Endpoint} /v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink-check?check_item=schema&shrink_count=3

  • 缩容3节点，检查项为磁盘信息。

    POST https://{Endpoint} /v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink-check?check_item=disk&shrink_count=3

响应示例

状态码：200

缩容前检查请求成功。

{
  "is_passed" : true
}

状态码

状态码

描述

200

缩容前检查请求成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。
父主题： 节点变更