Use the AddNodes API to add compute nodes to an E-HPC cluster - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Adds one or more compute nodes to an E-HPC 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:AddNodes

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the E-HPC cluster. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-FYUr32****
ImageOwnerAlias	string	No	The type of the image. Valid values: system: public image self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image Default value: system.	system
ImageId	string	No	The image ID for the compute nodes. The image must meet the following requirements: The operating system that is specified by the image must be the same as that of the existing cluster nodes. For example, if the operating system of the cluster nodes is 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 nodes is Windows. The major version of the image specified for the compute nodes that you want to add is the same as that of the image of the cluster. For example, if the version of the cluster image is CentOS 7.x, the version of the image specified for the compute nodes must be CentOS 7.x. You can call the ListImages and ListCustomImages operations to query the image ID.	centos_7_06_64_20G_alibase_20190711.vhd
Count	integer	Yes	The number of compute nodes that you want to add. Valid values: 1 to 99. The value of this parameter is greater than that of the MinCount parameter. If the number of available ECS instances is less than the value of the MinCount parameter, the compute nodes cannot be added. If the number of available ECS instances is greater than the value of the MinCount parameter and less than that of the Count parameter, the compute nodes are added based on the value of the MinCount parameter. If the number of available ECS instances is greater than the value of the Count parameter, the compute nodes are added based on the value of the Count parameter.	10
InstanceType	string	No	The instance type of the compute nodes. Defaults to the instance type specified during cluster creation or the last node addition.	ecs.n1.tiny
ComputeSpotStrategy	string	No	The preemption policy of the compute nodes. Takes effect only when EcsChargeType is set to PostPaid. Valid values: NoSpot: The instance is a regular pay-as-you-go instance. SpotWithPriceLimit: Uses preemptible instances with a maximum hourly price. SpotAsPriceGo: Uses preemptible instances at the current market price. Default value: NoSpot.	NoSpot
ComputeSpotPriceLimit	string	No	The maximum hourly price of the compute nodes. Supports up to three decimal places. Takes effect only when SpotStrategy is set to SpotWithPriceLimit.	0.68
EcsChargeType	string	No	The billing method of the compute nodes. Valid values: PostPaid: pay-as-you-go PrePaid: subscription Default value: PostPaid. If set to PrePaid, auto-renewal is enabled by default. After the E-HPC cluster is released, auto-renewal is disabled.	PostPaid
Period	integer	No	The subscription duration. Unit: specified by PeriodUnit. Takes effect only when InstanceChargeType is set to PrePaid. Valid values: Valid values when PeriodUnit is set to Week: 1, 2, 3, and 4. Valid values when PeriodUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60. Default value: 1.	1
PeriodUnit	string	No	The unit of the subscription period. Valid values: Week Month Default value: Month.	Month
AutoRenew	string	No	Whether to enable auto-renewal. Takes effect only when EcsChargeType is set to PrePaid. Valid values: true: enables auto-renewal false: disables auto-renewal Default value: true.	true
AutoRenewPeriod	integer	No	The auto-renewal period of the subscription compute nodes. Takes effect when AutoRenew is set to true. Valid values when PeriodUnit is set to Week: 1, 2, and 3. Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, and 12. Default value: 1.	1
JobQueue	string	No	The queue to which the compute nodes are added.	workq
CreateMode	string	No	The mode in which the compute nodes are added. Valid values: manual: The compute nodes are manually added. autoscale: The compute nodes are automatically added. Default value: manual.	manual
SystemDiskType	string	No	The type of the system disk. Valid values: cloud_efficiency: ultra disk cloud_ssd: SSD cloud_essd: enhanced SSD (ESSD) cloud: basic disk. Disks of this type are retired. Default value: cloud_efficiency.	cloud_ssd
SystemDiskSize	integer	No	The size of the system disk. Unit: GiB. Valid values: 40 to 500. Default value: 40.	40
ZoneId	string	No	The ID of the zone.	cn-hangzhou-b
VSwitchId	string	No	The ID of the vSwitch.	vsw-bp1lfcjbfb099rrjn****
HostNamePrefix	string	No	The hostname prefix for the compute nodes.	compute
HostNameSuffix	string	No	The hostname suffix for the compute nodes.	01
ComputeEnableHt	boolean	No	Whether to enable hyper-threading for the compute node. Valid values: true false Default value: true.	true
AllocatePublicAddress	boolean	No	Whether to allocate a public IP address to the compute nodes. Valid values: true false Default value: false.	false
InternetChargeType	string	No	The billing method of the elastic IP address (EIP). Valid values: PayByBandwidth: pay-by-bandwidth PayByTraffic: pay-by-traffic	PayByTraffic
InternetMaxBandWidthIn	integer	No	The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: If the purchased outbound public bandwidth is less than or equal to 10 Mbit/s, the valid values of the parameter are 1 to 10 and the default value is 10. If the purchased outbound public bandwidth is greater than 10 Mbit/s, the valid values of this parameter are 1 to the amount of the outbound bandwidth that is purchased.	10
InternetMaxBandWidthOut	integer	No	The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0.	10
ClientToken	string	No	The client token used to ensure the idempotence of the request. The token must be unique across requests, 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
SystemDiskLevel	string	No	The performance level of the ESSD to be used as the system disk. Default value: PL1. Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read/write IOPS. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. Default value: PL1. For more information about ESSD performance parameters, see ESSD.	PL0
MinCount	integer	No	The minimum number of the compute nodes that you want to add. Valid values: 1 to 99. The value of the parameter is less than that of the Count parameter. If the number of available ECS instances is less than the value of the MinCount parameter, the compute nodes cannot be added. If the number of available ECS instances is greater than the value of the MinCount parameter and less than that of the Count parameter, the compute nodes are added based on the value of the MinCount parameter. If the number of available ECS instances is greater than the value of the Count parameter, the compute nodes are added based on the value of the Count parameter. Default value: 1.	1
Sync	boolean	No	Whether to run this operation synchronously. Valid values: true false Default value: false.	false
DataDisks	array<object>	No	The list of data disks.
	object	No
DataDiskSize	integer	No	The size of the data disk. Unit: GB. Valid values: 40 to 500. Default value: 40. Valid values of N: 0 to 16.	40
DataDiskCategory	string	No	The type of the data disk. Valid values: cloud_efficiency: ultra disk cloud_ssd: SSD cloud_essd: ESSD cloud: basic disk Default value: cloud_efficiency. Valid values of N: 0 to 16.	cloud_efficiency
DataDiskDeleteWithInstance	boolean	No	Whether the data disk is released when the node is released. Valid values: true false Default value: true. Valid values of N: 0 to 16.	true
DataDiskPerformanceLevel	string	No	The performance level of the ESSD used as the data disk. Takes effect only when DataDisks.N.DataDiskCategory is set to cloud_essd. Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read/write IOPS. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. Default value: PL1. Valid values of N: 0 to 16.	PL1
DataDiskEncrypted	boolean	No	Whether to encrypt the data disk. Valid values: true false Default value: false. Valid values of N: 0 to 16.	false
DataDiskKMSKeyId	string	No	The KMS key ID of the data disk. Valid values of N: 0 to 16.	0e478b7a-4262-4802-b8cb-00d3fb40826X
ComputeSpotDuration	integer	No	The protection period of the preemptible instance. Unit: hours. Valid values: 0 and 1. A value of 0 means no protection period.	1
ComputeSpotInterruptionBehavior	string	No	The interruption mode of the preemptible instance. Only valid value: Terminate, which releases the instance.	Terminate
NetworkInterfaceTrafficMode	string	No	The communication mode of the ENI. Valid values: Standard: uses the TCP communication mode. HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the remote direct memory access (RDMA) communication mode.	Standard
DnsConfig	string	No	The Domain Name System (DNS) settings.	"{\"DnsType\":\"PrivateZone\",\"DnsName\":\"xxxxx\"}"

Response elements

Element	Type	Description	Example
	object
TaskId	string	The ID of the task.	B745C159-3155-4B94-95D0-4B73D4D2****
RequestId	string	The ID of the request.	B745C159-3155-4B94-95D0-4B73D4D2****
InstanceIds	object
InstanceId	array	The instance IDs.
	string	Instance ID. Note If the AddNodes operation is asynchronous (Sync is set to false), the response is returned immediately without waiting for instance creation to complete, so InstanceIds is empty. You can call ListNodes to obtain the instance IDs.	null

Examples

Success response

JSON format

{
  "TaskId": "B745C159-3155-4B94-95D0-4B73D4D2****",
  "RequestId": "B745C159-3155-4B94-95D0-4B73D4D2****",
  "InstanceIds": {
    "InstanceId": [
      "null"
    ]
  }
}

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	InvaildSystemDiskSize	The system disk size must be greater than or equal to image size.	The system disk size must be greater than or equal to image size.
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	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	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
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.
403	InvalidOpt	The specified operation is invalid. Please try again later.	The operation is unknown. Please check arguments and try again later.
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.
404	KeyPairNotFound	The specified KeyPair 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	EipError	The EIP API request failed.	EIP API request 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	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.