更新时间:2024-05-17 GMT+08:00

创建集群

功能介绍

该接口用于创建集群。

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

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

调用方法

请参见如何调用API

URI

1
POST /v1.0/{project_id}/clusters
表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

cluster

CreateClusterInfo object

集群对象。

表3 CreateClusterInfo

参数

是否必选

参数类型

描述

node_type

String

节点类型。节点类型详情请参见数据仓库规格

number_of_node

Integer

集群节点数量,集群模式取值范围为3~256,实时数仓(单机模式)取值为1。

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集群管理员用户名。用户命名要求如下:

  • 只能由小写字母、数字或下划线组成。

  • 必须由小写字母或下划线开头。

  • 长度为6~64个字符。

  • 用户名不能为DWS数据库的关键字。

user_pwd

String

DWS集群管理员密码。

  • 12~32个字符
  • 至少包含以下字符中的3种:大写字母、小写字母、数字和特殊字符(~!?,.:;-_(){}[]/<>@#%^&*+|\=)。
  • 不能与用户名或倒序的用户名相同。
    说明:

    认证用的AK和SK硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。

public_ip

PublicIp object

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

number_of_cn

Integer

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

tags

Tags object

标签。

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。

表5 Tags

参数

是否必选

参数类型

描述

key

String

键。输入标签键的最大长度为128个unicode字符,不能为空字符串,且首尾字符不能为空格。 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 只能包含大写字母(A-Z)、小写字母(a-z)、数字(0-9)和特殊字符(中划线-、下划线_)以及中文字符。

value

String

值。输入标签值的最大长度为255个字符,首尾字符不能为空格,可以为空字符串。 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 只能包含大写字母(A-Z)、小写字母(a-z)、数字(0-9)和特殊字符(中划线-、下划线_)以及中文字符。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

cluster

Cluster object

集群对象。

表7 Cluster

参数

参数类型

描述

id

String

集群ID。

请求示例

创建DWS集群,可用区为az1.dc1,节点规格为dws.m1.xlarge.ultrahigh,3节点,数据库端口8000,带公网IP,安全组ID,子网ID,虚拟私有云ID:

POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters

{
  "cluster" : {
    "node_type" : "dws.m1.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" : "az1.dc1",
    "port" : 8000,
    "name" : "dws-1",
    "user_name" : "dbadmin",
    "user_pwd" : "Passw0rd!",
    "public_ip" : {
      "public_bind_type" : "auto_assign",
      "eip_id" : ""
    },
    "enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada"
  }
}

响应示例

状态码: 200

创建集群成功。

{
  "cluster" : {
    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
  }
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class CreateClusterSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        CreateClusterRequest request = new CreateClusterRequest();
        CreateClusterRequestBody body = new CreateClusterRequestBody();
        PublicIp publicIpCluster = new PublicIp();
        publicIpCluster.withPublicBindType("auto_assign")
            .withEipId("");
        CreateClusterInfo clusterbody = new CreateClusterInfo();
        clusterbody.withNodeType("dws.m1.xlarge.ultrahigh")
            .withNumberOfNode(3)
            .withSubnetId("374eca02-cfc4-4de7-8ab5-dbebf7d9a720")
            .withSecurityGroupId("dc3ec145-9029-4b39-b5a3-ace5a01f772b")
            .withVpcId("85b20d7e-9eb7-4b2a-98f3-3c8843ea3574")
            .withAvailabilityZone("az1.dc1")
            .withPort(8000)
            .withName("dws-1")
            .withUserName("dbadmin")
            .withUserPwd("Passw0rd!")
            .withPublicIp(publicIpCluster)
            .withEnterpriseProjectId("aca4e50a-266f-4786-827c-f8d6cc3fbada");
        body.withCluster(clusterbody);
        request.withBody(body);
        try {
            CreateClusterResponse response = client.createCluster(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CreateClusterRequest()
        publicIpCluster = PublicIp(
            public_bind_type="auto_assign",
            eip_id=""
        )
        clusterbody = CreateClusterInfo(
            node_type="dws.m1.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="az1.dc1",
            port=8000,
            name="dws-1",
            user_name="dbadmin",
            user_pwd="Passw0rd!",
            public_ip=publicIpCluster,
            enterprise_project_id="aca4e50a-266f-4786-827c-f8d6cc3fbada"
        )
        request.body = CreateClusterRequestBody(
            cluster=clusterbody
        )
        response = client.create_cluster(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CreateClusterRequest{}
	eipIdPublicIp:= ""
	publicIpCluster := &model.PublicIp{
		PublicBindType: "auto_assign",
		EipId: &eipIdPublicIp,
	}
	availabilityZoneCluster:= "az1.dc1"
	portCluster:= int32(8000)
	enterpriseProjectIdCluster:= "aca4e50a-266f-4786-827c-f8d6cc3fbada"
	clusterbody := &model.CreateClusterInfo{
		NodeType: "dws.m1.xlarge.ultrahigh",
		NumberOfNode: int32(3),
		SubnetId: "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
		SecurityGroupId: "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
		VpcId: "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
		AvailabilityZone: &availabilityZoneCluster,
		Port: &portCluster,
		Name: "dws-1",
		UserName: "dbadmin",
		UserPwd: "Passw0rd!",
		PublicIp: publicIpCluster,
		EnterpriseProjectId: &enterpriseProjectIdCluster,
	}
	request.Body = &model.CreateClusterRequestBody{
		Cluster: clusterbody,
	}
	response, err := client.CreateCluster(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

创建集群成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

500

服务内部错误。

503

服务不可用。