CreateCluster - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Creates a pay-as-you-go or subscription Elastic High Performance Computing (E-HPC) cluster.

Operation description

Usage notes

Before you call this operation, make sure that you are familiar with the billing and pricing of E-HPC. For more information, see Overview .

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:CreateCluster	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterName	string	No	The cluster name. The name must be 1 to 128 characters in length and can contain letters, digits, hyphens (-), and underscores (_).	slurm22.05.8-cluster-20240718
ClusterDescription	string	No	The cluster description. The description must be 1 to 128 characters in length and can contain letters, digits, hyphens (-), and underscores (_).	slurm22.05.8-cluster-20240718
ClusterCategory	string	No	The cluster type. Valid values: Standard Serverless	Standard
ClusterVpcId	string	No	The ID of the virtual private cloud (VPC) in which the cluster resides.	vpc-m5efjevmclc0xdmys****
ClusterVSwitchId	string	No	The ID of the vSwitch that you want the cluster to use. The vSwitch must reside in the VPC that is specified by the `ClusterVpcId` parameter. You can call the DescribeVpcs operation to query information about the created VPCs and vSwitches.	vsw-f8za5p0mwzgdu3wgx****
IsEnterpriseSecurityGroup	boolean	No	Specifies whether to use an advanced security group. Valid values: true: automatically creates and uses an advanced security group. false: automatically creates and uses a basic security group. For more information, see Basic security groups and advanced security groups.	false
SecurityGroupId	string	No	The ID of the security group to which the cluster belongs. You can call the DescribeSecurityGroups operation to query available security groups in the current region.	sg-bp13n61xsydodfyg****
ClientVersion	string	No	The client version. By default, the latest version is used.	2.1.0
ClusterCustomConfiguration	object	No	The post-processing script of the cluster.
Script	string	No	The URL that is used to download the post-processing script.	http://*****
Args	string	No	The runtime parameters of the script after the cluster is created.	E-HPC cn-hangzhou
ClusterCredentials	object	No	The access credentials of the cluster.
KeyPairName	string	No	The name of the key pair. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain digits, letters, colons (:), underscores (_), and hyphens (-). Note For more information, see Create a key pair.	ali0824
Password	string	No	The password for the root user to log on to the node. The password must be 8 to 20 characters in length, and must contain at least 3 of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: `() ~ ! @ # $ % ^ & * - = + { } [ ] : ; ' < > , . ? /` Note We recommend that you use HTTPS to call the API operation to prevent password leakage.	**********
MaxCount	integer	No	The maximum number of compute nodes that the cluster can manage. Valid values: 0 to 5,000.	500
MaxCoreCount	integer	No	The maximum number of vCPUs that can be used by compute nodes in the cluster. Valid values: 0 to 100,000.	10000
DeletionProtection	boolean	No	Specifies whether to enable deletion protection for the cluster. Deletion protection decides whether the cluster can be deleted in the console or by calling the DeleteCluster operation. Valid values: true false Default value: false.	false
ResourceGroupId	string	No	The ID of the resource group to which the cluster belongs. You can call the ListResourceGroups operation to obtain the IDs of the resource groups.	rg-acfmxazb4******
Tags	array<object>	No	The tags of the cluster.
	object	No	The tag of the cluster.
Key	string	No	The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.	ClusterId
Value	string	No	The tag value. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.	ehpc-hz-******
Manager	object	No	The configurations of the cluster management node.
Scheduler	object	No	The configurations of the scheduler service.
Type	string	No	The scheduler type. Valid values: SLURM PBS OPENGRIDSCHEDULER LSF_PLUGIN PBS_PLUGIN	SLURM
Version	string	No	The scheduler version.	22.05.8
DirectoryService	object	No	The configurations of the domain account service.
Type	string	No	The type of the domain account. Valid values: NIS	NIS
Version	string	No	The version of the domain account service.	2.31
DNS	object	No	The configurations of the domain name resolution service.
Type	string	No	The domain name resolution type. Valid values: NIS	NIS
Version	string	No	The version of the domain name resolution service.	2.31
ManagerNode	NodeTemplate	No	The hardware configurations of the management node.
Queues	array	No	The queues in the cluster. The number of queues can be 0 to 8.
	QueueTemplate	No	The queue configurations.
SharedStorages	array	No	The shared storage resources of the cluster.
	SharedStorageTemplate	No	The detailed configurations of a shared storage resource.
AdditionalPackages	array<object>	No	The list of software that you want to install in the cluster. Valid values of N: 0 to 10.
	object	No	The information about a piece of software that you want to install in the cluster.
Name	string	No	The name of the software that you want to install in the cluster.	mpich
Version	string	No	The version of the software that you want to install in the cluster.	4.0.3
Addons	array<object>	No	The configurations of the custom addons in the cluster. Only one addon is supported.
	object	No	The configurations of the custom addon in the cluster.
Name	string	Yes	The addon name.	Login
Version	string	Yes	The addon version.	1.0
ServicesSpec	string	No	The service configurations of the addon.	"[{\\"ServiceName\\": \\"SSH\\", \\"ServiceAccessType\\": null, \\"ServiceAccessUrl\\": null, \\"NetworkACL\\": [{\\"IpProtocol\\": \\"TCP\\", \\"Port\\": 22, \\"SourceCidrIp\\": \\"0.0.0.0/0\\"}]}, {\\"ServiceName\\": \\"VNC\\", \\"ServiceAccessType\\": null, \\"ServiceAccessUrl\\": null, \\"NetworkACL\\": [{\\"IpProtocol\\": \\"TCP\\", \\"Port\\": 12016, \\"SourceCidrIp\\": \\"0.0.0.0/0\\"}]}, {\\"ServiceName\\": \\"CLIENT\\", \\"ServiceAccessType\\": \\"URL\\", \\"ServiceAccessUrl\\": \\"\\", \\"NetworkACL\\": [{\\"IpProtocol\\": \\"TCP\\", \\"Port\\": 12011, \\"SourceCidrIp\\": \\"0.0.0.0/0\\"}]}]"
ResourcesSpec	string	No	The resource configurations of the addon.	"{\\"EipResource\\": {\\"AutoCreate\\": true}, \\"EcsResources\\": [{\\"InstanceType\\": \\"ecs.c7.xlarge\\", \\"ImageId\\": \\"centos_7_6_x64_20G_alibase_20211130.vhd\\", \\"SystemDisk\\": {\\"Category\\": \\"cloud_essd\\", \\"Size\\": 40, \\"Level\\": \\"PL0\\"}, \\"EnableHT\\": true, \\"InstanceChargeType\\": \\"PostPaid\\", \\"SpotStrategy\\": \\"NoSpot\\"}]}"
ClusterMode	string	No	The deployment mode of the cluster. Valid values: Integrated Hybrid Custom	Integrated

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Success	boolean	The request result. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	F6757FA4-8FED-4602-B7F5-3550C0******
ClusterId	string	The cluster ID.	ehpc-hz-FYUr******
TaskId	string	The task ID.	F6757FA4-8FED-4602-B7F5-3550C0******

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "F6757FA4-8FED-4602-B7F5-3550C0******",
  "ClusterId": "ehpc-hz-FYUr******",
  "TaskId": "F6757FA4-8FED-4602-B7F5-3550C0******\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
400	OrderError.Arrearage	Your account balance is less than CNY 100. Please add funds to your account and try again.	Your account balance is less than CNY 100. Add funds to your account and try again.
400	OrderError.InstHasUnpaidOrder	Your account has an unpaid order.	Your account has an unpaid order. Please pay the order and try again.
400	OrderError.InsufficientBalance	The account balance is insufficient. Please add funds first and try again.	Your account has overdue payments. Add funds to your account and try again.
400	OrderError.InvalidPayMethod	No valid default payment method is specified for your account.	No valid payment method is found. Please check again.
400	OrderError.NoCard	No credit card is bound to your account.	You have not bound a card. Please perform binding first.
400	OrderError.NoRealNameAuthentication	You have not completed the real name authentication.	You must complete the real-name verification first.
400	OrderError.NoRealNameRegistration	Real name registration is required for instances launched in mainland China.	To purchase cloud services in mainland China regions on the international site, the user must first complete real-name registration.
400	OrderError.UserProfileIncomplete	You have not completed your user profile.	The user has not completed personal information on the international site.
400	Cluster.NotSupported	Current cluster does not support this operation.	-
403	ConflictOpt	A conflicting operation is running.	A conflicting operation is running. Please try again later.
403	TooManyClusters	The number of user clusters exceeds the quota.	The number of user clusters exceeds the quota. By default, the number of user clusters cannot exceed three.
404	KeyPairNotFound	The specified KeyPair does not exist.	-
404	ImageNotFound	The specified image does not exist.	The specified image does not exist. Please verify the parameter.
406	DbError	A database service error occurred.	Database request failed.
406	OrderError	An order request error occurred.	An order request error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-04-11	The Error code has changed	View Change Details