Adds one or more compute nodes to an E-HPC cluster.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ehpc:AddNodes | WRITE |
|
| 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:
Default value: system. | system |
| ImageId | string | No | The ID of the image that is specified for the compute nodes. The image must meet the following requirements:
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.
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.
| 10 |
| InstanceType | string | No | The instance type of the compute nodes. The default value is the instance type that was specified when you created the E-HPC cluster or the last time when you added compute nodes. | ecs.n1.tiny |
| ComputeSpotStrategy | string | No | The preemption policy of the compute nodes. The parameter only takes effect when EcsChargeType is set to PostPaid. Valid values:
Default value: NoSpot. | NoSpot |
| ComputeSpotPriceLimit | string | No | The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. The parameter only takes effect when SpotStrategy is set to SpotWithPriceLimit. | 0.68 |
| EcsChargeType | string | No | The billing method of the compute nodes. Valid values:
Default value: PostPaid. If the parameter is 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 duration of the subscription. The unit of the duration is specified by the PeriodUnit parameter. The parameter only takes effect when InstanceChargeType is set to PrePaid. Valid values:
Default value: 1. | 1 |
| PeriodUnit | string | No | The unit of the subscription period of the resource. Valid values:
Default value: Month. | Month |
| AutoRenew | string | No | Specifies whether to enable auto-renewal. The parameter takes effect only when EcsChargeType is set to PrePaid. Valid values:
Default value: true. | true |
| AutoRenewPeriod | integer | No | The auto-renewal period of the subscription compute nodes. The parameter takes effect when AutoRenew is set to true.
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:
Default value: manual. | manual |
| SystemDiskType | string | No | The type of the system disk. Valid values:
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 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 |
| ComputeEnableHt | boolean | No | Specifies whether to enable hyper-threading for the compute node. Valid values:
Default value: true. | true |
| 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 |
| ClientToken | string | No | The client token that is used to ensure 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 |
| SystemDiskLevel | string | No | The performance level of the ESSD to be used as the system disk. Default value: PL1. Valid values:
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.
Default value: 1. | 1 |
| Sync | boolean | No | Specifies whether to set this operation as a synchronous operation. Valid values:
Default value: false. | false |
| DataDisks | object [] | No | The list of data disks. | |
| 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:
Default value: cloud_efficiency. Valid values of N: 0 to 16. | cloud_efficiency |
| DataDiskDeleteWithInstance | boolean | No | Specifies whether the data disk is released when the node is released. Valid values:
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. The parameter only takes effect only when the DataDisks.N.DataDiskCategory parameter is set to cloud_essd. Valid values:
Default value: PL1. Valid values of N: 0 to 16. | PL1 |
| DataDiskEncrypted | boolean | No | Specifies whether to encrypt the data disk. Valid values:
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 indicates that the preemptible instance has no protection period. | 1 |
| ComputeSpotInterruptionBehavior | string | No | The interruption mode of the preemptible instance. Default value: Terminate. Set the value to Terminate, which indicates that the instance is released. | Terminate |
| NetworkInterfaceTrafficMode | string | No | The communication mode of the ENI. Valid values:
| Standard |
| DnsConfig | string | No | The information about Domain Name System (DNS) settings. | "{\"DnsType\":\"PrivateZone\",\"DnsName\":\"xxxxx\"}" |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. |
| 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. | - |
| 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 | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-06-29 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
| 2023-06-27 | The Error code has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
| 2023-03-06 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
| 2021-12-23 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||||
|