Help Center/ GaussDB(DWS)/ API Reference/ API Description/ Cluster Management/ Performing a Check Before Cluster Creation
Updated on 2024-04-18 GMT+08:00

Performing a Check Before Cluster Creation

Function

This API is used to perform a check before creating a cluster.

Call Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/cluster-precheck
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

cluster

Yes

ClusterCheckBody object

Cluster verification object.

Table 3 ClusterCheckBody

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID

flavor

Yes

String

Cluster specification name

availability_zones

Yes

Array of strings

List of AZs.

num_node

Yes

Integer

Number of instance nodes.

security_group_id

No

String

Security group ID

datastore_version

Yes

String

Cluster version

vpc_id

Yes

String

VPC ID

subnet_id

Yes

String

Subnet ID

public_ip

No

OpenPublicIp object

EIP

cross_spec_restore

No

String

Cross-specification restoration

volume

No

Volume object

Disk

old_cluster_hostname

No

String

Name of the old host

restore_point

No

RestorePoint object

Restoration pointer

tag_list

No

Array of Tag objects

Tag list

dss_pool_id

No

String

Storage pool ID

db_port

No

String

Database port

db_password

No

String

Administrator password

db_name

No

String

Administrator username

num_cn

No

Integer

Number of CNs

name

No

String

Cluster name

Table 4 OpenPublicIp

Parameter

Mandatory

Type

Description

public_bind_type

No

String

Binding type of an EIP. The value can be one of the following:

  • auto_assign
  • not_use
  • bind_existing

eip_id

No

String

EIP ID

Table 5 Volume

Parameter

Mandatory

Type

Description

volume

No

String

Disk name. The options are as follows:

  • SSD: Ultra-high I/O
  • High I/O (SAS)
  • Common I/O (SATA)

capacity

No

Integer

Disk capacity

Table 6 RestorePoint

Parameter

Mandatory

Type

Description

back_ref

No

String

Snapshot ID

restore_time

No

Long

Recovery time

cluster_id

No

String

Cluster ID

Table 7 Tag

Parameter

Mandatory

Type

Description

key

No

String

Tag key

value

No

String

Tag value

Response Parameters

None

Example Request

Check the conditions for creating a cluster. 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 Response

None

SDK Sample Code

The sample code is as follows:

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

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");

        ICredential auth = new BasicCredentials()
                .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());
        }
    }
}
 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
# 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("<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)
 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
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("<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 more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The check before cluster creation is successful.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.