RecoverCluster - Reset and restore an E-HPC cluster - Elastic High Performance Computing

Resets and restores an E-HPC cluster in the Exception state.

Operation description

Applies only to clusters in the Exception state. Call ListClusters to query cluster IDs and statuses. Export all job data before you proceed. Impacts:

System disks on all nodes are replaced and reconfigured per the original cluster creation settings.
All data on system and data disks is lost, including user data, job data, scheduler queue settings, and auto-scaling queue configurations. NAS file system data is retained.
Self-managed queues are deleted. All nodes are retained and moved to the default queue.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	Cluster ID. The cluster must be in the Exception state. Call ListClusters to query cluster IDs and statuses.	ehpc-hz-FYUr32****
OsTag	string	No	System image tag. Call ListImages and ListCustomImages to query supported image tags.	CentOS_7.2_64
AccountType	string	No	Domain account type. Valid values: nis ldap Default: nis.	nis
SchedulerType	string	No	Scheduler type. Valid values: pbs slurm opengridscheduler deadline Default: pbs.	pbs
ImageOwnerAlias	string	No	Image type. Valid values: system: public image self: custom image others: shared image Default: system.	system
ImageId	string	No	Image ID. Call ListImages and ListCustomImages to query supported images.	m-bp18133n0335yq****
ClientVersion	string	No	E-HPC client version. Defaults to the latest version. Call ListCurrentClientVersion to query the latest version.	1.0.76

Response elements

Element	Type	Description	Example
	object
TaskId	string	Task ID.	18FB21E3-F423-4B84-BB63-D8887A29****
RequestId	string	Request ID.	18FB21E3-F423-4B84-BB63-D8887A29****

Examples

Success response

JSON format

{
  "TaskId": "18FB21E3-F423-4B84-BB63-D8887A29****",
  "RequestId": "18FB21E3-F423-4B84-BB63-D8887A29****"
}

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	InDebt	Your account has overdue payments.	Your account has overdue payments.
400	OrderError.InsufficientBalance	The account balance is insufficient. Please add funds first and try again.	Your account has overdue payments. Add funds to your account and try again.
400	OrderError.InstHasUnpaidOrder	Your account has an unpaid order.	Your account has an unpaid order. Please pay the order and try again.
400	OrderError.Arrearage	Your account balance is less than CNY 100. Please add funds to your account and try again.	Your account balance is less than CNY 100. Add funds to your account and try again.
400	OrderError.NoCard	No credit card is bound to your account.	You have not bound a card. Please perform binding first.
400	OrderError.InvalidPayMethod	No valid default payment method is specified for your account.	No valid payment method is found. Please check again.
400	OrderError.NoRealNameAuthentication	You have not completed the real name authentication.	You must complete the real-name verification first.
400	OrderError.NoRealNameRegistration	Real name registration is required for instances launched in mainland China.	To purchase cloud services in mainland China regions on the international site, the user must first complete real-name registration.
400	OrderError.UserProfileIncomplete	You have not completed your user profile.	The user has not completed personal information on the international site.
400	InvalidVpc	The specified VPC is invalid.	The VPC information is invalid.
400	InvalidVolume	The specified volume is invalid.	The specified volume is invalid.
400	InvalidSoftware	The specified software is not supported.	The requested software is not supported.
400	InvalidVolumeProtocal	The specified volume protocol is invalid.	The storage protocol is invalid.
400	InvalidVolumeMountpoint	The specified volume mount point is invalid.	The specified volume mount point is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
403	TooManyClusters	The number of user clusters exceeds the quota.	The number of user clusters exceeds the quota. By default, the number of user clusters cannot exceed three.
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	QuotaExceeded.PrivateIpAddress	Insufficient private IP addresses in vSwitch: %s.	Insufficient private IP addresses in vSwitch: %s.
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	VolumeNotFound	The specified volume does not exist.	The specified storage does not exist. Please verify the parameter.
404	VpcNotFound	The specified VPC does not exist.	The specified VPC does not exist.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance 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	NasError	NAS API request failed.	Failed to request the NAS interface.
406	EipError	The EIP API request failed.	EIP API request failed.
406	OrderError	An order request error occurred.	An order request error occurred.
406	FailToGenId	Generating cluster ID 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.