Creates a snapshot.

Precautions

  • You can create a maximum of 128 snapshots for each file system.
  • The compute node on which a file system is mounted must be functioning. Otherwise, you cannot create a snapshot for the file system.
  • You can create only one snapshot at a time.
  • If the file system reaches the expiration time during snapshot creation, the file system is released and the created snapshot is deleted.
  • A short-term decrease in I/O performance for a file system may occur when you create a snapshot for the file system. We recommend that you create snapshots during off-peak hours.
  • A snapshot is a backup of a file system at a specific point in time. During snapshot creation, incremental data that is generated by the operating system will not be synchronized to the snapshot.
  • Manual snapshots remain in a file system for persistent storage. We recommend that you delete snapshots that you do not need on a regular basis to reduce extra costs to your business.
  • Manual snapshots are created for persistent storage. If your account is overdue for longer than 15 days, the manual snapshots will be deleted.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description 
Action String Yes CreateSnapshot

The operation that you want to perform. If you use a custom HTTP URL or HTTPS URL to make an API request, you must specify the Action parameter. Set the value to CreateSnapshot.

FileSystemId String Yes Extreme-01ddddfc

The ID of the file system.

SnapshotName String No FinanceJoshua

The name of the snapshot. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). To avoid duplicate names with automatic snapshots, the name cannot start with auto.

Description String No FinanceDepet

The description of the snapshot. The description must be 2 to 256 characters in length. The description cannot start with http:// or https://. Default value: null.

RetentionDays Integer No 30

The retention period of the snapshot. Unit: days. Default value: -1. Valid values:

  • -1: specifies that the snapshot is created for persistent storage. If the total number of snapshots exceeds the maximum limit, the snapshot is automatically deleted.
  • 1~65536: specifies the number of days to retain the snapshot. If the retention period expires, the snapshot is automatically deleted.

Response parameters

Parameter Type Example Description 
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

SnapshotId String s-extreme-snapshotid1

The ID of the snapshot.

Examples

Sample requests

GET https://nas.cn-hangzhou.aliyuncs.com/?Action=CreateSnapshot
&FileSystemId=1ca404a348
&<Common request parameters>
...

Sample success responses

JSON format

{
  "RequestId": "AB78A546-A85A-44E7-B4A3-C0AAA77B89AF",
  "SnapshotId": "s-extreme-6tmsbas6ljhwhlkh9"
}

Error codes

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