Creates a snapshot.
Description
- Only Extreme NAS file systems support the snapshot feature.
- You can create a maximum of 128 snapshots for a file system.
- The compute node on which a file system is mounted must function as expected. Otherwise, you cannot create a snapshot for the file system.
- You can create only one snapshot for a file system at a time.
- If the file system expires when a snapshot is being created, the file system is released and the snapshot is deleted.
- A short-term compromise in I/O performance of 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. After you create a snapshot, incremental data that is generated in the file system will not be synchronized to the snapshot.
- Manually created snapshots will not be deleted until 15 days after the service is suspended due to an overdue payment. We recommend that you delete unnecessary snapshots at regular intervals to prevent extra fees incurred by the snapshots.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateSnapshot |
The operation that you want to perform. Set the value to CreateSnapshot. |
FileSystemId | String | Yes | Extreme-01dd**** |
The ID of the file system. |
SnapshotName | String | No | FinanceJoshua |
The name of the snapshot. Limits:
|
Description | String | No | FinanceDepet |
The description of the snapshot. Limits:
|
RetentionDays | Integer | No | 30 |
The retention period of the snapshot. Unit: days. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
The ID of the request. |
SnapshotId | String | s-extreme-snapsho**** |
The ID of the snapshot. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=CreateSnapshot
&FileSystemId=Extreme-01dd****
&<Common request parameters>
Sample success responses
XML
format
<SnapshotId>s-extreme-snapsho****</SnapshotId>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
JSON
format
{
"SnapshotId": "s-extreme-snapsho****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Error codes
For a list of error codes, visit the API Error Center.