Query file system snapshots with DescribeSnapshots - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries information about one or more snapshots of a specified file system.

Operation description

This feature is in free public preview. During the public preview, the File Storage NAS Service-Level Agreement (SLA) is not guaranteed.
Only Advanced Extreme NAS file systems support this feature.

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:DescribeSnapshots

get

*Snapshot

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemType	string	No	The file system type. Valid values: extreme (Extreme NAS file system) Valid values: extreme : Extreme NAS file system.	extreme
FileSystemId	string	No	The ID of the file system.	extreme-22f****
SnapshotIds	string	No	The snapshot IDs. You can specify multiple snapshot IDs separated by commas (,). A maximum of 100 IDs are supported.	s-extreme-67pxwk9aevrkr**,s-extreme-snapsho,s-extreme-6tmsbas6ljhwh**
SnapshotName	string	No	The snapshot name.	FinanceJoshua
SnapshotType	string	No	The snapshot type. Valid values: auto: automatic snapshot user: manually created snapshot all (default): all snapshot types Valid values: all : all snapshot types. auto : automatic snapshot. user : manually created snapshot.	all
Status	string	No	The snapshot status. Valid values: progressing: The snapshot is being created. accomplished: The snapshot is created. failed: The snapshot failed to be created. all (default): all snapshot statuses Valid values: all : all snapshot statuses. accomplished : The snapshot is created. progressing : The snapshot is being created. failed : The snapshot failed to be created.	all
PageSize	integer	No	The number of entries per page in a paged query. Settings for the number of rows per page in paging. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number of the snapshot list. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of snapshots.	36
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number of the snapshot list.	1
Snapshots	object
Snapshot	array<object>	The snapshot details.
	object
Status	string	The status of the snapshot. Valid values: progressing: The snapshot is being created. accomplished: The snapshot is created. failed: The snapshot fails to be created.	accomplished
Progress	string	The progress of the snapshot creation. The value of this parameter is expressed as a percentage.	100
CreateTime	string	The time when the snapshot was created. The time follows the ISO 8601 standard in UTC. The time is displayed in the `yyyy-MM-ddThh:mmZ` format.	2014-07-24T13:00:52Z
SourceFileSystemId	string	The ID of the source file system. This parameter is retained even if the source file system of the snapshot is deleted.	extreme-012****
RetentionDays	integer	The retention period of the auto snapshot. Unit: days. Valid values: -1: 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
RemainTime	integer	The remaining time that is required to create the snapshot. Unit: seconds.	38
SourceFileSystemSize	integer	The capacity of the source file system. Unit: GiB.	2000
SourceFileSystemVersion	string	The version of the source file system.	1
SnapshotName	string	The snapshot name. If you specify a name to create a snapshot, the name of the snapshot is returned. Otherwise, no value is returned for this parameter.	FinanceJoshua
EncryptType	integer	Indicates whether the snapshot is encrypted. Valid values: 0: The snapshot is not encrypted. 1: The snapshot is encrypted.	1
Description	string	The description of the snapshot.	FinanceDept
SnapshotId	string	The snapshot ID.	s-extreme-snapsho****
FileSystemType	string	The type of the file system.	extreme
SnapshotType	string	The snapshot type. Valid values: auto: automatically created snapshots user: manually created snapshots	user
CompletedTime	string	The time when snapshot creation was complete. The time follows the ISO 8601 standard in UTC. The time is displayed in the `yyyy-MM-ddThh:mmZ` format. Note This parameter is valid only when the snapshot is created. During snapshot creation, the value of this parameter is the same as that of CreateTime.	2014-07-24T13:10:52Z

Examples

Success response

JSON format

{
  "TotalCount": 36,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "Progress": "100",
        "CreateTime": "2014-07-24T13:00:52Z",
        "SourceFileSystemId": "extreme-012****",
        "RetentionDays": 30,
        "RemainTime": 38,
        "SourceFileSystemSize": 2000,
        "SourceFileSystemVersion": "1",
        "SnapshotName": "FinanceJoshua",
        "EncryptType": 1,
        "Description": "FinanceDept",
        "SnapshotId": "s-extreme-snapsho****",
        "FileSystemType": "extreme",
        "SnapshotType": "user",
        "CompletedTime": "2014-07-24T13:10:52Z"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.