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

创建集群前检查

功能介绍

创建集群前预检查，提前识别子网不足、配额不足等问题，避免发起创建集群请求后创建失败。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/cluster-precheck

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

cluster

是

ClusterCheckBody object

参数解释：

集群校验对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 ClusterCheckBody

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释：

企业项目ID，对集群指定企业项目。如果未指定，则使用默认企业项目“default”的ID，即0。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0

flavor

是

String

参数解释：

集群规格名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

availability_zones

是

Array of strings

参数解释：

可用区列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

num_node

是

Integer

参数解释：

实例节点个数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

security_group_id

否

String

参数解释：

安全组ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

datastore_version

是

String

参数解释：

集群版本。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

vpc_id

是

String

参数解释：

集群虚拟私有云ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

subnet_id

是

String

参数解释：

集群子网ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

public_ip

否

OpenPublicIp object

参数解释：

弹性IP对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

null

cross_spec_restore

否

String

参数解释：

跨规格恢复信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

null

volume

否

Volume object

参数解释：

磁盘信息对象。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

null

old_cluster_hostname

否

String

参数解释：

旧主机名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

null

restore_point

否

RestorePoint object

参数解释：

恢复集群相关对象信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

null

tag_list

否

Array of Tag objects

参数解释：

标签列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

null

dss_pool_id

否

String

参数解释：

存储池ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

null

db_port

否

String

参数解释：

数据库端口。

约束限制：

不涉及。

取值范围：

8000~30000

默认取值：

8000

db_password

否

String

参数解释：

管理员密码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

db_name

否

String

参数解释：

管理员用户。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

dbadmin

num_cn

否

Integer

参数解释：

cn节点数量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

集群名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 OpenPublicIp

参数

是否必选

参数类型

描述

public_bind_type

否

String

参数解释：

弹性IP绑定类型。

约束限制：

不涉及。

取值范围：

  • auto_assign：自动绑定

  • not_use：暂未使用

  • bind_existing ：使用已有

默认取值：

不涉及。

eip_id

否

String

参数解释：

弹性IP的ID

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 Volume

参数

是否必选

参数类型

描述

volume

是

String

参数解释：

磁盘名称。

约束限制：

不涉及。

取值范围：

  • SSD：超高IO

  • SAS：高IO

  • SATA：普通IO

默认取值：

不涉及。

capacity

否

Integer

参数解释：

磁盘容量，单位：GB。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表6 RestorePoint

参数

是否必选

参数类型

描述

back_ref

否

String

参数解释：

快照ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

restore_time

否

Long

参数解释：

恢复时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_id

否

String

参数解释：

原始集群ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表7 Tag

参数

是否必选

参数类型

描述

key

否

String

参数解释：

标签的键。

约束限制：

不涉及。

取值范围：

  • 输入标签键的最大长度为128个unicode字符，不能为空字符串，且首尾字符不能为空格；

  • 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”；

  • 只能包含大写字母（A-Z）、小写字母（a-z）、数字（0-9）和特殊字符（中划线-、下划线_）以及中文字符；

默认取值：

不涉及。

value

否

String

参数解释：

标签的值。

约束限制：

不涉及。

取值范围：

  • 输入标签值的最大长度为256个字符，首尾字符不能为空格，可以为空字符串。

  • 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

  • 只能包含大写字母（A-Z）、小写字母（a-z）、数字（0-9）和特殊字符（中划线-、下划线_）以及中文字符。

默认取值：

不涉及。

响应参数

状态码：200

创建集群预检查成功

无

请求示例

创建集群操作前检查是否具备创建条件，比如在cn-north-7c可用区下是否有dws.m3.xlarge规格、3节点、公网IP、安全组、虚拟私有云等创建条件。

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/cluster-precheck

{
  "cluster" : {
    "flavor" : "dws.m3.xlarge",
    "num_node" : 3,
    "availability_zones" : [ "cn-north-7c" ],
    "vpc_id" : "c9f1171e-dc90-4ae9-bf22-f9736983ce2d",
    "subnet_id" : "ad9ef23f-1d03-4e52-af80-69604645e109",
    "security_group_id" : "f54a4572-d5d2-40b6-823a-79049bd5b71c",
    "public_ip" : {
      "public_bind_type" : "bind_existing",
      "eip_id" : "1923e8b0-cd40-4469-8cb1-64546c7b530c"
    },
    "datastore_version" : "8.2.0"
  }
}

响应示例

状态码：200

创建集群预检查成功

{ }

状态码

状态码

描述

200

创建集群预检查成功

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

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