Use ResetDisk to roll back a disk from a snapshot - Simple Application Server - Alibaba Cloud - Simple Application Server

Operation description

When you roll back a disk by using a snapshot, the corresponding simple application server must be in the Stopped state.
Rolling back a disk to a snapshot causes the incremental data generated after the snapshot was created to be lost. Back up your data before the rollback if necessary.

Precautions

Resetting the system or replacing the image clears the disk data on the server. Snapshots created before the system reset or image replacement are retained but cannot be used for rollback operations.

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

swas-open:ResetDisk

update

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#DiskId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server to which the snapshot belongs.	cn-hangzhou
DiskId	string	Yes	The ID of the disk to be rolled back.	d-bp14wq0149cpp2xy****
ClientToken	string	No	Ensures the idempotence of the request. You can generate a parameter value on your client to ensure that the value is unique across different requests. ClientToken supports only ASCII characters and can be up to 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
SnapshotId	string	Yes	The ID of the snapshot.	s-bp16oazlsold4dks****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	20758A-585D-4A41-A9B2-28DA8F4F534F

Examples

Success response

JSON format

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F"
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	An error occurred while processing your request.
403	IncorrectInstanceStatus.ResetDisk	Rolling back the disk requires the instance to operate in a stopped state.
404	InvalidDiskId.NotFound	The specified DiskId does not exist.
404	InvalidSnapshotId.NotFound	The specified SnapshotId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.