All Products
Search
Document Center

Apsara File Storage NAS:CreateSnapshot

Last Updated:Mar 14, 2024

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 an overdue payment. We recommend that you delete unnecessary snapshots at regular intervals to prevent extra fees incurred by the snapshots.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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.