更新时间:2025-09-18 GMT+08:00

集群缩容

功能介绍

该接口用于缩容集群。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/cluster-shrink

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

cluster_id

String

参数解释

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

约束限制

必须是有效的dws集群ID。

取值范围

36位UUID。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

shrink_number

Integer

参数解释

缩容节点个数。

约束限制

该值不能为空。

取值范围

大于0的整数。

默认取值

不涉及。

online

Boolean

参数解释

是否是在线缩容。

约束限制

不涉及。

取值范围

false|true。

默认取值

false。

retry

Boolean

参数解释

是否是缩容失败后重试。

约束限制

不涉及。

取值范围

false|true。

默认取值

false。

need_agency

Boolean

参数解释

是否需要委托。

约束限制

不涉及。

取值范围

false或true。

默认取值

false。

parallel_jobs

Integer

参数解释

重分布并发配置数。

约束限制

不涉及。

取值范围

1~200。

默认取值

4。

type

String

参数解释

类型字段,字段已废弃不再生效。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

force_backup

Boolean

参数解释

操作前是否执行备份,字段已废弃不再生效。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

job_id

String

参数解释

缩容的任务ID信息。

取值范围

不涉及。

请求示例

离线缩容ID为“4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90”的标准数仓集群3个节点,并执行创建委托。

POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink

{
  "shrink_number" : 3,
  "online" : false,
  "retry" : false,
  "need_agency" : true,
  "parallel_jobs" : 2
}

响应示例

状态码:200

缩容请求提交成功。

{
  "job_id" : "2c9081c88418ed420184197c8bc80001"
}

状态码

状态码

描述

200

缩容请求提交成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。