Build an E-HPC Cluster with the CreateCluster API - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Create a pay-as-you-go or subscription cluster.

Operation description

API

Before using this interface, ensure you understand the E-HPC billing method and pricing. For more information, see billing overview.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:CreateCluster

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterName	string	No	The name of the cluster. The name must be 2 to 128 characters long and can contain letters, Chinese characters, digits, hyphens (-), and underscores (_).	slurm22.05.8-cluster-20240718
ClusterDescription	string	No	The description of the cluster. The description must be 2 to 128 characters long and can contain letters, Chinese characters, digits, hyphens (-), and underscores (_).	slurm22.05.8-cluster-20240718
ClusterCategory	string	No	The edition of the cluster. Valid values: Standard Serverless Valid values: Standard : Standard Serverless : Serverless	Standard
ClusterVpcId	string	No	The ID of the VPC for the cluster.	vpc-m5efjevmclc0xdmys****
ClusterVSwitchId	string	No	The ID of the VSwitch for the cluster. The VSwitch must be in the VPC specified by `ClusterVpcId`. Call the DescribeVpcs operation to find available VPCs and VSwitches.	vsw-f8za5p0mwzgdu3wgx****
IsEnterpriseSecurityGroup	boolean	No	Specifies whether to use an enterprise security group. Valid values: true: The system automatically creates and uses an enterprise security group. false: The system automatically creates and uses a security group. For more information about how to select a security group type, see Security groups and enterprise security groups. Valid values: true : true false : false	false
SecurityGroupId	string	No	The ID of the security group for the cluster. Call the DescribeSecurityGroups operation to find available security groups in the current region.	sg-bp13n61xsydodfyg****
ClientVersion	string	No	The version of the E-HPC client. By default, the latest version is used.	2.1.0
ClusterCustomConfiguration	object	No	The post-processing script for the cluster.
Script	string	No	The download URL for the post-processing script.	http://*****
Args	string	No	The execution parameters for the post-processing script.	E-HPC cn-hangzhou
ClusterCredentials	object	No	The security credentials for the cluster.
KeyPairName	string	No	The key pair name. The name must be 2 to 128 characters long, start with a letter or a Chinese character, and not start with `http://` or `https://`. It can contain digits, colons (:), underscores (_), and hyphens (-). Note To use an ECS key pair, see Create a key pair.	ali0824
Password	string	No	The root password of the login node. The password must be 8 to 20 characters long and include characters from at least three of the following categories: uppercase letters, lowercase letters, digits, and special characters. The supported special characters are: `() ~ ! @ # $ % ^ & * - = + { } [ ] : ; ‘ < > , . ? /` Note Use HTTPS when calling the API to prevent password exposure.	**********
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 CPU cores that the cluster can manage across all compute nodes. Valid values: 0 to 100,000.	10000
DeletionProtection	boolean	No	Specifies whether to enable deletion protection for the cluster. This feature prevents the cluster from being deleted via the console or the DeleteCluster operation. true: Enables deletion protection. false: Disables deletion protection. Default value: false. Valid values: true : true false : false	false
ResourceGroupId	string	No	The ID of the resource group. Call the ListResourceGroups operation to find resource group IDs.	rg-acfmxazb4******
Tags	array<object>	No	The list of tags to add to the cluster. You can add up to 20 tags.
	object	No	A key-value pair that represents the tag.
Key	string	No	The tag key. The key cannot be an empty string. The key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	ClusterId
Value	string	No	The tag value. The value can be an empty string. The value can be up to 128 characters in length and cannot contain `http://` or `https://`.	ehpc-hz-******
Manager	object	No	Configuration for the cluster manager node.
Scheduler	object	No	Configuration for the scheduler.
Type	string	No	The scheduler type. Valid values: SLURM PBS OPENGRIDSCHEDULER LSF_PLUGIN PBS_PLUGIN Valid values: PBS : PBS SLURM : SLURM PBS_PLUGIN : PBS_PLUGIN OPENGRIDSCHEDULER : OPENGRIDSCHEDULER LSF_PLUGIN : LSF_PLUGIN	SLURM
Version	string	No	The scheduler version.	22.05.8
DirectoryService	object	No	Configuration for the directory service.
Type	string	No	The directory service type. Valid values: NIS : NIS	NIS
Version	string	No	The directory service version.	2.31
DNS	object	No	Configuration for the DNS service.
Type	string	No	The DNS service type. Valid values: NIS : NIS	NIS
Version	string	No	The DNS service version.	2.31
ManagerNode	NodeTemplate	No	Hardware configuration for the manager node.
Queues	array	No	Configuration for the cluster queues. You can specify up to 8 queues.
	QueueTemplate	No	Detailed configuration for a cluster queue.
SharedStorages	array	No	Configuration for the cluster's shared storage.
	SharedStorageTemplate	No	Detailed configuration for the cluster's shared storage.
AdditionalPackages	array<object>	No	A list of software to install in the cluster. You can specify up to 10 packages.
	object	No	The information about the software to install.
Name	string	No	The name of the software.	mpich
Version	string	No	The version of the software.	4.0.3
Addons	array<object>	No	The configuration of the custom service component for the cluster. Only one component is supported.
	object	No	The detailed configuration of the custom service component.
Name	string	Yes	The name of the custom service component.	Login
Version	string	Yes	The version of the custom service component.	1.0
ServicesSpec	string	No	The service configuration of the custom service component.	"[{\\"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 configuration of the custom service component.	"{\\"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 cluster's deployment type. Valid values: Integrated: An integrated cluster. Hybrid: A hybrid cloud cluster. Custom: A custom cluster. Valid values: Hybrid : Hybrid Custom : Custom Integrated : Integrated	Integrated

Response elements

Element	Type	Description	Example
	object	The response schema
Success	boolean	Indicates whether the request succeeded. Valid values: true: The request succeeded. 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

Success response

JSON format

{
  "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.
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.
406	DbError	A database service error occurred.	Database request failed.
406	OrderError	An order request error occurred.	An order request error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.