Create snapshots for a File Storage NAS file system to back up data or create file systems from snapshots - File Storage NAS

Prerequisites

The file system must be in the Running state to create a snapshot for it.

Note

The snapshot feature is available only for advanced Extreme NAS file systems. This feature is available in public preview at no charge. The public preview is not covered by the File Storage NAS Service Level Agreement.

Usage notes

You can create a maximum of 128 manual snapshots and 128 automatic snapshots for a file system.
You cannot create a new snapshot for a file system while another snapshot is being created.
If a file system expires while a snapshot is being created, the file system is released and the snapshot in progress is deleted.
Creating a snapshot may temporarily slow I/O performance. Avoid creating snapshots during peak hours.
A snapshot backs up data at a specific point in time. Any data added or changed on the file system while the snapshot is being created is not captured by the snapshot.

Create a manual snapshot

Create manual snapshots to improve operational fault tolerance.

Manually created snapshots are retained indefinitely. To avoid ongoing charges for snapshot capacity, regularly delete snapshots that you no longer need.
Manually created snapshots are retained indefinitely. However, they are deleted if your service is suspended for 15 days due to an overdue payment.

Log on to the NAS console.
In the left-side navigation pane, choose Data Service > Snapshot.
At the top of the page, select the resource group and region where the target file system is located.
On the Snapshot page, click Manually Create Snapshot.

In the Manually Create Snapshot dialog box, configure the parameters. The following table describes the key parameters.

Parameter

Description

File System

Select the advanced Extreme NAS file system for which you want to create a snapshot.

Retention Period

Select a retention period based on your business requirements.

Custom Duration: Specify a retention period from 1 to 65,536 days.
Permanently retained until the number of snapshots reaches the upper limit: The snapshot is retained until the manual snapshot quota is reached. When the number of manual snapshots exceeds the quota of 128, the system automatically deletes the oldest manual snapshot.

Click OK.

Create an automatic snapshot policy

Use an automatic snapshot policy to schedule regular backups for an advanced Extreme NAS file system. This improves the security and reliability of your data.

An automatic snapshot policy can be applied to multiple file systems.
If the number of automatic snapshots for a file system reaches the quota of 128, the system automatically deletes the oldest automatic snapshot.
If you modify the retention period of an automatic snapshot policy, the new retention period applies only to newly created snapshots. The original retention period still applies to existing snapshots.
If a file system contains a large amount of data, creating a snapshot may take longer than the interval between scheduled creations. In this case, the system skips the next scheduled snapshot.

For example, you schedule automatic snapshots to be created at 09:00, 10:00, 11:00, and 12:00. The system starts to create a snapshot at 09:00 but does not complete the process until 10:20 because the file system is large. The system then skips the 10:00 snapshot and creates the next automatic snapshot at 11:00.
Automatic snapshots are named in the auto_yyyyMMdd_X format.
- auto indicates that the snapshot was created automatically.
- yyyyMMdd indicates the date on which the snapshot is created, where yyyy is the year, MM is the month, and dd is the day.
- X indicates the sequence number of the automatic snapshot created on that day.
For example, auto_20140418_1 indicates the first automatic snapshot that was created on April 18, 2014.

Log on to the NAS console.
In the left-side navigation pane, choose Data Service > Snapshot.
At the top of the page, select the resource group and region where the target file system is located.

Create an automatic snapshot policy.

On the Snapshot page, click the Automatic Snapshot Policy tab.
On the Automatic Snapshot Policy tab, click Create Automatic Snapshot Policy.

In the Create Automatic Snapshot Policy dialog box, configure the parameters. The following table describes the key parameters.

Parameter	Description
Created At	The scheduled times to automatically create snapshots. You can select one or more hours from 00:00 to 23:00. Note Creating a snapshot can temporarily degrade the I/O performance of the file system. Schedule snapshots for off-peak hours.
Recurring Date	The days of the week to create automatic snapshots. You can select one or more days from Monday to Sunday.
Retention Period	The retention period of automatic snapshots. The default is 30 days. The following options are available: Custom Duration: Specify a retention period from 1 to 65,536 days. Permanently retained until the number of snapshots reaches the upper limit: The snapshot is retained until the automatic snapshot quota is reached. When the number of automatic snapshots reaches the quota of 128, the system deletes the oldest automatic snapshot.

Click OK.

Apply the automatic snapshot policy.
1. Find the target automatic snapshot policy and click Apply to File Systems.
2. In the Apply to File Systems dialog box, select the target file system from the File System ID list, and then click > to add it to the Apply to File Systems list.
3. Click OK.
  
  After the policy is applied, the system creates automatic snapshots for the file system according to the policy.

Create a file system from a snapshot

You can create a new file system from a point-in-time snapshot. The new file system is an exact copy of the source file system at the time of the snapshot. This allows you to quickly clone file systems for various use cases. This section describes how to use Python SDK to create a file system from a snapshot.

Important

To restore data from a point-in-time snapshot to an existing file system, first create a new file system from the snapshot. Then, copy the required data from the new file system to your existing one.

Install the Python SDK.

pip install alibabacloud_nas20170626==3.1.3
pip install alibabacloud_tea_openapi
pip install alibabacloud_tea_util

Run the code to create a file system.

Note

Before you call the API operation, configure environment variables for your access credentials. For more information, see Configure environment variables on Linux, macOS, and Windows.

# -*- coding: utf-8 -*-
import os
import sys

from typing import List

from alibabacloud_nas20170626.client import Client as NAS20170626Client
from alibabacloud_credentials.client import Client as CredentialClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_nas20170626 import models as nas20170626_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> NAS20170626Client:
        """
        Use credentials to initialize the client.
        @return: Client
        @throws Exception
        """
        # Use the default credential provider chain. For more information, see https://www.alibabacloud.com/help/en/alibaba-cloud-sdk-262060/latest/configure-credentials-378659.
        credential = CredentialClient()
        config = open_api_models.Config(
            credential=credential
        )
        # For more information about endpoints, see https://api.alibabacloud.com/product/NAS.
        config.endpoint = f'nas.cn-hangzhou.aliyuncs.com'
        return NAS20170626Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_file_system_request = nas20170626_models.CreateFileSystemRequest(
            file_system_type='extreme',
            charge_type='PayAsYouGo',
            capacity=100,
            storage_type='advance',
            zone_id='cn-hangzhou-k',
            protocol_type='NFS',
            snapshot_id='s-extreme-00******m'
        )
        runtime = util_models.RuntimeOptions()
        try:
            # Print the API response after you run the code.
            client.create_file_system_with_options(create_file_system_request, runtime)
        except Exception as error:
            # This is a sample of error handling. In a production environment, you must handle exceptions with care and not ignore them.
            # Error message
            print(error.message)
            # Troubleshooting URL
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_file_system_request = nas20170626_models.CreateFileSystemRequest(
            file_system_type='extreme',
            charge_type='PayAsYouGo',
            capacity=100,
            storage_type='advance',
            zone_id='cn-hangzhou-k',
            protocol_type='NFS',
            snapshot_id='s-extreme-00******m'
        )
        runtime = util_models.RuntimeOptions()
        try:
            # Print the API response after you run the code.
            await client.create_file_system_with_options_async(create_file_system_request, runtime)
        except Exception as error:
            # This is a sample of error handling. In a production environment, you must handle exceptions with care and not ignore them.
            # Error message
            print(error.message)
            # Troubleshooting URL
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)


if __name__ == '__main__':
    Sample.main(sys.argv[1:])

The following table describes the key parameters. For more information, see CreateFileSystem.

Parameter	Description
StorageType	The storage type of the file system. Set the value to advance for the Advanced edition. For example, if you create a snapshot named B_Snapshot for an advanced file system and then use B_Snapshot to create a new file system, you must set `StorageType` to `advance`.
ProtocolType	The file access protocol. Extreme NAS file systems support only NFSv3.
Capacity	The storage capacity of the Extreme NAS file system. This value must be the same as the capacity of the original file system from which the snapshot was created. For example, if you create a snapshot named A_Snapshot for a 100 GiB advanced Extreme NAS file system and then use A_Snapshot to create a new file system, you must set `Capacity` to `100`.
ZoneId	The ID of the zone where the new file system will be created. Example: `cn-hangzhou-g`. You can call the DescribeZones operation to query available zones.
SnapshotId	The ID of the snapshot.

Related operations

Actions	Description
Disable an automatic snapshot policy for a file system	To disable an automatic snapshot policy, perform the following steps: On the File System List page, find the target file system and choose More > Snapshot > Set Snapshot Policy. In the Set Snapshot Policy dialog box, turn off the Do you want to apply the policy? switch, and then click OK.
View snapshots	On the Snapshot tab, you can view created snapshots and their information.
Delete a snapshot	On the Snapshot tab, find the target snapshot and click Delete. Warning After a snapshot is deleted, it cannot be recovered. Attempts to create a file system from a deleted snapshot will fail.
View automatic snapshot policies	On the Automatic Snapshot Policy tab, you can view created policies and their details.
View file systems associated with a policy	On the Automatic Snapshot Policy tab, find the target policy and click Apply to File Systems to view the file systems to which the policy is applied.
Modify an automatic snapshot policy	On the Automatic Snapshot Policy tab, find the target policy and click Edit Policy.
Delete an automatic snapshot policy	On the Automatic Snapshot Policy tab, find the target policy and click Delete.

File Storage NAS:Snapshots