All Products
Search

This Product

    File Storage NAS:CreateSnapshot

    Document Center

    File Storage NAS:CreateSnapshot

    Last Updated:Nov 07, 2024

    Creates a snapshot.

    Operation description

    • The snapshot feature is in public preview and is provided free of charge. 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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    nas:CreateSnapshotcreate
    • Snapshot
      acs:nas:{#regionId}:{#accountId}:snapshot/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FileSystemIdstringYes

    The ID of the advanced Extreme NAS file system. The value must start with extreme-, for example, extreme-01dd****.

    		extreme-01dd****
    SnapshotNamestringNo

    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 because snapshots whose names start with auto are recognized as auto snapshots.
    		FinanceJoshua
    DescriptionstringNo

    The description of the snapshot.

    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
    RetentionDaysintegerNo

    The retention period of the snapshot.

    Unit: days.

    Valid values:

    • -1 (default). Auto snapshots are permanently retained. After 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 days. After the retention period of auto snapshots expires, the auto snapshots are automatically deleted.
    		30

    Response parameters

    ParameterTypeDescriptionExample
    object
    SnapshotIdstring

    The snapshot ID.

    		s-extreme-snapsho****
    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

    {
  "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 timeSummary of changesOperation
    2024-09-05API Description Update. The API operation is not deprecated.View Change Details