DescribeSnapshots - File Storage NAS - Alibaba Cloud Documentation Center

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

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 this feature.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
nas:DescribeSnapshots	get	Snapshot acs:nas:{#regionId}:{#accountId}:snapshot/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemType	string	No	The type of the file system. Valid value: extreme, which indicates Extreme File Storage NAS (NAS) file systems.	extreme
FileSystemId	string	No	The ID of the file system.	extreme-22f****
SnapshotIds	string	No	The snapshot IDs. You can specify a maximum of 100 snapshot IDs. You must separate snapshot IDs with commas (,).	s-extreme-67pxwk9aevrkr**,s-extreme-snapsho,s-extreme-6tmsbas6ljhwh**
SnapshotName	string	No	The snapshot name.	FinanceJoshua
SnapshotType	string	No	The type of the snapshot. Valid values: auto: auto snapshot user: manual snapshot all (default): all snapshot types	all
Status	string	No	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. all (default): all snapshot states.	all
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of snapshots returned.	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.	1
Snapshots	array<object>	The details about snapshots.
Snapshot	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	long	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

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-10	The response structure of the API has changed	View Change Details