Add existing ECS instances as compute nodes to a cluster using AddExistedNodes - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Adds one or more existing ECS instances as compute nodes to a specified cluster.

Operation description

The compute nodes to add must be in the Stopped state.
After the compute nodes are added to the cluster, their operating systems are replaced with the one specified by ImageId.
The hostnames of the compute nodes must differ from those of existing nodes in the cluster. Otherwise, the operation fails.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-FYUr32****
ImageId	string	Yes	The image ID for the compute nodes. The image must meet the following requirements: The image OS must match the OS of existing cluster nodes. For example, if the cluster nodes run CentOS, you can select only a CentOS image. Note If you add nodes to a hybrid cloud cluster that supports multiple operating systems, you can select a Windows Server image or a CentOS image when the operating system of the cluster nodes is Windows. The major version of the image must match that of the cluster image. For example, if the cluster image is CentOS 7.x, the compute node image must also be CentOS 7.x. You can call the ListImages and ListCustomImages operations to obtain the image ID.	centos_7_06_64_20G_alibase_20190711.vhd
JobQueue	string	No	The cluster queue to which the compute node is added.	workq
ImageOwnerAlias	string	Yes	The image type. Valid values: system: public image. self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image Default value: system.	system
Instance	array<object>	Yes	The information about the nodes to add.
	object	No
Id	string	Yes	The Nth node ID. N starts from 1. Valid values: 1 to 100.	i-bp16mxn6mt3t7ftk****

Response elements

Element	Type	Description	Example
	object
TaskId	string	The task ID.	04F0F334-1335-436C-A1D7-6C044FE7****
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****

Examples

Success response

JSON format

{
  "TaskId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****"
}

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.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
403	TooManyComputes	The number of computing nodes exceeds the quota.	The number of computing nodes exceeds the quota.
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
403	InvalidOpt	The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.
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	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
404	VolumeNotFound	The specified volume does not exist.	The specified storage does not exist. Please verify the parameter.
404	ManagerNotFound	The manager nodes do not exist or their status is abnormal.	The manager nodes do not exist or their status is abnormal.
404	ObjectNotFound	The specified object is not found.	The specified object does not exist. Please verify the parameter.
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	DbError	A database service error occurred.	Database request failed.
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
409	PartFailure	Part of the batch operation failed.	Part of the batch operation failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.