更新时间:2025-12-10 GMT+08:00

集群扩容前检查

功能介绍

集群扩容前检查,提前识别子网不足、权限不足等问题导致的扩容失败。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/clusters/{cluster_id}/grow-check

表1 路径参数

参数

是否必选

参数类型

描述

cluster_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

scale_out

是

ScaleOut object

参数解释:

扩容/添加空闲节点操作,节点信息请求体。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

logical_cluster_name

否

String

参数解释:

逻辑集群名字,扩容到逻辑集群时,需要填写。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

create_node_only

否

Boolean

参数解释:

当前是否仅添加空闲节点。

约束限制:

不涉及。

取值范围:

true:仅添加节点,如需扩容则需要单独操作

false:添加节点并扩容集群

默认取值:

false

waiting_for_killing

否

Integer

参数解释:

自动查杀作业等待时间。

约束限制:

guestAgent插件版本8.2.1及以上才支持。

取值范围:

30~1200

默认取值:

0,即不限制。

auto_redistribute

否

Boolean

参数解释:

扩容完成后是否自动启动重分布,默认是。如果设置为false,扩容后不进行重分布,此时集群任务信息处于“待重分布”状态,无法进行其他操作。

约束限制:

不涉及。

取值范围:

true:扩容后立即重分布。

false:扩容后不进行重分布,此时集群任务信息处于“待重分布”状态。

默认取值:

true

表3 ScaleOut

参数

是否必选

参数类型

描述

count

是

Integer

参数解释:

扩容节点数。

取值范围:

大于等于3。

subnet_id

否

String

参数解释:

子网ID。

取值范围:

同VPC下有效的子网ID。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Array of GrowCheckResult objects

参数解释:

扩容前检查信息。

取值范围:

不涉及。

note

NoteInfo object

参数解释:

扩容前提示信息。

取值范围

不涉及。

表5 GrowCheckResult

参数

参数类型

描述

pass

Boolean

参数解释:

检查是否通过,检查通过项默认不展示。

取值范围:

true/false

reason

String

参数解释:

检查不通过的原因描述。

取值范围:

不涉及。

required

Boolean

参数解释:

是否必须检查项。

取值范围:

  • true:必须,校验不通过时不允许扩容,继续扩容也会失败

  • false:非必须,校验不通过时允许扩容,仅做提示告知风险

desc

String

参数解释:

描述信息。

取值范围:

不涉及。

type

String

参数解释:

分类。

取值范围:

配额、权限、版本、状态

表6 NoteInfo

参数

参数类型

描述

bucket_split_info

BucketSplitInfo object

参数解释:

桶分裂信息,仅在从集群外部扩容到已有的逻辑集群场景下才会返回。

取值范围:

不涉及。

表7 BucketSplitInfo

参数

参数类型

描述

current_dn_num

Integer

参数解释:

当前DN数。

取值范围:

不涉及。

after_scale_out_dn_num

Integer

参数解释:

扩容后DN数。

取值范围:

不涉及。

current_bucket_num

Integer

参数解释:

当前bucket数。

取值范围:

不涉及。

after_scale_out_bucket_num

Integer

参数解释:

扩容后bucket数。

取值范围:

不涉及。

is_bucket_split

Boolean

参数解释:

扩容是否涉及bucket分裂。

取值范围:

不涉及。

bucket_tilt_rate

String

参数解释:

bucket DN倾斜率,用于衡量bucket在DN节点上不均衡程度。

取值范围:

不涉及。

after_scale_out_bucket_tilt_rate

String

参数解释:

扩容后 bucket DN倾斜率,用于衡量扩容后bucket在DN节点上不均衡程度。

取值范围:

不涉及。

请求示例

扩容集群新增3节点,检查是否存在配额或权限等问题。

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/grow-check

{
  "scale_out" : {
    "count" : 3
  }
}

响应示例

状态码:200

请求下发成功。

{
  "note" : {
    "bucket_split_info" : {
      "current_dn_num" : 6,
      "after_scale_out_bucket_num" : 32,
      "is_bucket_split" : false,
      "after_scale_out_dn_num" : 9,
      "bucket_tilt_rate" : "16.67%",
      "after_scale_out_bucket_tilt_rate" : "25.00%"
    }
  },
  "data" : [ {
    "pass" : false,
    "reason" : "子网IP超过配额:需要量 3,使用量 249 / 251",
    "required" : true,
    "desc" : "子网IP检查",
    "type" : "配额"
  } ]
}

状态码

状态码

描述

200

请求下发成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。