DescribeSnapshots用于查询一个文件系统所有的快照列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSnapshots

系统规定参数。

取值:DescribeSnapshots。

FileSystemType String extreme

文件系统类型,可选值:extreme。

FileSystemId String extreme-22f****

指定的文件系统ID。

SnapshotIds String s-extreme-67pxwk9aevrkr****,s-extreme-snapsho****,s-extreme-6tmsbas6ljhwh****

快照标识编码。取值可以由多个快照ID组成,多个ID用半角逗号(,)隔开,最多支持100个ID。

SnapshotName String FinanceJoshua

快照名称。

SnapshotType String all

快照类型。取值范围:

  • auto:自动快照
  • user:手动创建的快照
  • all(默认):所有快照类型
Status String all

快照状态。取值范围:

  • progressing:正在创建的快照
  • accomplished:创建成功的快照
  • failed:创建失败的快照
  • all(默认):所有快照状态
PageSize Integer 10

分页查询时设置的每页行数。最大值:100,默认值:10。

PageNumber Integer 1

快照列表的页码。起始值:1,默认值:1。

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

快照列表的页码。

PageSize Integer 10

输入时设置的每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Snapshots Array

快照详情集合。

Snapshot
CreateTime String 2014-07-24T13:00:52Z

创建时间。按照ISO 8601标准表示,并需要使用UTC时间。格式为:yyyy-MM-ddThh:mmZ。

Description String FinanceDept

接口说明信息。

EncryptType Integer 1

加密类型。

  • 0:不加密
  • 1:加密
Progress String 100

快照创建进度,单位为百分比。

RemainTime Integer 38

正在创建的快照剩余完成时间,单位为秒。

RetentionDays Integer 30

自动快照保留天数。

SnapshotId String s-extreme-snapsho****

快照ID。

SnapshotName String FinanceJoshua

快照显示名称。如果创建时指定了快照显示名称,则返回。

SourceFileSystemId String extreme-012****

源文件系统ID,如果快照的源文件系统已经被删除,该字段仍旧保留。

SourceFileSystemSize Long 2000

源文件系统容量,单位:GB。

SourceFileSystemVersion String 1

源文件系统版本号。

Status String accomplished

快照状态。取值范围:progressing、accomplished、failed。

TotalCount Integer 36

快照总个数。

示例

请求示例

GET https://nas.cn-hangzhou.aliyuncs.com/?Action=DescribeSnapshots
&FileSystemType=extreme
&<公共请求参数>
…

正常返回示例

XML 格式

<TotalCount>36</TotalCount>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Snapshots>
    <Snapshot>
        <Status>accomplished</Status>
        <SnapshotId>s-extreme-snapsho****</SnapshotId>
        <Progress>100</Progress>
        <SourceFileSystemSize>2000</SourceFileSystemSize>
        <Description>FinanceDept</Description>
        <EncryptType>1</EncryptType>
        <SourceFileSystemVersion>1</SourceFileSystemVersion>
        <CreateTime>2014-07-24T13:00:52Z</CreateTime>
        <SourceFileSystemId>extreme-012****</SourceFileSystemId>
        <RetentionDays>30</RetentionDays>
        <RemainTime>38</RemainTime>
        <SnapshotName>FinanceJoshua</SnapshotName>
    </Snapshot>
</Snapshots>

JSON 格式

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

错误码

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