All Products
Search
Document Center

Elastic High Performance Computing:CreateCluster

Last Updated:Dec 06, 2023

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.

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.

debugging

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:CreateClusterWRITE
  • acs:ehpc:{#regionId}:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ZoneIdstringNo

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
NamestringYes

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

test
DescriptionstringNo

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
EhpcVersionstringNo

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

1.0.0
ClientVersionstringNo

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
OsTagstringNo

The operating system tag of the image.

CentOS_7.2_64
AccountTypestringNo

The type of the domain account service. Valid values:

  • nis
  • ldap

Default value: nis.

nis
DomainstringNo

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

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

ldap
SchedulerTypestringNo

The type of the scheduler. Valid values:

  • pbs
  • slurm
  • opengridscheduler
  • deadline

Default value: pbs.

pbs
SecurityGroupIdstringNo

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****
SecurityGroupNamestringNo

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
VpcIdstringNo

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****
VSwitchIdstringNo

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

You can call the DescribeVSwitches operation to query available vSwitches.

vsw-bp1lfcjbfb099rrjn****
VolumeTypestringNo

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

nas
VolumeIdstringNo

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****
VolumeProtocolstringNo

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

  • NFS
  • SMB

Default value: NFS.

NFS
VolumeMountpointstringNo

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
VolumeMountOptionstringNo

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
RemoteDirectorystringNo

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

NasMountpoint:/RemoteDirectory
DeployModestringNo

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
HaEnablebooleanNo

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
EcsChargeTypestringNo

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
PasswordstringNo

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****
KeyPairNamestringNo

The name of the key pair.

Note For more information, see Create an SSH key pair.
test
ImageOwnerAliasstringNo

The type of the image. Valid values:

  • system: public image
  • self: custom image
  • others: shared image

Default value: system.

self
ImageIdstringNo

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.CountintegerNo

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

1
EcsOrder.Manager.InstanceTypestringNo

The instance type of the management nodes.

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

ecs.n1.tiny
EcsOrder.Compute.CountintegerNo

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

1
EcsOrder.Compute.InstanceTypestringNo

The instance type of the compute nodes.

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

ecs.n1.tiny
EcsOrder.Login.CountintegerNo

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

1
EcsOrder.Login.InstanceTypestringNo

The instance type of the logon nodes.

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

ecs.n1.tiny
SccClusterIdstringNo

The Super Computing Cluster (SCC) instance ID.

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

00b648b****
ComputeSpotStrategystringNo

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
ComputeSpotPriceLimitstringNo

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
ComputeEnableHtbooleanNo

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

  • true
  • false

Default value: true.

true
PeriodintegerNo

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
PeriodUnitstringNo

The unit of the subscription duration. Valid values:

  • Year
  • Month
  • Hour

Default value: Month.

Year
AutoRenewstringNo

Specifies whether to enable auto-renewal. Valid values:

  • true
  • false

Default value: false.

false
AutoRenewPeriodintegerNo

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

1
InputFileUrlstringNo

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
JobQueuestringNo

The queue to which the compute nodes are added.

workq
SystemDiskTypestringNo

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
SystemDiskSizeintegerNo

The system disk size. Unit: GB.

Valid values: 40 to 500.

Default value: 40.

40
RemoteVisEnablestringNo

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

  • true
  • false

Default value: false.

false
ResourceGroupIdstringNo

The resource group ID.

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

rg-acfmxazb4ph****
ClientTokenstringNo

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
WithoutElasticIpbooleanNo

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

Valid values:

  • true
  • false
true
SystemDiskLevelstringNo

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
IsComputeEssbooleanNo

Specifies whether to enable auto scaling. Valid values:

  • true
  • false

Default value: false.

false
ClusterVersionstringNo

The version of the E-HPC cluster.

Default value: 1.0.

1.0
Applicationobject []No

The application information.

TagstringNo

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
AdditionalVolumesobject []No

The information of the NAS file system.

JobQueuestringNo

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

Valid values of N: 1 to 10.

high
VolumeIdstringNo

The ID of the NAS file system.

Valid values of N: 1 to 10.

extreme-00b88****
Rolesobject []No

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

NamestringNo

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"]
VolumeMountpointstringNo

The mount target of the NAS file system.

Valid values of N: 1 to 10.

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

The mount options of the NAS file system.

You can specify 1 to 10 vCPUs.

-t nfs -o vers=4.0
RemoteDirectorystringNo

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

Valid values of N: 1 to 10.

/test
VolumeTypestringNo

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

Valid values of N: 1 to 10.

nas
LocalDirectorystringNo

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

Valid values of N: 1 to 10.

/ff
VolumeProtocolstringNo

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
LocationstringNo

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

Valid values of N: 1 to 10.

PublicCloud
PostInstallScriptobject []No

The information of the post-installation script.

ArgsstringNo

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

Valid values of N: 0 to 16.

bashfile.sh
UrlstringNo

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
PluginstringNo

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"}
WithoutAgentbooleanNo

Specifies whether not to install the agent.

  • true: does not install the agent.
  • false: installs the agent.

Default value: false.

false
WithoutNasbooleanNo

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

  • true: does not use NAS.
  • false: use NAS.

Default value: false.

false
RamRoleNamestringNo

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
NetworkInterfaceTrafficModestringNo

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
DeploymentSetIdstringNo

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****
RamNodeTypesarrayNo

The node of the RAM role.

stringNo

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
Tagobject []No

The array of the tags.

Standard
KeystringNo

The tag key.

TestKey
ValuestringNo

The tag value.

TestValue
AddOnsobject []No

The custom component service.

NamestringNo

The component name.

cromwell
VersionstringNo

The version number of the component.

85
DeployModestringNo

The deployment mode. Valid values: local and ecs.

local
DBTypestringNo

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

Mysql
ConfigFilestringNo

The path to the configuration file.

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

The access port of the custom component.

10000
DefaultStartbooleanNo

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

true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

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****
ClusterIdstring

The cluster ID.

ehpc-hz-FYUr32****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
400NotEnabledYou have not enabled this serviceYou have not enabled this service
400InDebtYour account has overdue payments.Your account has overdue payments.
400OrderError.InsufficientBalanceThe account balance is insufficient. Please add funds first and try again.Your account has overdue payments. Add funds to your account and try again.
400OrderError.InstHasUnpaidOrderYour account has an unpaid order.Your account has an unpaid order. Please pay the order and try again.
400OrderError.ArrearageYour 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.
400OrderError.NoCardNo credit card is bound to your account.You have not bound a card. Please perform binding first.
400OrderError.InvalidPayMethodNo valid default payment method is specified for your account.No valid payment method is found. Please check again.
400OrderError.NoRealNameAuthenticationYou have not completed the real name authentication.You must complete the real-name verification first.
400OrderError.NoRealNameRegistrationReal 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.
400OrderError.UserProfileIncompleteYou have not completed your user profile.The user has not completed personal information on the international site.
400InvalidVpcThe specified VPC is invalid.The VPC information is invalid.
400InvalidVolumeThe specified volume is invalid.The specified volume is invalid.
400InvalidSoftwareThe specified software is not supported.The requested software is not supported.
400InvalidVolumeProtocalThe specified volume protocol is invalid.The storage protocol is invalid.
400InvalidVolumeMountpointThe specified volume mount point is invalid.The specified volume mount point is invalid.
400MissingParamsThe %s parameter is required.-
403TooManyClustersThe 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.
403TooManyComputesThe number of computing nodes exceeds the quota.The number of computing nodes exceeds the quota.
403TooManyLoginsThe maximum number of logged on nodes is exceeded.The maximum number of logged on nodes is exceeded. The default maximum value is 2.
403TooManySccThe maximum number of SCC instances is exceeded.The maximum number of SCC instances is exceeded. The default maximum value is 15.
403QuotaExceeded.PrivateIpAddressInsufficient private IP addresses in vSwitch: %s.Insufficient private IP addresses in vSwitch: %s.
403ConflictOptA conflicting operation is running.A conflicting operation is running. Please try again later.
403ImageNotSupportedThe specified image is not supported.The specified image does not exist. Change the image and try again.
404ImageNotFoundThe specified image does not exist.The specified image does not exist. Please verify the parameter.
404VolumeNotFoundThe specified volume does not exist.The specified storage does not exist. Please verify the parameter.
404VpcNotFoundThe specified VPC does not exist.The specified VPC does not exist.
404KeyPairNotFoundThe specified KeyPair does not exist.-
406EcsErrorAn error occurred while calling the ECS API operation.An error occurred while calling the ECS API operation.
406NasErrorNAS API request failed.Failed to request the NAS interface.
406NasServiceNotOpenThe NAS service is not activated.You have not activated NAS.
406EipErrorThe EIP API request failed.EIP API request failed.
406OrderErrorAn order request error occurred.An order request error occurred.
406FailToGenIdGenerating cluster ID failed.Failed to generate the cluster ID. Please try again.
406DbErrorA database service error occurred.Database request failed.
406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
406AckErrorAn error occurred while calling the ACK API operation.-
407NotAuthorizedNo authorization is granted.No authorization is granted.
500UnknownErrorAn unknown error occurred.The operation is unknown. Please check arguments and try again later.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe 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 timeSummary of changesOperation
2023-07-07The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
2023-06-27The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 400 change
    Error Codes 404 change
    Error Codes 406 change
    delete Error Codes: 403
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: WithoutNas
    Added Input Parameters: DeploymentSetId
2023-05-26API Description Update,The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: AddOns
2023-03-06API Description Update,The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: NetworkInterfaceTrafficMode
2022-06-24API Description Update,The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: Tag
2022-01-21The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 406
    delete Error Codes: 407
    delete Error Codes: 500
    delete Error Codes: 503