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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ehpc:CreateCluster | WRITE |
|
| 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 | 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:
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:
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 |
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:
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:
| 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:
Default value: Standard. | Simple |
HaEnable | boolean | No | Specifies whether to enable the high availability feature. Valid values:
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:
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:
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:
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:
Default value: true. | true |
Period | integer | No | The duration of the subscription. The unit of the duration is specified by the
Default value: 1. | 1 |
PeriodUnit | string | No | The unit of the subscription duration. Valid values:
Default value: Month. | Year |
AutoRenew | string | No | Specifies whether to enable auto-renewal. Valid values:
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:
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:
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 |
SystemDiskLevel | string | No | The performance level of the ESSD to be used as the system disk. Default value: PL1. Valid values:
Default value: PL1. For more information, see ESSDs . | PL0 |
IsComputeEss | boolean | No | Specifies whether to enable auto scaling. Valid values:
Default value: false. | false |
ClusterVersion | string | No | The version of the E-HPC cluster. Default value: 1.0. | 1.0 |
Application | object [] | No | The application information. | |
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 | object [] | No | The information of the NAS file system. | |
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 | object [] | No | The node information to which the NAS file system is attached. | |
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:
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 | object [] | No | The information of the post-installation script. | |
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": "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.
Default value: false. | false |
WithoutNas | boolean | No | Indicates whether to use NAS as a shared storage. Valid values:
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 |
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. | |
string | No | The node of the RAM role. Valid values of N: 0 to 4
| manager | |
Tag | object [] | No | The array of the tags. | Standard |
Key | string | No | The tag key. | TestKey |
Value | string | No | The tag value. | TestValue |
AddOns | object [] | No | The custom component service. | |
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 | float | 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 parameters
Examples
Sample success responses
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. | - |
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. | - |
406 | EcsError | An error occurred while calling the ECS API operation. | An error occurred while calling the ECS API operation. |
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. | Failed to generate the cluster ID. Please try again. |
406 | DbError | A database service error occurred. | Database request failed. |
406 | AliyunError | An Alibaba Cloud product error occurred. | An Alibaba Cloud product error occurred. |
406 | AckError | An error occurred while calling the ACK API operation. | - |
407 | NotAuthorized | No authorization is granted. | No authorization is granted. |
500 | UnknownError | An unknown error occurred. | An unknown 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 | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-07-07 | The Error code has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2023-06-27 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2023-05-26 | API Description Update. The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2023-03-06 | API Description Update. The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2022-06-24 | API Description Update. The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2022-01-21 | The Error code has changed | see changesets | ||||||||||||||||||||||
|