Help Center/ Data Warehouse Service/ API Reference/ API Description/ Cluster Management/ Performing a Check Before Cluster Creation
Updated on 2026-06-22 GMT+08:00

Performing a Check Before Cluster Creation

Function

This API is used to perform a pre-check before cluster creation. It can identify problems such as insufficient subnets and quotas in advance, preventing cluster creation failures.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/cluster-precheck

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

cluster

Yes

ClusterCheckBody object

Definition

Cluster verification object.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 ClusterCheckBody

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used.

Constraints

N/A

Range

N/A

Default Value

0

flavor

Yes

String

Definition

Cluster flavor name.

Constraints

N/A

Range

N/A

Default Value

N/A

availability_zones

Yes

Array of strings

Definition

AZ list.

Constraints

N/A

Range

N/A

Default Value

N/A

num_node

Yes

Integer

Definition

Number of instance nodes.

Constraints

N/A

Range

N/A

Default Value

N/A

security_group_id

No

String

Definition

Security group ID.

Constraints

N/A

Range

N/A

Default Value

N/A

datastore_version

Yes

String

Definition

Cluster version.

Constraints

N/A

Range

N/A

Default Value

N/A

vpc_id

Yes

String

Definition

VPC ID.

Constraints

N/A

Range

N/A

Default Value

N/A

subnet_id

Yes

String

Definition

Subnet ID of the cluster.

Constraints

N/A

Range

N/A

Default Value

N/A

public_ip

No

OpenPublicIp object

Definition

EIP object.

Constraints

N/A

Range

N/A

Default Value

null

cross_spec_restore

No

String

Definition

Cross-specification restoration information.

Constraints

N/A

Range

N/A

Default Value

null

volume

No

Volume object

Definition

Disk information object.

Constraints

N/A

Range

N/A

Default Value

null

old_cluster_hostname

No

String

Definition

Name of the old host.

Constraints

N/A

Range

N/A

Default Value

null

restore_point

No

RestorePoint object

Definition

Object about cluster restoration.

Constraints

N/A

Range

N/A

Default Value

null

tag_list

No

Array of Tag objects

Definition

Tag list.

Constraints

N/A

Range

N/A

Default Value

null

dss_pool_id

No

String

Definition

Storage pool ID.

Constraints

N/A

Range

N/A

Default Value

null

db_port

No

String

Definition

Database port.

Constraints

N/A

Range

8000 to 30000

Default Value

8000

db_password

No

String

Definition

Administrator password.

Constraints

N/A

Range

N/A

Default Value

N/A

db_name

No

String

Definition

Administrator account.

Constraints

N/A

Range

N/A

Default Value

dbadmin

num_cn

No

Integer

Definition

Number of CN nodes.

Constraints

N/A

Range

N/A

Default Value

N/A

name

No

String

Definition

Cluster name.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 OpenPublicIp

Parameter

Mandatory

Type

Description

public_bind_type

No

String

Definition

EIP binding type.

Constraints

N/A

Range

  • auto_assign

  • not_use: not use

  • bind_existing

Default Value

N/A

eip_id

No

String

Definition

EIP ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 Volume

Parameter

Mandatory

Type

Description

volume

Yes

String

Definition

Disk name.

Constraints

N/A

Range

  • SSD: Ultra-high I/O

  • SAS: High I/O

  • SATA: Common I/O

Default Value

N/A

capacity

No

Integer

Definition

Disk capacity in GB.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 6 RestorePoint

Parameter

Mandatory

Type

Description

back_ref

No

String

Definition

Snapshot ID.

Constraints

N/A

Range

N/A

Default Value

N/A

restore_time

No

Long

Definition

Restoration time.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

No

String

Definition

Original cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 7 Tag

Parameter

Mandatory

Type

Description

key

No

String

Definition

Tag key.

Constraints

N/A

Range

  • It can contain a maximum of 128 Unicode characters. It cannot be an empty string, and cannot start or end with a space.

  • It cannot contain the following characters: =*<>\,|/

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

Default Value

N/A

value

No

String

Definition

Tag value.

Constraints

N/A

Range

  • The value can contain a maximum of 256 characters and can be an empty string. It cannot start or end with a space.

  • It cannot contain the following characters: =*<>\,|/

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

Default Value

N/A

Response Parameters

Status code: 200

Pre-check for cluster creation succeeded.

None

Example Requests

Perform a check before cluster creation. For example, check whether the dws.m3.xlarge flavor, three nodes, public IP address, security group, and VPC are available in the AZ cn-north-7c.

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"
  }
}

Example Responses

Status code: 200

Pre-check for cluster creation succeeded.

{ }

SDK Sample Code

The SDK sample code is as follows.

Perform a check before cluster creation. For example, check whether the dws.m3.xlarge flavor, three nodes, public IP address, security group, and VPC are available in the AZ cn-north-7c.

 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());
        }
    }
}

Perform a check before cluster creation. For example, check whether the dws.m3.xlarge flavor, three nodes, public IP address, security group, and VPC are available in the AZ cn-north-7c.

 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)

Perform a check before cluster creation. For example, check whether the dws.m3.xlarge flavor, three nodes, public IP address, security group, and VPC are available in the AZ cn-north-7c.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Pre-check for cluster creation succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.