CreateSnapshot - Simple Application Server - Alibaba Cloud Documentation Center

Creates a snapshot for a disk.

Operation description

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

Note You are not charged for creating snapshots for disks of 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 the number of simple application servers that you maintain. 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 reset the simple application server after you create a snapshot for a server, the snapshot is retained but cannot be used to roll back the disks of the server.

QPS limit

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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
swas-open:CreateSnapshot	create	Snapshot acs:swas-open:{#regionId}:{#accountId}:snapshot/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server to which the disk is attached.	cn-hangzhou
DiskId	string	Yes	The disk ID.	d-bp18kjxg9ebrhsgi****
SnapshotName	string	Yes	The snapshot name. 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 only contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).	test-SnapshotName
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 you must make sure that the token is unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
Tag	array<object>	No	The tags that you want to add to the snapshot. You can specify up to 20 tags.
	object	No	The tags of the snapshot.
Key	string	No	The key of the tag to add to the snapshot. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.	TestKey
Value	string	No	The value of the tag to add to the snapshot. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.	TestValue
ResourceGroupId	string	No	The ID of the resource group.	rg-aek2bti7cf7****

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	InvalidRemark.ValueNotSupported	The specified parameter Remark is invalid.
400	InvalidRemark.Duplicate	The specified Remark already exists.
400	IncorrectStatus	The state of the disk or instance does not currently support snapshot creation.
400	InvalidSnapshotName.ValueNotSupported	The specified SnapshotName is invalid.
400	InvalidSnapshotName.Duplicate	The specified SnapshotName already exists.
403	SnapshotLimitExceed	The maximum number of snapshots in an instance is exceeded.
403	IncorrectDiskStatus.CreatingSnapshot	A snapshot is being created in the specified disk. Please try again later.
404	InvalidDiskId.NotFound	The specified DiskId does not exist.
500	InternalError	An error occurred while processing your request.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-29	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-02-20	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-05-25	API Description Update. The Error code has changed	View Change Details