All Products
Search

This Product

    Elastic High Performance Computing:CreateCluster

    Document Center

    Elastic High Performance Computing:CreateCluster

    Last Updated:Sep 10, 2026

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

    Operation description

    Operation description

    Creating a cluster involves billing for related resources. Learn about the Billable methods of E-HPC in advance. For more information, see Billable methods.

    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 zone ID.

    You can call the ListRegions and DescribeZones operations to query the zone IDs where E-HPC is available.

    cn-hangzhou-b
    Name

    string

    Yes

    The cluster name. The name must be 2 to 64 characters in length.

    test
    Description

    string

    No

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

    TestDescription
    EhpcVersion

    string

    No

    The E-HPC Edition. Default value: the latest version.

    1.0.0
    ClientVersion

    string

    No

    The cluster client version. Default value: the latest version.

    You can call the ListCurrentClientVersion operation to query the latest client version number.

    1.0.64
    OsTag

    string

    No

    The operating system image tag.

    CentOS_7.2_64
    AccountType

    string

    No

    The domain account service type. Valid values:

    • nis

    • ldap

    Default value: nis.

    nis
    Domain

    string

    No

    The local cluster domain name.

    This parameter is supported only when AccoutType is set to ldap.

    ldap
    SchedulerType

    string

    No

    The scheduler type. Valid values:

    • pbs

    • slurm

    • opengridscheduler

    • deadline

    Default value: pbs.

    pbs
    SecurityGroupId

    string

    No

    The ID of the security group to which the new cluster belongs.

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

    sg-bp13n61xsydodfyg****
    SecurityGroupName

    string

    No

    If you do not use an existing security group, a new security group is created with this name and the default security group policy is applied.

    ehpc-SecurityGroup
    VpcId

    string

    No

    The ID of the VPC to which the cluster belongs.

    You can call the DescribeVpcs operation to query the VPCs that you have created.

    vpc-b3f3edefefeep0760yju****
    VSwitchId

    string

    No

    The vSwitch ID in the VPC. E-HPC currently supports only VPC networks.

    You can call the DescribeVSwitches operation to query the vSwitches that you have created.

    vsw-bp1lfcjbfb099rrjn****
    VolumeType

    string

    No

    The type of shared storage. Currently, only nas is supported, which indicates NAS file systems.

    nas
    VolumeId

    string

    No

    The instance ID of the Alibaba Cloud NAS file system. If this parameter is left empty, a compute-optimized instance NAS file system is created by default during the cluster creation flow.

    You can invoke the ListFileSystemWithMountTargets operation to query active VPC mount targets of NAS file systems.

    008b64****
    VolumeProtocol

    string

    No

    The protocol type of the shared storage. Valid values:

    • NFS

    • SMB

    Default value: NFS.

    NFS
    VolumeMountpoint

    string

    No

    The VPC mount target of the NAS file system. The following limits apply to VolumeMountpoint:

    • If VolumeId is left empty, VolumeMountpoint can be left empty. A VPC mount target is created by default during cluster creation.

    • If VolumeId is specified, VolumeMountpoint is required. You can call the ListFileSystemWithMountTargets operation to query available VPC mount targets of NAS file systems.

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

    string

    No

    The mount options used when you manually mount an NFS file system by running the mount command.

    For more information, see Manually mount an NFS file system.

    -t nfs -o vers=4
    RemoteDirectory

    string

    No

    The remote directory of the mounted shared storage.

    NasMountpoint:/RemoteDirectory
    DeployMode

    string

    No

    The cluster deployment mode. Valid values:

    • Standard: The domain account node, scheduling node, logon node, and compute node are deployed separately.

    • Simple: The domain account node and scheduling node are deployed on the same node. The logon node and compute node are deployed separately.

    • Tiny: The domain account node, scheduling node, and logon node are deployed on the same node. The compute node is deployed separately.

    Default value: Standard.

    Simple
    HaEnable

    boolean

    No

    Specifies whether to enable high availability. Valid values:

    • true: Enabled.

    • false: Not enabled.

    Default value: false.

    Note

    If high availability is enabled, two nodes (primary and secondary) are used for each management role in the cluster.

    true
    EcsChargeType

    string

    No

    The billing method for all nodes in the cluster. Valid values:

    • PostPaid: pay-as-you-go.

    • PrePaid: subscription.

    If you select subscription, auto-renewal is enabled by default.

    PostPaid
    Password

    string

    No

    The root password of the logon node.

    Note

    Use HTTPS to call the API to prevent password leaks.

    Password requirements:

    • The password must be 8 to 30 characters in length.

    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' < > , . ? / .

    Note

    The cluster supports both password and key pair as logon credentials. You must specify either Password or KeyPairName. If both are specified, Password takes precedence.

    123****
    KeyPairName

    string

    No

    The name of the key pair bound to the logon node. For information about how to create a key pair, see Create a key pair.

    Note

    The cluster supports both password and key pair as logon credentials. You must specify either Password or KeyPairName. If both are specified, Password takes precedence.

    test
    ImageOwnerAlias

    string

    No

    The image type. Valid values:

    • system: public image

    • self: custom image

    • others: shared image

    Default value: system.

    self
    ImageId

    string

    No

    The image ID.

    You can call the ListImages and ListCustomImages operations to query the image IDs available for E-HPC.

    centos_7_02_64_20G_alibase_20170818****
    EcsOrder.Manager.Count

    integer

    No

    The number of management nodes in the cluster. Valid values: 1 to 2.

    1
    EcsOrder.Manager.InstanceType

    string

    No

    The instance type of the management nodes in the cluster.

    You can invoke the ListPreferredEcsTypes operation to query the recommended node specifications.

    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 in the cluster.

    You can invoke the ListPreferredEcsTypes operation to query the recommended node specifications.

    ecs.n1.tiny
    EcsOrder.Login.Count

    integer

    No

    The number of logon nodes in the cluster. Only the value 1 is supported.

    1
    EcsOrder.Login.InstanceType

    string

    No

    The instance type of the logon nodes in the cluster.

    You can invoke the ListPreferredEcsTypes operation to query the recommended node specifications.

    ecs.n1.tiny
    SccClusterId

    string

    No

    The SCC instance ID.

    If this parameter is specified, the existing SCC instance is managed by the newly created SCC cluster.

    00b648b****
    ComputeSpotStrategy

    string

    No

    The bidding strategy for compute nodes. Valid values:

    • NoSpot: pay-as-you-go node.

    • SpotWithPriceLimit: spot instance with a maximum price limit.

    • SpotAsPriceGo: spot instance that follows the current market price.

    Default value: NoSpot.

    NoSpot
    ComputeSpotPriceLimit

    string

    No

    The maximum hourly price for compute nodes. A maximum of three decimal places is supported. This parameter takes effect only when ComputeSpotStrategy is set to SpotWithPriceLimit.

    0.034
    ComputeEnableHt

    boolean

    No

    Specifies whether compute nodes support hyper-threading. Valid values:

    • true: Supported.

    • false: Not supported.

    Default value: true.

    true
    Period

    integer

    No

    The duration for purchasing cluster nodes. The unit is specified by PeriodUnit. Valid values:

    • If PriceUnit is set to Year: 1 to 3.

    • If PriceUnit is set to Month: 1 to 9.

    • If PriceUnit is set to Hour: 1.

    Default value: 1.

    1
    PeriodUnit

    string

    No

    The unit of the duration for purchasing cluster nodes. Valid values:

    • Year

    • Month

    • Hour

    Default value: Month.

    Year
    AutoRenew

    string

    No

    Specifies whether to enable auto-renewal. Valid values:

    • true: Auto-renewal is enabled.

    • false: Auto-renewal is not enabled.

    Default value: false.

    false
    AutoRenewPeriod

    integer

    No

    The duration of each auto-renewal. This parameter takes effect only when AutoRenew is set to true.

    1
    InputFileUrl

    string

    No

    The URL of the job file uploaded to OSS.

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

    string

    No

    The name of the queue that compute nodes join.

    workq
    SystemDiskType

    string

    No

    The type of the system cloud disk. Valid values:

    • cloud_efficiency: ultra cloud disk.

    • cloud_ssd: standard SSD.

    • cloud_essd: ESSD.

    • cloud: basic cloud disk. No longer available.

    Default value: cloud_ssd.

    cloud_ssd
    SystemDiskSize

    integer

    No

    The size of the system cloud disk. Unit: GB.

    Valid values: 40 to 500.

    Default value: 40.

    40
    RemoteVisEnable

    string

    No

    Specifies whether to enable remote visualization. Valid values:

    • true: Enabled.

    • false: Not enabled.

    Default value: false.

    false
    ResourceGroupId

    string

    No

    The resource group ID.

    You can call the ListResourceGroups operation to query resource group IDs.

    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 token, but make sure that the token is unique among different requests. The token can contain only 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.

    true
    SystemDiskLevel

    string

    No

    The performance level of the ESSD used as the system cloud disk. Settings this parameter when you create an ESSD as the system cloud disk. Valid values:

    • PL0: A single disk can deliver up to 10,000 random read/write IOPS.

    • PL1: A single disk can deliver up to 50,000 random read/write IOPS.

    • PL2: A single disk can deliver up to 100,000 random read/write IOPS.

    • PL3: A single disk can deliver up to 1,000,000 random read/write IOPS.

    Default value: PL1.

    For information about how to select an ESSD performance level, see ESSD.

    PL0
    IsComputeEss

    boolean

    No

    Specifies whether to enable auto scaling. Valid values:

    • true: Enabled.

    • false: Not enabled.

    Default value: false.

    false
    ClusterVersion

    string

    No

    The cluster version number.

    Default value: 1.0.

    1.0
    Application

    array<object>

    No

    The application software information.

    object

    No

    The application software information.

    Tag

    string

    No

    The tag of the application software.

    Valid values of N: 0 to 100.

    You can call the ListSoftwares operation to query application software tags.

    OpenMPI_11.1
    AdditionalVolumes

    array<object>

    No

    The information about the mounted shared storage.

    array<object>

    No

    The information about the mounted shared storage.

    JobQueue

    string

    No

    The queue to which the job on the node with the mounted shared storage belongs.

    Valid values of N: 1 to 10.

    high
    VolumeId

    string

    No

    The instance ID of the mounted NAS file system.

    Valid values of N: 1 to 10.

    extreme-00b88****
    Roles

    array<object>

    No

    The information about the nodes to which the shared storage is mounted on the new NAS instance.

    object

    No

    The information about the nodes to which the shared storage is mounted on the new NAS instance.

    Name

    string

    No

    The type of the node to which the shared storage is mounted on the new NAS instance.

    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 VPC mount target of the mounted NAS instance.

    Valid values of N: 1 to 10.

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

    string

    No

    The mount options of the NAS instance.

    Valid values of N: 1 to 10.

    -t nfs -o vers=4.0
    RemoteDirectory

    string

    No

    The remote directory of the mounted shared storage.

    Valid values of N: 1 to 10.

    /test
    VolumeType

    string

    No

    The type of the mounted shared storage. Currently, only NAS is supported.

    Valid values of N: 1 to 10.

    nas
    LocalDirectory

    string

    No

    The local mount directory of the mounted shared storage.

    Valid values of N: 1 to 10.

    /ff
    VolumeProtocol

    string

    No

    The protocol type of the mounted shared storage. Valid values:

    • NFS

    • SMB

    Valid values of N: 1 to 10.

    Default value: NFS.

    NFS
    Location

    string

    No

    The cluster type of the mounted shared storage. Only PublicCloud is supported.

    Valid values of N: 1 to 10.

    PublicCloud
    PostInstallScript

    array<object>

    No

    The post-installation script information.

    object

    No

    The post-installation script information.

    Args

    string

    No

    The execution parameters of the post-installation script.

    Valid values of N: 0 to 16.

    bashfile.sh
    Url

    string

    No

    The download URL of the post-installation script.

    Valid values of N: 0 to 16.

    /opt/job.sh
    Plugin

    string

    No

    The plug-in pattern configuration. This parameter takes effect only when SchedulerType is set to custom.

    The value is a JSON string that contains the pluginMod, pluginLocalPath, and pluginOssPath parameters. The metric description is as follows:

    • pluginMod: The plug-in pattern. The following two patterns are supported:

      • oss: The plug-in is downloaded from OSS and extracted to the local pluginLocalPath folder.

      • image: The plug-in is already placed in the pluginLocalPath by default.

    • pluginLocalPath: The local path where the plug-in is stored. Use a shared storage folder for the oss pattern and a non-shared storage folder for the image pattern.

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

    The format is a JSON character string.

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

    boolean

    No

    Specifies whether to skip installing the Agent client.

    • true: Do not install.

    • false: Install.

    Default value: false.

    false
    WithoutNas

    boolean

    No

    Specifies whether to skip using NAS as shared storage. Valid values:

    • true: Do not use NAS.

    • false: Use NAS.

    Default value: false.

    false
    RamRoleName

    string

    No

    The name of the instance RAM role.

    You can call the RAM API ListRoles to query the instance RAM roles that you have created.

    testRamRoleName
    NetworkInterfaceTrafficMode

    string

    No

    The communication mode of the elastic network interface controller (NIC). Valid values:

    • Standard: Uses TCP communication mode.

    • HighPerformance: Enables the Elastic RDMA Interface (ERI) and uses RDMA communication mode.

    Standard
    DeploymentSetId

    string

    No

    The deployment set ID. You can call DescribeDeploymentSets to query deployment set IDs. Only deployment sets that use the network low latency strategy are supported.

    ds-bp1frxuzdg87zh4pzq****
    RamNodeTypes

    array

    No

    The details of node names to which the instance RAM role is assigned.

    Standard

    string

    No

    The name of the node to which the instance RAM role is assigned.

    Valid values of N: 0 to 4.

    • If DeployMode is set to Standard, valid values are scheduler, account, login, and compute. You can specify multiple values separated by commas (,).

    • If DeployMode is set to Simple, valid values are manager, login, and compute. You can specify multiple values separated by commas (,).

    • If DeployMode is set to Tiny, valid values are manager and compute.

    manager
    Tag

    array<object>

    No

    The tags.

    Standard

    object

    No

    The tags.

    scheduler
    Key

    string

    No

    The tag key.

    TestKey
    Value

    string

    No

    The tag value.

    TestValue
    AddOns

    array<object>

    No

    The custom component services.

    object

    No

    The custom component services.

    Name

    string

    No

    The component name.

    cromwell
    Version

    string

    No

    The component version number.

    85
    DeployMode

    string

    No

    The deployment mode. Valid values: local, ecs.

    local
    DBType

    string

    No

    The database type. Valid values: Mysql, null.

    Mysql
    ConfigFile

    string

    No

    The configuration file path.

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

    number

    No

    The access port of the custom component.

    10000
    DefaultStart

    boolean

    No

    Specifies whether the custom component automatically starts. Valid values: true, 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

    Because CreateCluster is an asynchronous operation, the result is returned immediately after the request is sent, without waiting for the nodes to be created. You can call ListTasks to query the task result.

    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. The required parameter is missing: %s.
    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. The specified key pair does not exist. Check whether this parameter is correct.
    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. An error occurred when calling the ACK API.
    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.