Adds pay-as-you-go or preemptible compute nodes to a cluster.
Operation description
Debugging
Authorization information
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**** |
ImageId | string | No | The image ID of the compute nodes to be added. The parameter takes effect only when the TargetImageId parameter is not specified. You can call the ListImages and ListCustomImages operations to query the image ID. Note
If you add multiple compute nodes, the TargetImageId parameter takes effect only on the nodes for which the TargetImageId parameter is specified.
| centos_7_06_64_20G_alibase_20190711.vhd |
ComputeSpotStrategy | string | No | The preemption policy of the compute nodes. Valid values:
Default value: NoSpot. | NoSpot |
ComputeSpotPriceLimit | float | No | The maximum hourly price of the compute nodes. The value is a floating-point number that supports up to three decimal places. The parameter takes effect only when ComputeSpotStrategy is set to SpotWithPriceLimit. If ComputeSpotPriceLimit and InstanceTypeModel.N.MaxPrice are specified at the same time, compute nodes are created based on the smaller value of the two parameters. | 0.68 |
SystemDiskType | string | No | The type of the system disk. Valid values:
| cloud_ssd |
SystemDiskSize | integer | No | The size of the system disk. Unit: GB. Valid values: 40 to 500. Default value: 40. | 40 |
HostNamePrefix | string | No | The prefix of the hostname. You can specify the parameter to manage the compute nodes in an efficient manner. | compute |
HostNameSuffix | string | No | The suffix of the hostname. You can specify the parameter to manage the compute nodes in an efficient manner. | 01 |
AllocatePublicAddress | boolean | No | Specifies whether to allocate a public IP address to the compute nodes. Valid values:
Default value: false. | false |
InternetChargeType | string | No | The billing method of the elastic IP address (EIP). Valid values:
| PayByTraffic |
InternetMaxBandWidthIn | integer | No | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:
| 10 |
InternetMaxBandWidthOut | integer | No | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0. | 10 |
Cores | integer | No | The number of vCPUs. The parameter is required when the ResourceAmountType parameter is set to Cores. You can set vCPU and Memory to query node specifications. For example, you can query the available compute nodes that have 2 vCPUs and 16 GB of memory by setting vCPU to 2 and Memory to 16. You can also query compute nodes by node specification and zone. Query results are sorted by price. The nodes that have the lowest price are created. | 2 |
Memory | integer | No | The memory capacity. The parameter is required when the ResourceAmountType parameter is set to Cores. Unit: GB. You can set vCPU and Memory to query node specifications. For example, you can query the available compute nodes that have 2 vCPUs and 16 GB of memory by setting vCPU to 2 and Memory to 16. You can also query compute nodes by node specification and zone. Query results are sorted by price. The nodes that have the lowest price are created. | 16 |
InstanceFamilyLevel | string | No | The level of the instance family. The parameter takes effect only when Cores and Memory are specified. Valid values:
Default value: EnterpriseLevel. | EntryLevel |
TargetCapacity | integer | Yes | The amount of the resource that you want to add. The specific number depends on the value of the ResourceAmountType parameter:
| 20 |
ResourceAmountType | string | No | The type of the resource that you want to add. Valid values:
Default value: Instances. | Instances |
PriorityStrategy | string | No | The application policy of the preemptible nodes. Valid values:
| LowPriceResourcePlanning |
StrictSatisfiedTargetCapacity | boolean | No | Specifies whether to meet the requirements of the TargetCapacity parameter. Valid values:
Default value: true. | true |
SystemDiskLevel | string | No | The performance level of the ESSD that you want to use as the system disk. Valid values:
Default value: PL0. For more information, see ESSDs . | PL0 |
StrictResourceProvision | boolean | No | Specifies whether to strictly meet the requirements of the TargetCapacity parameter. The parameter takes effect only when StrictSatisfiedTargetCapacity is set to true. Valid values:
Default value: false. | false |
Round | integer | No | The total number of batches to create nodes. Valid values: 1 to 10. Default value: 1. | 1 |
Interval | integer | No | The interval between two consecutive batches. Valid values: 60 to 600. Unit: seconds. Default value: 60. | 60 |
ZoneInfos | object [] | Yes | The details of the zones. You can specify up to 10 zones. | |
VSwitchId | string | Yes | The ID of the vSwitch. Valid values of N: 1 to 10. | vsw-bp1e47optm9g58zcu**** |
ZoneId | string | Yes | The ID of the zone to which the node belongs. Valid values of N: 1 to 10. Note
Each zone ID must be unique.
| cn-hangzhou-b |
InstanceTypeModel | object [] | No | The information about the preemptible instance. | |
MaxPrice | float | No | The maximum hourly price that you can pay for the preemptible node. The value is a floating-point number that supports up to three decimal places. The parameter takes effect only when ComputeSpotStrategy is set to SpotWithPriceLimit. Valid values of N: 1 to 10. | 0.034 |
TargetImageId | string | No | The image ID of the compute node. You must select a Windows image. Valid values of N: 1 to 10. | win2016_1607_x64_dtc_zh-cn_40G_alibase_20210516.vhd |
InstanceType | string | No | The instance type of the compute node. The default value is the instance type that was specified when you created the cluster or the last time you added compute nodes. Valid values of N: 1 to 10. | ecs.n1.tiny |
Tag | object [] | No | The details about the tags that are added to the nodes. | |
Key | string | No | The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://. Valid values of N: 1 to 20. | TestKey |
Value | string | No | The tag value. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with acs: or contain http:// or https://. Valid values of N: 1 to 20. | TestValue |
JobQueue | string | No | The queue to which the compute nodes are added. You can call the ListQueues operation to query the queue name. | workq |
UserData | string | No | The user data of the instance. The user data must be Base64-encoded. The raw data can be up to 16 KB in size. Linux operating systems support shell scripts. Windows operating systems support bat and Powershell scripts. Before you perform Base64 encoding, make sure that the content to be encoded includes [bat] or [powershell] as the first row. Note
We recommend that you do not pass in confidential information, such as passwords or private keys, in plaintext as user data. This is because the system does not encrypt UserData values when API requests are transmitted. If you must pass in confidential information, we recommend that you encrypt and encode the information in Base64, and then decode and decrypt the information in the same way inside the instance.
| ZWNobyBoZWxsbyBlY3Mh |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "B745C159-3155-4B94-95D0-4B73D4D2****",
"SatisfiedAmount": 10,
"TaskId": "B745C159-3155-4B94-95D0-4B73D4D2****",
"Detail": "Resources Application is satisfied. Creating...",
"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 | InvalidVswitch | The vSwitch parameter is invalid, or the number of available IP addresses is insufficient. | The vSwitch parameter is invalid, or the number of available IP addresses is insufficient. |
400 | InvalidImage | The image ID is invalid. | The image ID is invalid. |
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. |
400 | InvalidInstanceType.NotSupported | The instance type is invalid. | The instance type is invalid. |
400 | InvalidZoneId.ValueNotSupported | The specified ZoneId is invalid. | The specified zone ID is invalid. |
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 | InvalidCapacityNum.ValueNotSupported | The specified TargetCapacity is invalid. | The specified target capacity is invalid. |
403 | RecommendEmpty.InstanceTypeSoldOut | The resource is out of stock. | The resource is out of stock. |
403 | ResourceTargetAmount.NotSatisfied | The resource application is not satisfied. | The resource application is not satisfied. |
403 | RecommendEmpty.PriceNotSatisfied | The price limit is not satisfied. | The price limit is not satisfied. |
403 | QuotaExceed.PayasyougoInstance | The pay-as-you-go instance exceeds the quota. | The pay-as-you-go instance exceeds the quota. |
403 | RecommendEmpty.InstanceTypeNoStock | The instanceTypes are out of usage. | The instance type is unavailable. |
403 | RecommendEmpty.InstanceTypeNotAuthorized | The recommend instanceTypes are not authorized. | - |
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 | VswitchNotFound | The specified vSwitch does not exist. | The specified vSwitch does not exist. |
406 | EcsError | An error occurred while calling the ECS API operation. | An error occurred while calling the ECS API operation. |
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. | An Alibaba Cloud product error occurred. |
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. |
500 | UnknownError | An unknown error occurred. | An unknown error occurred. |
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-03-05 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2022-10-12 | The Error code has changed | see changesets | ||||||||||||||||||||||
|