更新时间:2022-07-29 GMT+08:00

创建集群

功能介绍

该接口用于创建集群。

集群必须要运行在VPC之内,创建集群前,您需要先创建VPC,并获取VPC和子网的id。

该接口为异步接口,创建集群需要10~15分钟。

调用创建集群接口目前只支持创建标准数仓类型。

URI

  • URI 格式
    POST /v1.0/{project_id}/clusters
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

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

请求消息

  • 请求样例
    POST /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters
    
    {
    "cluster": {
            "node_type":  "dws.d1.xlarge.ultrahigh",
            "number_of_node": 3,
            "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
            "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
            "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
            "availability_zone": "eu-west-0a",
            "port": 8000,
            "name": "dws-1",
            "user_name": "dbadmin",
            "user_pwd": "Password!",
            "public_ip": {
                "public_bind_type": "auto_assign",
                "eip_id": ""
            }
        }
    }
  • 参数说明
    表2 请求参数说明

    参数

    是否必选

    参数类型

    描述

    cluster

    CreateClusterInfo object

    集群对象

    表3 CreateClusterInfo

    参数

    是否必选

    参数类型

    描述

    node_type

    String

    节点类型。

    number_of_node

    Integer

    集群节点数量,取值范围为2~256。

    subnet_id

    String

    指定子网ID,用于集群网络配置。

    security_group_id

    String

    指定安全组ID,用于集群网络配置。

    vpc_id

    String

    指定虚拟私有云ID,用于集群网络配置。

    availability_zone

    String

    配置集群可用区。

    port

    Integer

    集群服务端口,取值范围为8000~30000,默认值:8000。

    name

    String

    集群名称,要求唯一性,必须以字母开头并只包含字母、数字、中划线或下划线,长度为4~64个字符。

    user_name

    String

    DWS集群管理员用户名。用户命名要求如下:

    • 只能由小写字母、数字或下划线组成。
    • 必须以小写字母或下划线开头。
    • 长度为1~63个字符。
    • 用户名不能为DWS数据库的关键字。

    user_pwd

    String

    DWS集群管理员密码。

    public_ip

    PublicIp object

    公网IP地址,如果未指定,则默认不使用公网连接。

    number_of_cn

    Integer

    CN部署量,取值范围为2~集群节点数-1,最大值为20,默认值为3。

    enterprise_project_id

    String

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

    表4 PublicIp

    参数

    是否必选

    参数类型

    描述

    public_bind_type

    String

    弹性IP绑定类型,取值如下:

    • auto_assign:现在购买
    • not_use:暂不使用
    • bind_existing :使用已有

    eip_id

    String

    弹性IP的id

响应消息

  • 响应样例
    {
        "cluster": {
            "id": "7d85f602-a948-4a30-afd4-e84f47471c15"
         }
    }
  • 参数说明
    表5 响应参数参数

    参数

    参数类型

    描述

    cluster

    Cluster object

    集群对象

    表6 Cluster

    参数

    参数类型

    描述

    id

    String

    集群ID

状态码

  • 正常

    200

  • 异常
    表7 返回值说明

    返回值

    描述

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。