Create a disk snapshot via the CreateSnapshot API - Simple Application Server - Alibaba Cloud - Simple Application Server

Creates a snapshot for a specified disk.

Operation description

A snapshot is a backup file of the disk data state at a specific point in time. Snapshots are commonly used for daily data backup, recovery from accidental data operations on servers, recovery from network attacks, and creation of custom images.

Note

Creating snapshots for Simple Application Server is free of charge.

Precautions

You can create up to three snapshots for a single Simple Application Server instance.
The maximum number of snapshots that an Alibaba Cloud account can create is three times the number of Simple Application Server instances created, up to a maximum of 15.
If a server is released upon expiration, the snapshots associated with the server are deleted.
Snapshots created before a system reset or image replacement are retained after the operation, but they cannot be used for rollback.

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

create

*Snapshot

acs:swas-open:{#regionId}:{#accountId}:snapshot/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Simple Application Server instance to which the specified disk belongs.	cn-hangzhou
DiskId	string	Yes	The ID of the disk.	d-bp18kjxg9ebrhsgi****
SnapshotName	string	Yes	The name of the snapshot. The name must be 2 to 50 characters in length and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. It can contain Chinese characters, English letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).	test-SnapshotName
ClientToken	string	No	Ensures the idempotence of the request. You can generate the value from your client to ensure that the value is unique across different requests. ClientToken only supports 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 list of tags. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The tag key specified for the snapshot. Valid values of N: 1 to 20. The tag key cannot be an empty string once specified. It can be up to 64 characters in length and cannot start with aliyun or acs:. It cannot contain `http://` or `https://`.	TestKey
Value	string	No	The tag value specified for the snapshot. Valid values of N: 1 to 20. The tag value can be an empty string. It 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 elements

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

Examples

Success response

JSON format

{
  "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.
500	InternalError	An error occurred while processing your request.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.