更新时间:2025-07-23 GMT+08:00
分享

创建集群前检查

功能介绍

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

调用方法

请参见如何调用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

创建集群预检查成功

{ }

SDK代码示例

SDK代码示例如下。

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

 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
65
66
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.*;

import java.util.List;
import java.util.ArrayList;

public class CheckClusterSolution {

    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");
        String projectId = "{project_id}";

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        CheckClusterRequest request = new CheckClusterRequest();
        ClusterCheckRequestBody body = new ClusterCheckRequestBody();
        OpenPublicIp publicIpCluster = new OpenPublicIp();
        publicIpCluster.withPublicBindType("bind_existing")
            .withEipId("1923e8b0-cd40-4469-8cb1-64546c7b530c");
        List<String> listClusterAvailabilityZones = new ArrayList<>();
        listClusterAvailabilityZones.add("cn-north-7c");
        ClusterCheckBody clusterbody = new ClusterCheckBody();
        clusterbody.withFlavor("dws.m3.xlarge")
            .withAvailabilityZones(listClusterAvailabilityZones)
            .withNumNode(3)
            .withSecurityGroupId("f54a4572-d5d2-40b6-823a-79049bd5b71c")
            .withDatastoreVersion("8.2.0")
            .withVpcId("c9f1171e-dc90-4ae9-bf22-f9736983ce2d")
            .withSubnetId("ad9ef23f-1d03-4e52-af80-69604645e109")
            .withPublicIp(publicIpCluster);
        body.withCluster(clusterbody);
        request.withBody(body);
        try {
            CheckClusterResponse response = client.checkCluster(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());
        }
    }
}

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

 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
# coding: utf-8

import os
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.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CheckClusterRequest()
        publicIpCluster = OpenPublicIp(
            public_bind_type="bind_existing",
            eip_id="1923e8b0-cd40-4469-8cb1-64546c7b530c"
        )
        listAvailabilityZonesCluster = [
            "cn-north-7c"
        ]
        clusterbody = ClusterCheckBody(
            flavor="dws.m3.xlarge",
            availability_zones=listAvailabilityZonesCluster,
            num_node=3,
            security_group_id="f54a4572-d5d2-40b6-823a-79049bd5b71c",
            datastore_version="8.2.0",
            vpc_id="c9f1171e-dc90-4ae9-bf22-f9736983ce2d",
            subnet_id="ad9ef23f-1d03-4e52-af80-69604645e109",
            public_ip=publicIpCluster
        )
        request.body = ClusterCheckRequestBody(
            cluster=clusterbody
        )
        response = client.check_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)

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

 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")
    projectId := "{project_id}"

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

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CheckClusterRequest{}
	publicBindTypePublicIp:= "bind_existing"
	eipIdPublicIp:= "1923e8b0-cd40-4469-8cb1-64546c7b530c"
	publicIpCluster := &model.OpenPublicIp{
		PublicBindType: &publicBindTypePublicIp,
		EipId: &eipIdPublicIp,
	}
	var listAvailabilityZonesCluster = []string{
        "cn-north-7c",
    }
	securityGroupIdCluster:= "f54a4572-d5d2-40b6-823a-79049bd5b71c"
	clusterbody := &model.ClusterCheckBody{
		Flavor: "dws.m3.xlarge",
		AvailabilityZones: listAvailabilityZonesCluster,
		NumNode: int32(3),
		SecurityGroupId: &securityGroupIdCluster,
		DatastoreVersion: "8.2.0",
		VpcId: "c9f1171e-dc90-4ae9-bf22-f9736983ce2d",
		SubnetId: "ad9ef23f-1d03-4e52-af80-69604645e109",
		PublicIp: publicIpCluster,
	}
	request.Body = &model.ClusterCheckRequestBody{
		Cluster: clusterbody,
	}
	response, err := client.CheckCluster(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

创建集群预检查成功

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

相关文档