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

ZoneId String No cn-hangzhou-b

The ID of the zone.

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.

Description String No TestDescription

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

Default value: null

EhpcVersion String No 1.0.0

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

ClientVersion String No 1.0.64

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

OsTag String Yes CentOS_7.2_64

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

Domain String No nis

The service type of the domain account. Valid values:

  • nis
  • ldap

Default value: nis

Location String No OnPremise

The location where the cluster resides. Valid value: OnPremise.

SecurityGroupId String No sg-bp13n61xsydodfyg****

You can select an existing security group.

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

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.

Note If you specify this parameter, you cannot specify the SecurityGroupId parameter at the same time.
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.

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

The instance type of the compute nodes.

VolumeType String No NAS

The type of the file system. Only NAS file systems are supported.

VolumeId String No 008b64****

The ID of the NAS file system. NAS file systems cannot be automatically created in E-HPC.

VolumeProtocol String No NFS

The type of the protocol that is used by the file system. Only NFS is supported.

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

The mount target of the file system. 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 type of the protocol that is used by the on-premises file system. 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 on the nodes on the cloud.

Password String No 123****

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. The password can contain the following special characters:

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

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

Note For more information, see Create an SSH key pair.
JobQueue String No workq

The default queue of the scale-out nodes.

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 or add a node, you do not need to install the scheduler.
  • false: The scheduler is not preinstalled. When you create or add a cluster, you must install the scheduler.
ComputeSpotStrategy String No NoSpot

The preemption policy of the compute nodes. Valid values:

  • NoSpot: The compute nodes 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 for the ECS instance under the compute node. 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.

ImageOwnerAlias String No system

The type of the 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 the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure the idempotence of a request.

MultiOs Boolean No false

Specifies whether the cluster supports multiple operating systems. Valid values:

  • true
  • false

Default value: false

Nodes.N.SchedulerType String No pbs

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

  • pbs
  • slurm
  • opengridscheduler
  • deadline

Default value: pbs

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

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

Nodes.N.HostName String No test1

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

Nodes.N.Role String No Compute

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

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

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

  • nis
  • ldap

Default value: nis

Nodes.N.Dir String No /opt/sge/default/

The directory of the on-premises node in the cluster.

Application.N.Tag String No OpenMPI_11.1

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

PostInstallScript.N.Args String No bash file.sh

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

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

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

Response parameters

Parameter Type Example Description
RequestId String F6757FA4-8FED-4602-B7F5-3550C0842122

The ID of the request.

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

The ID of the task.

ClusterId String ehpc-hz-FYUr32****

The ID of the cluster.

Examples

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 success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 InvalidParams The specified parameter %s is invalid. The error message returned because the following parameter is invalid: %s.
400 NotEnabled You have not enabled this service The error message returned because the service is not activated for your account.
400 InDebt Your account has overdue payments. The error message returned because your account has overdue payments.
400 OrderError.InsufficientBalance The account balance is insufficient. Please add funds first and try again. The error message returned because your account has overdue payments. Add funds to the account and try again.
400 OrderError.InstHasUnpaidOrder Your account has an unpaid order. The error message returned because your account has unsettled orders. Settle them and try again.
400 OrderError.Arrearage Your account balance is less than CNY 100. Please add funds to your account and try again. The error message returned because the balance of your account is less than CNY 100. Add funds to the account and try again.
400 OrderError.NoCard No credit card is bound to your account. The error message returned because no credit card is bound to your account. Bind a credit card and try again.
400 OrderError.InvalidPayMethod No valid default payment method is specified for your account. The error message returned because the default payment method is invalid.
400 OrderError.NoRealNameAuthentication You have not completed the real name authentication. The error message returned because you have not completed real-name verification. Complete real-name verification and try again.
400 OrderError.NoRealNameRegistration Real name registration is required for instances launched in mainland China. The error message returned because you have not completed real-name registration before you purchase cloud services in the Chinese mainland.
400 OrderError.UserProfileIncomplete You have not completed your user profile. The error message returned because you have not provided complete personal information.
400 InvalidVpc The specified VPC is invalid. The error message returned because the specified VPC is invalid.
400 InvalidVolume The specified volume is invalid. The error message returned because the specified NAS file system is invalid.
400 InvalidSoftware The specified software is not supported. The error message returned because the specified software is not supported.
400 InvalidVolumeProtocal The specified volume protocol is invalid. The error message returned because the specified storage protocol is invalid.
400 InvalidVolumeMountpoint The specified volume mount point is invalid. The error message returned because the specified mount target is invalid.
403 TooManyClusters The number of user clusters exceeds the quota. The error message returned because the number of clusters has exceeded the cluster quota, which is three. To raise the quota, submit a ticket.
403 TooManyComputes The number of computing nodes exceeds the quota. The error message returned because the number of compute nodes has exceeded the compute node quota.
403 TooManyLogins The maximum number of logged on nodes is exceeded. The error message returned because the number of logon nodes has exceeded the logon node quota, which is two. To raise the quota, submit a ticket.
403 TooManyScc The maximum number of SCC instances is exceeded. The error message returned because the number of SCC instances has exceeded the SCC instance quota, which is 15. To raise the quota, submit a ticket.
403 QuotaExceeded.PrivateIpAddress Insufficient private IP addresses in vSwitch: %s. The error message returned because the available private IP addresses that can be used by the following vSwitch is insufficient: %s.
403 ConflictOpt A conflicting operation is running. The error message returned because an operation that conflicts with the current operation is in progress. Try again later.
403 ImageNotSupported The specified image is not supported. The error message returned because the selected image is not supported. Change the image and try again.
404 ImageNotFound The specified image does not exist. The error message returned because the specified image does not exist.
404 VolumeNotFound The specified volume does not exist. The error message returned because the specified NAS file system does not exist.
404 VpcNotFound The specified VPC does not exist. The error message returned because the specified VPC does not exist.
406 EcsError An error occurred while calling the ECS API operation. The error message returned because the ECS API call has failed.
406 NasError NAS API request failed. The error message returned because the NAS API call has failed.
406 NasServiceNotOpen The NAS service is not activated. The error message returned because the NAS service is not activated.
406 EipError The EIP API request failed. The error message returned because the operation has failed to call the EIP service.
406 OrderError An order request error occurred. The error message returned because the order request has failed.
406 FailToGenId Generating cluster ID failed. The error message returned because the cluster ID has failed to be generated. Try again later.
406 DbError A database service error occurred. The error message returned because the database request has failed.
406 AliyunError An Alibaba Cloud product error occurred. The error message returned because the operation has failed to call another Alibaba Cloud service.
407 NotAuthorized No authorization is granted. The error message returned because you are not authorized by RAM for the request.
500 UnknownError An unknown error occurred. The error message returned because an unknown error has occurred. Try again later. If the error persists, submit a ticket.
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The service is temporarily unavailable.

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