Create Compute Nodes for E-HPC Clusters via API - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Creates compute nodes for an Elastic High Performance Computing (E-HPC) cluster in a batch.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The ID of the cluster. You can call ListClusters to query the cluster ID.	ehpc-hz-FYUr32****
QueueName	string	No	The name of the queue to which the compute nodes belong.	test1
Count	integer	No	The number of compute nodes to add. Valid values: 1 to 99. The value must be greater than MinCount. If the available ECS inventory is less than MinCount, the node creation fails. If the available ECS inventory is greater than or equal to MinCount but less than Count, nodes are added based on the number specified by MinCount. If the available ECS inventory is greater than or equal to Count, nodes are added based on the number specified by Count.	10
MinCount	integer	No		10
ComputeNode	NodeTemplate	No	The hardware configuration of the compute nodes.
HPCInterConnect	string	No	The network type for communication between compute nodes. Valid values: vpc eRDMA	vpc
VSwitchId	string	No	The vSwitch ID.	vsw-bp1lfcjbfb099rrjn****
RamRole	string	No	The name of the RAM role attached to the compute nodes in the queue.	AliyunServiceRoleForOOSBandwidthScheduler
HostnamePrefix	string	No	The hostname prefix of the compute nodes in the queue.	compute
HostnameSuffix	string	No	The hostname suffix of the compute nodes in the queue.	demo
KeepAlive	string	No	Specifies whether deletion protection is enabled for the compute nodes.	false
DeploymentSetId	string	No	The ID of the deployment set. You can call DescribeDeploymentSets to query the deployment set ID. Only deployment sets that use the low network latency strategy are supported.	ds-bp1frxuzdg87zh4pzq****
ReservedNodePoolId	string	No	The ID of the reserved node pool.	rnp-756vlp7a
Hostnames	array	No	The ID of the reserved node pool.
	string	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Success	boolean	Indicates whether the operation was successful. Valid values: true: Successful. false: Failed.	true
InstanceIds	array	The list of compute nodes to be created.
	string	The list of compute nodes to be created.	[ "i-uf68t1zu3jkhs8w**", "i-uf6abz34m2714bp", "i-uf65bh2113hlqvyx", "i-uf68t1zu3jkhs8wx", "i-uf6b0mtpx166fxxi", "i-uf6faknz4dy1bit7**" ]

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Success": true,
  "InstanceIds": [
    "[ \"i-uf68t1zu3jkhs8w****\", \"i-uf6abz34m2714bp****\", \"i-uf65bh2113hlqvyx****\", \"i-uf68t1zu3jkhs8wx****\", \"i-uf6b0mtpx166fxxi****\", \"i-uf6faknz4dy1bit7****\" ]"
  ]
}

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	ImageClientVersionTooLow	The image requires a higher ehpcutil version than the cluster currently has, please upgrade the cluster first.	The minimum ehpcutil version required for mirroring is higher than the current cluster version, upgrade the cluster first
403	ConflictOpt	A conflicting operation is running.	A conflicting operation is running. Please try again later.
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	DbError	A database service error occurred.	Database request failed.
406	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
406	InsufficientReservedNodes	There is no more available reserved nodes.	Insufficient number of reserved nodes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.