创建集群V2
功能介绍
该接口用于创建集群。
集群必须要运行在VPC之内,创建集群前,您需要先创建VPC,并获取VPC和子网的id。
该接口为异步接口,创建集群需要10~15分钟。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/clusters
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cluster | 否 | V2CreateCluster object | 参数解释: V2接口创建集群请求体。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 集群名称,要求唯一性。 约束限制: 不涉及。 取值范围: 要求唯一性,必须以字母开头并只包含字母、数字、中划线或下划线,长度为4~64个字符。 默认取值: 不涉及。 |
| flavor | 是 | String | 参数解释: 集群规格编码。 约束限制: 不涉及。 取值范围: 请参见集群规格接口返回的规格编码。 默认取值: 不涉及。 |
| num_cn | 否 | Integer | 参数解释: 集群CN数量。 约束限制: 不涉及。 取值范围: 取值范围为2~集群节点数,最大值为20,默认值为3。 默认取值: 不涉及。 |
| num_node | 是 | Integer | 参数解释: 集群节点数量。 约束限制: 不涉及。 取值范围: 集群模式取值范围为3~256。 默认取值: 不涉及。 |
| db_name | 是 | String | 参数解释: 管理员用户名称。 约束限制: 不涉及。 取值范围: 只能由小写字母、数字或下划线组成。 必须由小写字母或下划线开头。 长度为1~63个字符。 用户名不能为DWS数据库的关键字。 默认取值: 不涉及。 |
| db_password | 是 | String | 参数解释: 管理员用户密码。 约束限制: 不涉及。 取值范围: 12~32个字符; 至少包含以下字符中的3种:大写字母、小写字母、数字和特殊字符(~!?,.:;-_(){}[]/<>@#%^&*+|=)。 不能与用户名或倒序的用户名相同。 默认取值: 不涉及。 |
| db_port | 是 | Integer | 参数解释: 集群数据库端口。 约束限制: 不涉及。 取值范围: 8000~30000 默认取值: 8000 |
| dss_pool_id | 否 | String | 参数解释: 专属存储池ID,一般不需要填写。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
| availability_zones | 是 | Array of strings | 参数解释: 可用区信息,创建3AZ集群时需传入3个不同可用区。 约束限制: 不涉及。 取值范围: 获取方法请参见查询可用区列表接口。 默认取值: 不涉及。 |
| tags | 否 | Array of Tags objects | 参数解释: 标签信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| vpc_id | 是 | String | 参数解释: 指定虚拟私有云ID,用于集群网络配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| subnet_id | 是 | String | 参数解释: 指定子网ID,用于集群网络配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| security_group_id | 否 | String | 参数解释: 指定安全组ID,用于集群网络配置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| public_ip | 否 | PublicIp object | 参数解释: 公网IP地址,如果未指定,则默认不使用公网连接。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| datastore_version | 是 | String | 参数解释: 集群版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| master_key_id | 否 | String | 参数解释: KMS密钥ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| master_key_name | 否 | String | 参数解释: KMS密钥名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| crypt_algorithm | 否 | String | 参数解释: KMS加密算法。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| volume | 是 | Volume object | 参数解释: 磁盘信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| enterprise_project_id | 否 | String | 参数解释: 企业项目ID,对集群指定企业项目。如果未指定,则使用默认企业项目“default”的ID,即0。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0 |
| ipv6_enable | 否 | Boolean | 参数解释: 指定网络协议类型,表明是否支持IPv6,默认不使用IPv6。使用ipv6时必须所选择的子网也支持ipv6。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签的键。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| value | 是 | String | 参数解释: 标签的值。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| public_bind_type | 否 | String | 参数解释: 弹性IP绑定类型。 约束限制: 不涉及。 取值范围: auto_assign:自动绑定。 not_use:暂未使用。 bind_existing :使用已有。 默认取值: null |
| eip_id | 否 | String | 参数解释: 弹性公网IP的id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
| ip_type | 否 | String | 参数解释: 弹性公网IP的类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
| eip_address | 否 | String | 参数解释: 弹性公网IP的地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
| band_width | 否 | Integer | 参数解释: 弹性公网IP的带宽。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
| status | 否 | String | 参数解释: 弹性公网IP的状态。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
| error_message | 否 | String | 参数解释: 弹性公网IP的错误码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
请求示例
创建多AZ DWS集群,集群版本为8.2.1,可用区是az1和az2,节点规格为dws.m1.xlarge.ultrahigh,3节点,SSD磁盘,容量为100GB,数据库端口为8000,带公网IP,安全组ID,子网ID,虚拟私有云ID。
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters
{
"cluster" : {
"flavor" : "dws.m1.xlarge.ultrahigh",
"num_node" : 3,
"subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
"security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
"vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
"db_port" : 8000,
"datastore_version" : "8.2.1",
"availability_zones" : [ "az1", "az2" ],
"name" : "dws-1",
"num_cn" : 3,
"db_name" : "dbadmin",
"db_password" : "Passw0rd!",
"public_ip" : {
"public_bind_type" : "auto_assign",
"eip_id" : ""
},
"volume" : {
"volume" : "SSD",
"capacity" : 100
},
"enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada"
}
} 响应示例
状态码:200
创建集群请求发起成功。
{
"cluster" : {
"id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建集群请求发起成功。 |
| 400 | 请求错误。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 500 | 服务内部错误。 |
| 503 | 服务不可用。 |