Creates a snapshot.
Operation description
- The snapshot feature is in public preview and is provided free of charge. Apsara File Storage NAS Service Level Agreement (SLA) is not guaranteed in public preview.
- Only advanced 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.
- When you create a snapshot for a file system, the I/O performance of the file system may be degraded for a short period of time. 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 overdue payments. We recommend that you delete unnecessary snapshots at regular intervals to prevent extra fees incurred by the snapshots.
Debugging
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 |
---|---|---|---|---|
nas:CreateSnapshot | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
FileSystemId | string | Yes | The ID of the advanced Extreme NAS file system. The value must start with | extreme-01dd**** |
SnapshotName | string | No | The snapshot name. Limits:
| FinanceJoshua |
Description | string | No | The description of the snapshot. Limits:
| FinanceDepet |
RetentionDays | integer | No | The retention period of the snapshot. Unit: days. Valid values:
| 30 |
Response parameters
Examples
Sample success responses
JSON
format
{
"SnapshotId": "s-extreme-snapsho****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-09-05 | API Description Update. The API operation is not deprecated. | View Change Details |