All Products
Search

This Product

    File Storage NAS:CreateSnapshot

    Document Center

    File Storage NAS:CreateSnapshot

    Last Updated:Aug 28, 2026

    Creates a snapshot for an advanced Extreme NAS file system.

    Operation description

    • The snapshot feature is in public preview and free of charge. The 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 the file system is mounted must function as expected. Otherwise, the snapshot cannot be created.

    • 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.

    • Creating a snapshot may temporarily degrade the I/O performance of the file system. We recommend that you create snapshots during off-peak hours.

    • A snapshot captures the file system state at a specific point in time. Incremental data generated after the snapshot is created is not included.

    • Manually created snapshots are retained for up to 15 days after the service is suspended due to overdue payments. Delete unnecessary snapshots regularly to avoid extra fees.

    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

    nas:CreateSnapshot

    create

    *Snapshot

    acs:nas:{#regionId}:{#accountId}:snapshot/*

    		 None 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-, for example, extreme-01dd****.

    extreme-01dd****
    SnapshotName

    string

    No

    The snapshot name.

    Limits:

    • 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 (-).

    • The name cannot start with auto. Names starting with auto are recognized as auto snapshots.

    FinanceJoshua
    Description

    string

    No

    The snapshot description.

    Limits:

    • The description must be 2 to 256 characters in length.

    • The description cannot start with http:// or https://.

    • This parameter is empty by default.

    FinanceDepet
    RetentionDays

    integer

    No

    The retention period of the snapshot.

    Unit: days.

    Valid values:

    • -1 (default). Auto snapshots are permanently retained. When the number of auto snapshots exceeds the upper limit, the earliest auto snapshot is automatically deleted.

    • 1 to 65536: Auto snapshots are retained for the specified number of days and automatically deleted after the retention period expires.

    30

    Response elements

    Element

    Type

    Description

    Example

    object

    SnapshotId

    string

    The snapshot ID.

    s-extreme-snapsho****
    RequestId

    string

    The request ID.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

    Examples

    Success response

    JSON format

    {
  "SnapshotId": "s-extreme-snapsho****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.