Creates a hybrid cloud cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateHybridCluster

The operation that you want to perform. Set the value to CreateHybridCluster

EcsOrder.Compute.InstanceType String Yes ecs.n1.tiny

The instance type of the compute node.

Name String Yes hybridcluster

The name of the cluster. The name must be 2 to 64 characters in length, and can contain only letters, digits, hyphens (-), and underscores (_). It must start with a letter.

OsTag String Yes CentOS_7.2_64

The image tag of the operating system. You can call the ListImages operation to query the image list.

VpcId String Yes vpc-b3f3edefefeep0760yju****

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

VSwitchId String Yes vsw-bp1lfcjbfb099rrjn****

The ID of the vSwitch.

ZoneId String No cn-hangzhou-b

The ID of the zone to which the cluster belongs.

Description String No TestDescription

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

By default, the value is empty.

EhpcVersion String No 1.0.0

The version number of the E-HPC client. By default, the latest version is used.

ClientVersion String No 1.0.64

The version number of the cluster client. By default, the latest version is used.

Domain String No nis

The service type of the domain account. Valid values:

  • nis
  • ldap

Default value: nis

Nodes.N.HostName String No test1

The hostname of the Nth on-premises node in the cluster.

Nodes.N.IpAddress String No 00b648b****

The IP address of the Nth on-premises node in the cluster.

Nodes.N.Role String No Compute

The role of the Nth node in the on-premises cluster. Valid values:

  • Manager: management node
  • Login: login node
  • Compute: compute node
Nodes.N.AccountType String No nis

The service type of the domain account to which the Nth on-premises node in the cluster belongs. Valid values:

  • nis
  • ldap

Default value: nis

Nodes.N.SchedulerType String No pbs

The scheduler type of the Nth on-premises node in the cluster. Valid values:

  • pbs
  • slurm
  • opengridscheduler
  • deadline

Default value: pbs

Location String No OnPremise

The location where the cluster resides. Only hybrid cloud clusters are supported. Set the value to OnPremise.

SecurityGroupId String No sg-bp13n61xsydodfyg****

You can use the ID of an existing security group to create a cluster.

Note If you specify this parameter, you cannot specify the SecurityGroupName parameter.
SecurityGroupName String No ehpc-SecurityGroup

If you do not use the ID of an existing security group, the value of this parameter is used to create a security group. The default policy is applied to the new security group.

Note If you specify this parameter, you cannot specify the SecurityGroupId parameter.
VolumeType String No NAS

The type of the file system. Only Apsara File Storage NAS is supported.

VolumeId String No 008b64****

The ID of the file system. NAS file systems cannot be automatically created.

VolumeProtocol String No NFS

The protocol type of the shared storage. Only NFS is supported.

VolumeMountpoint String No 008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com

The mount target of the NAS file systems in the VPC. Mount targets cannot be automatically created for NAS file systems.

RemoteDirectory String No NasMountpoint:/RemoteDirectory

The remote directory to which the file system is mounted.

OnPremiseVolumeProtocol String No NFS

The protocol that is used for on-premises shared storage. Only NFS is supported.

OnPremiseVolumeMountPoint String No RemoteNasDomain.com

The mount target of the on-premises file system.

OnPremiseVolumeRemotePath String No /RemoteDirectory

The mount path of the on-premises file system.

OnPremiseVolumeLocalPath String No /OnCloudDirectory

The path in which the on-premises file system is mounted to a node of the E-HPC cluster.

Password String No 123****

The root password that is used to log on to the node. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters can be used:

() ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' < > , . ? /
Note We recommend that you use HTTPS to call the API operation and prevent password leakage.
KeyPairName String No test

The name of the key pair. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

Note To use an SSH key pair, see Create an SSH key pair.
Application.N.Tag String No OpenMPI_11.1

The tag of the Nth application. Valid values of N: 1 to 5.

PostInstallScript.N.Url String No /opt/job.sh

The full path of the Nth post-installation script. Valid values of N: 1 to 16.

PostInstallScript.N.Args String No bash file.sh

The arguments that are used to run the Nth post-installation script. Valid values of N: 1 to 16.

JobQueue String No workq

By default, the queue to which the node to be scaled out is added.

ResourceGroupId String No rg-acfmxazb4ph****

The ID of the resource group.

SchedulerPreInstall Boolean No true

Specifies whether the scheduler is preinstalled for the image. Valid values:

  • true: The scheduler is preinstalled. When you create a node or scale out a cluster, you do not need to install the scheduler.
  • false: The scheduler is not preinstalled. When you create a node or scale out a cluster, you must install the scheduler.
ComputeSpotStrategy String No NoSpot

The preemption policy of the compute node. Valid values:

  • NoSpot: The instances of the compute node are pay-as-you-go instances.
  • SpotWithPriceLimit: The instances of the compute node are preemptible instances. These types of instances have a specified maximum hourly price.
  • SpotAsPriceGo: The instances of the compute node are preemptible instances. The price of these instances is based on the current market price.

Default value: NoSpot

ComputeSpotPriceLimit Float No 0.034

The maximum hourly price of the ECS instance under the compute node. A maximum of three decimal places can be used in the value of this parameter. This parameter is valid only when the ComputeSpotStrategy parameter is set to SpotWithPriceLimit.

ImageOwnerAlias String No system

The type of image. Valid values:

  • system: public image
  • self: custom image
  • others: shared image
  • marketplace: Alibaba Cloud Marketplace image
ImageId String No wi_1607_x64_dtc_zh_40G_alibase****

The ID of the image.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it 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.

MultiOs Boolean No false

Specifies whether the nodes in the cluster can support different operating systems. Valid values:

  • true: The nodes in the cluster can support different operating systems.
  • false: The nodes in the cluster cannot support different operating systems.

Default value: false.

Response parameters

Parameter Type Example Description
ClusterId String ehpc-hz-FYUr32****

The ID of the cluster.

RequestId String F6757FA4-8FED-4602-B7F5-3550C0842122

The ID of the request.

TaskId String F6757FA4-8FED-4602-B7F5-3550C0842122

The ID of the task.

Example

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=CreateHybridCluster
&Name=hybridcluster
&EcsOrder.Compute.InstanceType=ecs.n1.tiny
&OsTag=CentOS_7.2_64
&VpcId=vpc-b3f3edefefeep0760yju****
&VSwitchId=vsw-bp1lfcjbfb099rrjn****
&<Common request parameters>

Sample responses

XML format

<CreateHybridClusterResponse>
        <RequestId>F6757FA4-8FED-4602-B7F5-3550C0842122</RequestId>
        <TaskId>F6757FA4-8FED-4602-B7F5-3550C0842122</TaskId>
        <ClusterId>ehpc-hz-FYUr32****</ClusterId>
</CreateHybridClusterResponse>

JSON format

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

Error codes

HttpCode Error code Error message Description
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The server is temporarily unavailable.

For a list of error codes, visit the API Error Center.