All Products
Search
Document Center

Elastic High Performance Computing:CreateHybridCluster

Last Updated:Apr 09, 2024

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.

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:CreateHybridClusterWRITE
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ZoneIdstringNo

The ID of the zone.

cn-hangzhou-b
NamestringYes

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.

hybridcluster
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://.

This parameter is empty by default.

TestDescription
EhpcVersionstringNo

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

1.0.0
ClientVersionstringNo

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

1.0.64
OsTagstringYes

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

CentOS_7.2_64
DomainstringNo

The type of the domain account service. Valid values:

  • nis
  • ldap

Default value: nis.

nis
LocationstringNo

The location where the cluster resides. Set the value to OnPremise.

OnPremise
SecurityGroupIdstringNo

You can select an existing security group by its ID.

Note If you specify this parameter, you cannot specify the SecurityGroupName parameter.
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.

Note If you specify this parameter, you cannot specify the SecurityGroupId parameter.
ehpc-SecurityGroup
VpcIdstringYes

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

vpc-b3f3edefefeep0760yju****
VSwitchIdstringYes

The ID of the vSwitch to which the instance connects to.

vsw-bp1lfcjbfb099rrjn****
EcsOrder.Manager.InstanceTypestringNo

The instance type of the management node. Only Proxy Mode is supported.

ecs.n1.tiny
EcsOrder.Compute.InstanceTypestringYes

The instance type of the compute nodes.

ecs.n1.tiny
VolumeTypestringNo

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

NAS
VolumeIdstringNo

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

008b64****
VolumeProtocolstringNo

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

NFS
VolumeMountpointstringNo

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

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

The remote directory to which the file system is mounted.

/RemoteDirectory
OnPremiseVolumeProtocolstringNo

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

NFS
OnPremiseVolumeMountPointstringNo

The mount target of the on-premises file system.

RemoteNasDomain.com
OnPremiseVolumeRemotePathstringNo

The mount path of the on-premises file system.

/RemoteDirectory
OnPremiseVolumeLocalPathstringNo

The path in which the on-premises file system is mounted on the nodes on the cloud.

/OnCloudDirectory
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. The following special characters are supported: () ~ ! @ # $ % ^ & * - = + | { } [ ] : ; ‘ < > , . ? /

Note We recommend that you use HTTPS to call the API operation to prevent password leakage.
123****
KeyPairNamestringNo

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

Note To use an SSH key pair, see Create an SSH key pair.
test
JobQueuestringNo

The default queue of the scale-out nodes.

workq
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmxazb4ph****
HybridClusterOpModestringNo

The mode in which the proxy node manages the offline nodes. Valid values:

  • SSH: indicates management via SSH logon.
  • CA: indicates management through Cloud Assistant.
SSH
SchedulerPreInstallbooleanNo

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.
true
ComputeSpotStrategystringNo

The preemption policy of the compute nodes. Valid values:

  • NoSpot: The compute nodes are pay-as-you-go instances.
  • SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.
  • SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.

Default value: NoSpot.

NoSpot
ComputeSpotPriceLimitfloatNo

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.

0.034
ImageOwnerAliasstringNo

The type of the image. Valid values:

  • system: public image
  • self: custom image
  • others: shared image
  • marketplace: Alibaba Cloud Marketplace image
system
ImageIdstringNo

The IDs of the images.

wi_1607_x64_dtc_zh_40G_alibase****
ClientTokenstringNo

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 do I ensure the idempotence of a request?

123e4567-e89b-12d3-a456-426655440000
MultiOsbooleanNo

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

  • true
  • false

Default value: false.

false
Nodesobject []No

The information about the nodes in the local cluster.

SchedulerTypestringNo

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

  • pbs
  • slurm
  • opengridscheduler
  • deadline

Default value: pbs.

pbs
IpAddressstringNo

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

00b648b****
HostNamestringNo

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

test1
RolestringNo

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

  • Manager: management node
  • Login: logon node
  • Compute: compute node
Compute
AccountTypestringNo

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

  • nis
  • ldap

Default value: nis.

nis
DirstringNo

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

/opt/sge/default/
Applicationobject []No

An array that consists of the information about the software.

TagstringNo

The tag of the software.

OpenMPI_11.1
PostInstallScriptobject []No

The list of post-installation script information.

ArgsstringNo

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

bash file.sh
UrlstringNo

The full path of the post-installation script.

/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 mode of the plug-in. The following modes are supported:

    • oss: The plug-in is downloaded and decompressed from OSS to a local path. The local path is specified by the pluginLocalPath parameter.
    • image: By default, the plug-in is stored in a pre-defined local path. The local path 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"}
OpenldapParobjectNo

The parameter that is used to connect to the OpenLDAP server.

LdapServerIpstringNo

The IP address of the LDAP server.

192.168.1.2
BaseDnstringNo

The BaseDN of the LDAP server.

ehpctest
FallbackHomeDirstringNo

The home directory of the Linux server.

/home
WinAdParobjectNo

The parameter that is used to connect to the Windows AD server.

AdUserstringNo

The AD user.

Administrator
AdUserPasswdstringNo

The password of the AD user.

xxxxxx
AdDcstringNo

The name of the AD domain.

ad-hybrid001.ehpcad.com
AdIpstringNo

The IP address of the AD domain.

192.168.1.2

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

F6757FA4-8FED-4602-B7F5-3550C0842122
TaskIdstring

The ID of the task.

F6757FA4-8FED-4602-B7F5-3550C0842122
ClusterIdstring

The ID of cluster.

ehpc-hz-FYUr32****

Examples

Sample success responses

JSONformat

{
  "RequestId": "F6757FA4-8FED-4602-B7F5-3550C0842122",
  "TaskId": "F6757FA4-8FED-4602-B7F5-3550C0842122",
  "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.
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.
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.
407NotAuthorizedNo authorization is granted.No authorization is granted.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
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-05-19The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    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 request parameters of the API has changed.
    Added Input Parameters: HybridClusterOpMode
2023-03-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    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
2022-11-15The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    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 request parameters of the API has changed.
    Added Input Parameters: Plugin
    Added Input Parameters: OpenldapPar
    Added Input Parameters: WinAdPar