Use CreateSnapshot API to Back Up Disk Data - Simple Application Server

Description

A snapshot is a point-in-time backup of a disk. Snapshots can be used to back up data, recover data after accidental instance releases, recover data after network attacks, and create custom images.

Note You are not charged for creating snapshots for simple application servers.

Precautions

You can create up to three snapshots for disks of each simple application server.
The maximum number of snapshots that can be retained in an Alibaba Cloud account is triple of the number of simple application servers that are created. The value cannot be greater than 15.
If a simple application server is automatically released due to expiration, the snapshots created for the server are deleted.
If you create a snapshot for a simple application server before you reset the server, the snapshot is retained after you reset the server but the snapshot cannot be used to roll back the disks of the server.

QPS limits

You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Request parameters


Parameter	Type	Required	Example	Description
RegionId	String	Yes	cn-hangzhou	The region ID of the simple application server to which the disk is attached.
DiskId	String	Yes	d-bp18kjxg9ebrhsgi****	The ID of the disk.
SnapshotName	String	Yes	test-SnapshotName	The name of the snapshot. The name must be 2 to 50 characters in length. It must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
ClientToken	String	No	123e4567-e89b-12d3-a456-426655440000	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The ClientToken value can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.
Action	String	Yes	CreateSnapshot	The operation that you want to perform. Set the value to CreateSnapshot.

Response parameters


Parameter	Type	Example	Description
SnapshotId	String	s-bp16oazlsold4dks****	The ID of the snapshot.
RequestId	String	20758A-585D-4A41-A9B2-28DA8F4F534F	The ID of the request.

Examples

Sample requests

http(s)://swas.cn-hangzhou.aliyuncs.com/?RegionId=cn-hangzhou
&DiskId=d-bp18kjxg9ebrhsgi****
&SnapshotName=test-SnapshotName
&ClientToken=123e4567-e89b-12d3-a456-426655440000	
&Action=CreateSnapshot
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateSnapshotResponse>
    <SnapshotId>s-bp16oazlsold4dks****</SnapshotId>
    <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F	</RequestId>
</CreateSnapshotResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SnapshotId" : "s-bp16oazlsold4dks****",
  "RequestId" : "20758A-585D-4A41-A9B2-28DA8F4F534F\t"
}

Error codes


HTTP status code	Error code	Error message	Description
400	InvalidRemark.ValueNotSupported	The specified parameter Remark is invalid.	The error message returned because the specified snapshot remarks are invalid.
400	InvalidRemark.Duplicate	The specified Remark already exists.	The error message returned because the specified snapshot remarks already exist.
400	IncorrectStatus	The state of the disk or instance does not currently support snapshot creation.	The error message returned because the operation is not supported while the disk or the simple application server is in the current state.
400	InvalidSnapshotName.ValueNotSupported	The specified SnapshotName is invalid.	The error message returned because the specified SnapshotName parameter is invalid.
400	InvalidSnapshotName.Duplicate	The specified SnapshotName already exists.	The error message returned because the specified snapshot name already exists.
403	SnapshotLimitExceed	The maximum number of snapshots in an instance is exceeded.	The error message returned because the maximum number of snapshots that can be created for the simple application server is reached.
403	IncorrectDiskStatus.CreatingSnapshot	A snapshot is being created in the specified disk. Please try again later.	The error message returned because another snapshot is being created for the disk. Wait until the snapshot is created and try again.
404	InvalidDiskId.NotFound	The specified DiskId does not exist.	The error message returned because the specified DiskId parameter is invalid.
500	InternalError	An error occurred while processing your request.	The error message returned because an internal error has occurred. Try again later. If the error persists, submit a ticket.

For a list of error codes, visit the API Error Center.