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.

{ }

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.