调用DescribeSnapshots查询快照列表_文件存储NAS(NAS)-阿里云帮助中心

查询指定文件系统一个或多个快照的信息。

接口说明

该功能免费公测中，公测期间不保障文件存储 NAS 服务等级协议（SLA）。
仅极速型 NAS 高级型支持该功能。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
FileSystemType	string	否	文件系统类型。取值：extreme（极速型 NAS）	extreme
FileSystemId	string	否	指定文件系统 ID。	extreme-22f****
SnapshotIds	string	否	快照标识编码。可以由多个快照 ID 组成，多个 ID 用半角逗号（,）隔开，最多支持 100 个 ID。	s-extreme-67pxwk9aevrkr**,s-extreme-snapsho,s-extreme-6tmsbas6ljhwh**
SnapshotName	string	否	快照名称。	FinanceJoshua
SnapshotType	string	否	快照类型。取值： auto：自动快照 user：手动创建的快照 all（默认值）：所有快照类型	all
Status	string	否	快照状态。取值： progressing：正在创建的快照 accomplished：创建成功的快照 failed：创建失败的快照 all（默认）：所有快照状态	all
PageSize	integer	否	分页查询时设置的每页行数。取值范围：1~100 默认值：10	10
PageNumber	integer	否	快照列表的页码。起始值（默认值）：1	1

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	快照总个数。	36
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageSize	integer	查询结果每页行数。	10
PageNumber	integer	快照列表的页码。	1
Snapshots	array<object>	快照详情集合。
	object
Status	string	快照状态。包括： progressing：正在创建的快照 accomplished：创建成功的快照 failed：创建失败的快照	accomplished
Progress	string	创建快照的进度。以百分比表示。	100
CreateTime	string	创建时间。按照ISO 8601标准表示，并使用 UTC 时间。格式为：`yyyy-MM-ddThh:mmZ`。	2014-07-24T13:00:52Z
SourceFileSystemId	string	源文件系统 ID。如果快照的源文件系统已经被删除，该字段仍旧保留。	extreme-012****
RetentionDays	integer	自动快照保留天数。单位：天。包括： -1：永久保存，当快照数量达到额度上限后被自动删除。 1~65536：指定保存天数，保留时间到期后快照会被自动释放。	30
RemainTime	integer	正在创建的快照任务剩余完成时间。单位：秒。	38
SourceFileSystemSize	long	源文件系统容量。单位：GiB。	2000
SourceFileSystemVersion	string	源文件系统版本号。	1
SnapshotName	string	快照名称。创建快照时指定了快照名称，则返回快照名称。创建快照时未指定快照名称，则不返回此参数。	FinanceJoshua
EncryptType	integer	加密类型。包括： 0：不加密 1：加密	1
Description	string	接口说明信息。	FinanceDept
SnapshotId	string	快照 ID。	s-extreme-snapsho****
FileSystemType	string	文件系统类型。	extreme
SnapshotType	string	快照创建类型。枚举值： auto: 自动创建快照 user: 手动创建快照	user

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-10	OpenAPI 返回结构发生变更	查看变更详情