CreateHybridCluster API reference - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Creates a hybrid cloud cluster.

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:CreateHybridCluster

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ZoneId	string	No	The ID of the zone.	cn-hangzhou-b
Name	string	Yes	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
Description	string	No	The description of the E-HPC cluster. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`. Empty by default.	TestDescription
EhpcVersion	string	No	The version of E-HPC. By default, the latest version is used.	1.0.0
ClientVersion	string	No	The version of the client. By default, the latest version is used.	1.0.64
OsTag	string	Yes	The image tag of the operating system. Call the ListImages operation to query the image tag.	CentOS_7.2_64
Domain	string	No	The type of the domain account service. Valid values: nis ldap Default value: nis.	nis
Location	string	No	The location where the cluster resides. Set the value to OnPremise.	OnPremise
SecurityGroupId	string	No	The ID of an existing security group. Note If you specify this parameter, you cannot specify the `SecurityGroupName` parameter.	sg-bp13n61xsydodfyg****
SecurityGroupName	string	No	The name of a new security group to create. A default policy is applied to the new security group. Note If you specify this parameter, you cannot specify the `SecurityGroupId` parameter.	ehpc-SecurityGroup
VpcId	string	Yes	The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs.	vpc-b3f3edefefeep0760yju****
VSwitchId	string	Yes	The ID of the vSwitch.	vsw-bp1lfcjbfb099rrjn****
EcsOrder.Manager.InstanceType	string	No	The instance type of the management node. Only Proxy Mode is supported.	ecs.n1.tiny
EcsOrder.Compute.InstanceType	string	Yes	The instance type of the compute nodes.	ecs.n1.tiny
VolumeType	string	No	The type of the file system. Only NAS file systems are supported.	NAS
VolumeId	string	No	The ID of the file system. NAS file systems cannot be automatically created.	008b64****
VolumeProtocol	string	No	The type of the protocol that is used by the NAS file system. Only NFS is supported.	NFS
VolumeMountpoint	string	No	The mount target of the NAS file system. The mount target must be of the VPC type. Mount targets cannot be automatically created for NAS file systems.	008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com
RemoteDirectory	string	No	The remote directory to which the file system is mounted.	/RemoteDirectory
OnPremiseVolumeProtocol	string	No	The type of the protocol that is used by the on-premises file system. Only NFS is supported.	NFS
OnPremiseVolumeMountPoint	string	No	The mount target of the on-premises file system.	RemoteNasDomain.com
OnPremiseVolumeRemotePath	string	No	The mount path of the on-premises file system.	/RemoteDirectory
OnPremiseVolumeLocalPath	string	No	The local path on cloud nodes where the on-premises file system is mounted.	/OnCloudDirectory
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 character types: 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****
KeyPairName	string	No	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
JobQueue	string	No	The default queue of the scale-out nodes.	workq
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxazb4ph****
HybridClusterOpMode	string	No	The mode in which the proxy node manages the offline nodes. Valid values: SSH: management via SSH logon. CA: management through Cloud Assistant.	SSH
SchedulerPreInstall	boolean	No	Whether the scheduler is preinstalled for the image. Valid values: true: The scheduler is preinstalled. You do not need to install the scheduler when you create or add a node. false: The scheduler is not preinstalled. You must install the scheduler when you create or add a cluster.	true
ComputeSpotStrategy	string	No	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
ComputeSpotPriceLimit	number	No	The maximum hourly price for the compute node ECS instance. The value supports up to three decimal places. This parameter takes effect only when ComputeSpotStrategy is set to SpotWithPriceLimit.	0.034
ImageOwnerAlias	string	No	The type of the image. Valid values: system: public image self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image	system
ImageId	string	No	The image ID.	wi_1607_x64_dtc_zh_40G_alibase****
ClientToken	string	No	The client token that ensures 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
MultiOs	boolean	No	Whether the cluster supports multiple operating systems. Valid values: true false Default value: false.	false
Nodes	array<object>	No	The information about the nodes in the local cluster.
	object	No	The array of node information.
SchedulerType	string	No	The scheduler type of the on-premises node in the cluster. Valid values: pbs slurm opengridscheduler deadline Default value: pbs.	pbs
IpAddress	string	No	The IP address of the on-premises node in the cluster.	00b648b****
HostName	string	No	The hostname of the on-premises node in the cluster.	test1
Role	string	No	The role of the on-premises node in the cluster. Valid values: Manager: management node Login: logon node Compute: compute node	Compute
AccountType	string	No	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
Dir	string	No	The directory of the on-premises node in the cluster.	/opt/sge/default/
Application	array<object>	No	An array that consists of the information about the software.
	object	No
Tag	string	No	The tag of the software.	OpenMPI_11.1
PostInstallScript	array<object>	No	The list of post-installation script information.
	object	No
Args	string	No	The post-installation script arguments.	bash file.sh
Url	string	No	The full path of the post-installation script.	/opt/job.sh
Plugin	string	No	The plug-in mode configurations. This parameter takes effect only when SchedulerType is set to custom. The value must be a JSON string containing 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"}
OpenldapPar	object	No	The OpenLDAP server connection parameters.
LdapServerIp	string	No	The IP address of the LDAP server.	192.168.1.2
BaseDn	string	No	The BaseDN of the LDAP server.	ehpctest
FallbackHomeDir	string	No	The home directory of the Linux server.	/home
WinAdPar	object	No	The Windows AD server connection parameters.
AdUser	string	No	The AD user.	Administrator
AdUserPasswd	string	No	The password of the AD user.	xxxxxx
AdDc	string	No	The name of the AD domain.	ad-hybrid001.ehpcad.com
AdIp	string	No	The IP address of the AD domain.	192.168.1.2

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	F6757FA4-8FED-4602-B7F5-3550C0842122
TaskId	string	The ID of the task.	F6757FA4-8FED-4602-B7F5-3550C0842122
ClusterId	string	The ID of the cluster.	ehpc-hz-FYUr32****

Examples

Success response

JSON format

{
  "RequestId": "F6757FA4-8FED-4602-B7F5-3550C0842122",
  "TaskId": "F6757FA4-8FED-4602-B7F5-3550C0842122",
  "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.
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.
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
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.