All Products
Search
Document Center

Elastic High Performance Computing:CreateCluster

Last Updated:Aug 28, 2026

Creates a pay-as-you-go or subscription E-HPC cluster.

Operation description

After you create an Elastic High Performance Computing (E-HPC) cluster, you are charged for the cluster resources that you use. We recommend that you learn about the billing methods of E-HPC in advance. 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

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

ZoneId

string

No

The ID of the zone in which the resource resides.

You can call the ListRegions and DescribeZones operations to query the IDs of the zones where E-HPC is supported.

cn-hangzhou-b

Name

string

Yes

The name of the E-HPC cluster. The name must be 2 to 64 characters in length.

test

Description

string

No

The description of the E-HPC cluster. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

TestDescription

EhpcVersion

string

No

The version of E-HPC. By default, the parameter is set to the latest version number.

1.0.0

ClientVersion

string

No

The version of the E-HPC client. By default, the parameter is set to the latest version number.

You can call the ListCurrentClientVersion operation to query the latest version of the E-HPC client.

1.0.64

OsTag

string

No

The operating system tag of the image.

CentOS_7.2_64

AccountType

string

No

The type of the domain account service. Valid values:

  • nis

  • ldap

Default value: nis.

nis

Domain

string

No

The domain name of the on-premises E-HPC cluster.

This parameter takes effect only when the AccountType parameter is set to Idap.

ldap

SchedulerType

string

No

The type of the scheduler. Valid values:

  • pbs

  • slurm

  • opengridscheduler

  • deadline

Default value: pbs.

pbs

SecurityGroupId

string

No

The ID of the security group to which the E-HPC cluster belongs.

You can call the DescribeSecurityGroups operation to query available security groups in the current region.

sg-bp13n61xsydodfyg****

SecurityGroupName

string

No

If you do not use an existing security group, set the parameter to the name of a new security group. A default policy is applied to the new security group.

ehpc-SecurityGroup

VpcId

string

No

The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs.

You can call the DescribeVpcs operation to query available VPCs.

vpc-b3f3edefefeep0760yju****

VSwitchId

string

No

The vSwitch ID. E-HPC supports only VPC networks.

You can call the DescribeVSwitches operation to query available vSwitches.

vsw-bp1lfcjbfb099rrjn****

VolumeType

string

No

The type of the shared storage. Set the value to nas, which indicates NAS file system.

nas

VolumeId

string

No

The ID of the NAS file system. If you leave the parameter empty, a Performance NAS file system is created by default.

You can call the ListFileSystemWithMountTargets operation to query available mount targets.

008b64****

VolumeProtocol

string

No

The type of the protocol that is used by the NAS file system. Valid values:

  • NFS

  • SMB

Default value: NFS.

NFS

VolumeMountpoint

string

No

The mount target of the NAS file system. The mount target is of the VPC type. Take note of the following information:

  • If the VolumeId parameter is not specified, you can leave the VolumeMountpoint parameter empty. In this case, a mount target is created by default.

  • When the VolumeId parameter is specified, the VolumeMountpoint parameter is required. You can call the ListFileSystemWithMountTargets operation to query available mount targets.

008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com

VolumeMountOption

string

No

The mount options of the NFS file system that you want to mount by running the mount command.

For more information, see Mount an NFS file system on a Linux ECS instance.

-t nfs -o vers=4

RemoteDirectory

string

No

The remote directory to which the NAS file system is mounted.

NasMountpoint:/RemoteDirectory

DeployMode

string

No

The mode in which the E-HPC cluster is deployed. Valid values:

  • Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed.

  • Simple: A management node, which consists of an account node and a scheduling node, is deployed, while a logon node and multiple compute nodes are separately deployed.

  • Tiny: A management node and multiple compute nodes are deployed. The management node consists of an account node, a scheduling node, and a logon node. The compute nodes are separately deployed.

Default value: Standard.

Simple

HaEnable

boolean

No

Specifies whether to enable the high availability feature. Valid values:

  • true

  • false

Default value: false.

Note

If high availability is enabled, a primary management node and a secondary management node are used.

true

EcsChargeType

string

No

The billing method of the nodes. Valid values:

  • PostPaid: pay-as-you-go.

  • PrePaid: subscription.

If you set the parameter to PrePaid, auto-renewal is enabled by default.

PostPaid

Password

string

No

The root password of the logon node. The password must be 8 to 30 characters in length and contain at least three of the following items: uppercase letters, lowercase letters, digits, and special characters. Special characters include:

( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ‘ < > , . ? /

You must specify either Password or KeyPairName. If both are specified, the Password parameter prevails.

Note

We recommend that you use HTTPS to call the API operation to prevent password leakage.

123****

KeyPairName

string

No

The name of the key pair.

Note

For more information, see Create an SSH key pair.

test

ImageOwnerAlias

string

No

The type of the image. Valid values:

  • system: public image

  • self: custom image

  • others: shared image

Default value: system.

self

ImageId

string

No

The image IDs.

You can call the ListImages and ListCustomImages operations to query the images that are supported by E-HPC.

centos_7_02_64_20G_alibase_20170818****

EcsOrder.Manager.Count

integer

No

The number of the management nodes. Valid values: 1 and 2.

1

EcsOrder.Manager.InstanceType

string

No

The instance type of the management nodes.

You can call the ListPreferredEcsTypes operation to query the recommended instance types.

ecs.n1.tiny

EcsOrder.Compute.Count

integer

No

The number of compute nodes in the cluster. Valid values: 0 to 99.

1

EcsOrder.Compute.InstanceType

string

No

The instance type of the compute nodes.

You can call the ListPreferredEcsTypes operation to query the recommended instance types.

ecs.n1.tiny

EcsOrder.Login.Count

integer

No

The number of the logon nodes. Valid value: 1.

1

EcsOrder.Login.InstanceType

string

No

The instance type of the logon nodes.

You can call the ListPreferredEcsTypes operation to query the recommended instance types.

ecs.n1.tiny

SccClusterId

string

No

The Super Computing Cluster (SCC) instance ID.

If you specify the parameter, the SCC instance is moved to a new SCC cluster.

00b648b****

ComputeSpotStrategy

string

No

The bidding method of the compute nodes. Valid values:

  • NoSpot: The compute nodes are pay-as-you-go instances.

  • SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price.

  • SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.

Default value: NoSpot.

NoSpot

ComputeSpotPriceLimit

string

No

The maximum hourly price of the compute nodes. A maximum of three decimal places can be used in the value of the parameter. The parameter is valid only when the ComputeSpotStrategy parameter is set to SpotWithPriceLimit.

0.034

ComputeEnableHt

boolean

No

Specifies whether to enable hyper-threading for the compute node. Valid values:

  • true

  • false

Default value: true.

true

Period

integer

No

The duration of the subscription. The unit of the duration is specified by the PeriodUnit parameter.

  • Valid values if PriceUnit is set to Year: 1, 2, and 3.

  • Valid values if PriceUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9.

  • Valid value if PriceUnit is set to Hour: 1.

Default value: 1.

1

PeriodUnit

string

No

The unit of the subscription duration. Valid values:

  • Year

  • Month

  • Hour

Default value: Month.

Year

AutoRenew

string

No

Specifies whether to enable auto-renewal. Valid values:

  • true

  • false

Default value: false.

false

AutoRenewPeriod

integer

No

The auto-renewal period of the subscription compute nodes. The parameter takes effect when AutoRenew is set to true.

1

InputFileUrl

string

No

The URL of the job file that is uploaded to an Object Storage Service (OSS) bucket.

https://ehpc-tianshui.oss-cn-beijing.aliyuncs.com/test-u****/testlist_ehpc.sh

JobQueue

string

No

The queue to which the compute nodes are added.

workq

SystemDiskType

string

No

The type of the system disk. Valid values:

  • cloud_efficiency: ultra disk

  • cloud_ssd: standard SSD

  • cloud_essd: enhanced SSD (ESSD)

  • cloud: basic disk. Disks of this type are retired.

Default value: cloud_ssd.

cloud_ssd

SystemDiskSize

integer

No

The system disk size. Unit: GB.

Valid values: 40 to 500.

Default value: 40.

40

RemoteVisEnable

string

No

Specifies whether to enable Virtual Network Computing (VNC). Valid values:

  • true

  • false

Default value: false.

false

ResourceGroupId

string

No

The resource group ID.

You can call the ListResourceGroups operation to obtain the ID of the resource group.

rg-acfmxazb4ph****

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000

WithoutElasticIp

boolean

No

Specifies whether the logon node uses an elastic IP address (EIP). Default value: false.

Valid values:

  • true

  • false

true

SystemDiskLevel

string

No

The performance level of the ESSD to be used as the system disk. Default value: PL1. Valid values:

  • PL0: An ESSD can deliver up to 10,000 random read/write IOPS.

  • PL1: An ESSD can deliver up to 50,000 random read/write IOPS.

  • PL2: An ESSD can deliver up to 100,000 random read/write IOPS.

  • PL3: An ESSD delivers up to 1,000,000 random read/write IOPS.

Default value: PL1.

For more information, see ESSDs.

PL0

IsComputeEss

boolean

No

Specifies whether to enable auto scaling. Valid values:

  • true

  • false

Default value: false.

false

ClusterVersion

string

No

The version of the E-HPC cluster.

Default value: 1.0.

1.0

Application

array<object>

No

The application information.

object

No

Tag

string

No

The tag of the software.

Valid values of N: 0 to 100.

You can call the ListSoftwares operation to query the tag of the software.

OpenMPI_11.1

AdditionalVolumes

array<object>

No

The information of the NAS file system.

array<object>

No

JobQueue

string

No

The queue of the nodes to which the NAS file system is attached.

Valid values of N: 1 to 10.

high

VolumeId

string

No

The ID of the NAS file system.

Valid values of N: 1 to 10.

extreme-00b88****

Roles

array<object>

No

The node information to which the NAS file system is attached.

object

No

Name

string

No

The type of the nodes to which the NAS file system is attached.

Valid values of N in AdditionalVolumes.N.Roles: 1 to 10

Valid values of N in Roles.N.Name: 0 to 8.

["Compute"]

VolumeMountpoint

string

No

The mount target of the NAS file system.

Valid values of N: 1 to 10.

0088****-sihc.cn-hangzhou.extreme.nas.aliyuncs.com

VolumeMountOption

string

No

The mount options of the NAS file system.

You can specify 1 to 10 vCPUs.

-t nfs -o vers=4.0

RemoteDirectory

string

No

The remote directory to which the NAS file system is mounted.

Valid values of N: 1 to 10.

/test

VolumeType

string

No

The type of the additional shared storage. Only NAS file systems are supported.

Valid values of N: 1 to 10.

nas

LocalDirectory

string

No

The local directory on which the NAS file system is mounted.

Valid values of N: 1 to 10.

/ff

VolumeProtocol

string

No

The type of the protocol that is used by the NAS file system. Valid value:

  • NFS

  • SMB

Valid values of N: 1 to 10.

Default value: NFS.

NFS

Location

string

No

The type of the E-HPC cluster. Set the value to PublicCloud.

Valid values of N: 1 to 10.

PublicCloud

PostInstallScript

array<object>

No

The information of the post-installation script.

object

No

Args

string

No

The parameter that is used to run the script after the cluster is created.

Valid values of N: 0 to 16.

bashfile.sh

Url

string

No

The URL that is used to download the script after the E-HPC cluster is created.

Valid values of N: 0 to 16

/opt/job.sh

Plugin

string

No

The mode configurations of the plug-in. This parameter takes effect only when the SchedulerType parameter is set to custom.

The value must be a JSON string. The parameter contains the following parameters: pluginMod, pluginLocalPath, and pluginOssPath.

  • pluginMod: the plug-in mode. The following modes are supported:

    • oss: The plug-in is downloaded and decompressed from OSS to a local path that is specified by the pluginLocalPath parameter.

    • image: By default, the plug-in is stored in a pre-defined local path that is specified by the pluginLocalPath parameter.

  • pluginLocalPath: the local path where the plug-in is stored. We recommend that you select a shared directory in oss mode and a non-shared directory in image mode.

  • pluginOssPath: the remote path where the plug-in is stored in OSS. This parameter takes effect only when the pluginMod parameter is set to oss.

{"pluginMod": "oss","pluginLocalPath": "/opt/plugin","pluginOssPath": "https://bucket.oss-cn-hangzhou.aliyuncs.com/plugin/plugin.tgz"}

WithoutAgent

boolean

No

Specifies whether not to install the agent.

  • true: does not install the agent.

  • false: installs the agent.

Default value: false.

false

WithoutNas

boolean

No

Indicates whether to use NAS as a shared storage. Valid values:

  • true: does not use NAS.

  • false: use NAS.

Default value: false.

false

RamRoleName

string

No

The name of the Resource Access Management (RAM) role.

You can call the ListRoles operation provided by RAM to query the instance RAM roles that you created.

testRamRoleName

NetworkInterfaceTrafficMode

string

No

The communication model of the ENI. Valid values:

  • Standard: The TCP communication mode is used.

  • HighPerformance: uses the remote direct memory access (RDMA) communication mode with the Elastic RDMA Interface (ERI) enabled.

Standard

DeploymentSetId

string

No

The ID of the deployment set in which to deploy the instance. You can obtain the deployment set ID by calling the DescribeDeploymentSets operation. Only the deployment sets that use low latency policy are supported.

ds-bp1frxuzdg87zh4pzq****

RamNodeTypes

array

No

The node of the RAM role.

Standard

string

No

The node of the RAM role.

Valid values of N: 0 to 4

  • If the DeployMode parameter is set to Standard, the following values are valid: scheduler, account, login, and compute. Separate multiple values with commas (,).

  • If the DeployMode parameter is set to Simple, the following values are valid: manager, login, and compute. Separate multiple values with commas (,).

  • If the DeployMode parameter is set to Tiny, the following values are valid: manager and compute.

manager

Tag

array<object>

No

The array of the tags.

Standard

object

No

The array of the tags.

scheduler

Key

string

No

The tag key.

TestKey

Value

string

No

The tag value.

TestValue

AddOns

array<object>

No

The custom component service.

object

No

Name

string

No

The component name.

cromwell

Version

string

No

The version number of the component.

85

DeployMode

string

No

The deployment mode. Valid values: local and ecs.

local

DBType

string

No

The type of the database engine. Valid values: Mysql, and null.

Mysql

ConfigFile

string

No

The path to the configuration file.

/usr/local/addon/cromwell/cromwell.conf

Port

number

No

The access port of the custom component.

10000

DefaultStart

boolean

No

Indicates whether to auto-start the custom component. Valid values: true and false.

true

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

F6757FA4-8FED-4602-B7F5-3550C084****

TaskId

string

The task ID.

Note

CreateCluster is an asynchronous operation. A response is returned if the request succeeds. However, this does not mean that a cluster is created. You can call the ListTasks operation to query the result of the task.

F6757FA4-8FED-4602-B7F5-3550C084****

ClusterId

string

The cluster ID.

ehpc-hz-FYUr32****

Examples

Success response

JSON format

{
  "RequestId": "F6757FA4-8FED-4602-B7F5-3550C084****",
  "TaskId": "F6757FA4-8FED-4602-B7F5-3550C084****",
  "ClusterId": "ehpc-hz-FYUr32****"
}

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 NotEnabled You have not enabled this service You have not enabled this service
400 InDebt Your account has overdue payments. Your account has overdue payments.
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.InstHasUnpaidOrder Your account has an unpaid order. Your account has an unpaid order. Please pay the order and try again.
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.NoCard No credit card is bound to your account. You have not bound a card. Please perform binding first.
400 OrderError.InvalidPayMethod No valid default payment method is specified for your account. No valid payment method is found. Please check again.
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 InvalidVpc The specified VPC is invalid. The VPC information is invalid.
400 InvalidVolume The specified volume is invalid. The specified volume is invalid.
400 InvalidSoftware The specified software is not supported. The requested software is not supported.
400 InvalidVolumeProtocal The specified volume protocol is invalid. The storage protocol is invalid.
400 InvalidVolumeMountpoint The specified volume mount point is invalid. The specified volume mount point is invalid.
400 MissingParams The %s parameter is required.
500 UnknownError An unknown error occurred. An unknown error occurred.
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.
403 TooManyComputes The number of computing nodes exceeds the quota. The number of computing nodes exceeds the quota.
403 TooManyLogins The maximum number of logged on nodes is exceeded. The maximum number of logged on nodes is exceeded. The default maximum value is 2.
403 TooManyScc The maximum number of SCC instances is exceeded. The maximum number of SCC instances is exceeded. The default maximum value is 15.
403 QuotaExceeded.PrivateIpAddress Insufficient private IP addresses in vSwitch: %s. Insufficient private IP addresses in vSwitch: %s.
403 ConflictOpt A conflicting operation is running. A conflicting operation is running. Please try again later.
403 ImageNotSupported The specified image is not supported. The specified image does not exist. Change the image and try again.
404 ImageNotFound The specified image does not exist. The specified image does not exist. Please verify the parameter.
404 VolumeNotFound The specified volume does not exist. The specified storage does not exist. Please verify the parameter.
404 VpcNotFound The specified VPC does not exist. The specified VPC does not exist.
404 KeyPairNotFound The specified KeyPair does not exist.
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 EcsError An error occurred while calling the ECS API operation. ECS API call error. %s
406 NasError NAS API request failed. Failed to request the NAS interface.
406 NasServiceNotOpen The NAS service is not activated. You have not activated NAS.
406 EipError The EIP API request failed. EIP API request failed.
406 OrderError An order request error occurred. An order request error occurred.
406 FailToGenId Generating cluster ID failed.
406 DbError A database service error occurred. Database request failed.
406 AliyunError An Alibaba Cloud product error occurred. Alibaba Cloud product error. %s
406 AckError An error occurred while calling the ACK API operation.
407 NotAuthorized No authorization is granted. No authorization is granted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.