调用ListSnapshot查询所有的快照列表。

调试

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

请求参数

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

系统规定参数。取值：ListSnapshot。
RegionId String 是 cn-hangzhou

DBFS实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

PageNumber Integer 是 1

当前页码。
PageSize Integer 否 10

分页查询时设置的每页条数。

最大值：100。

默认值：10。
SortKey String 否 SnapshotSize

查询快照时设置排序方式。

与SortType配合使用，取值必须为SnapshotSize或CreatedTime。

取值为SnapshotSize则根据快照容量排序，取值为CreatedTime则根据创建时间排序。

默认根据创建时间倒序排列。
SortType String 否 desc

查询快照时设置排序方式。

与SortKey配合使用，取值必须为asc或desc。

取值为asc则正序排列，取值为desc则正序排列。

默认根据创建时间倒序排列。
FilterKey String 否 SnapshotId

查询快照时的筛选键。

与FilterValue配合使用，取值必须为SnapshotId或SnapshotName。

传入SnapshotId则根据快照ID进行筛选，传入SnapshotName则根据快照名称进行筛选。
FilterValue String 否 s-bp67acfmxazb4p****

查询快照时的筛选值。

与FilterKey配合使用。
FsId String 否 dbfs-GOrr********Yd0VLOyBpg

数据库文件系统ID。
Status String 否 accomplished

快照状态。取值范围：

  • progressing：正在创建的快照。
  • accomplished：创建成功的快照。
  • failed：创建失败的快照。
  • all（默认）：所有快照状态。
SnapshotName String 否 testSnapshotName

快照名称。
SnapshotType String 否 user

快照创建类型。目前仅支持手动快照。

  • user：手动创建快照。
  • all（默认）：所有的快照创建类型。
SnapshotIds String 否 ["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"]

快照标识编码。取值可以由多个快照ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。

返回数据

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

当前页码。
PageSize Integer 10

输入时设置的每页条数。
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。
Snapshots Array of Snapshots

快照集合。
Category String standard

快照类型。
CreationTime String 1609330367000

快照创建时间。
Description String testDescription

快照描述。
LastModifiedTime String 1609330367000

快照最后修改时间。
Progress String 100%

快照进度。
RemainTime Integer 38

正在创建的快照剩余完成时间，单位为秒。
RetentionDays Integer 30

快照保留天数。
SnapshotId String s-bp67acfmxazb4p****

快照ID。
SnapshotName String testSnapshotName

快照显示名称。如果创建时指定了快照显示名称，则返回。
SnapshotType String user

快照创建类型。可能值：

  • auto：自动创建快照。
  • user：手动创建快照。
  • all（默认）：所有的快照创建类型。
SourceFsId String dbfs-bp67acfmxazb4p****

源数据库文件系统ID。
SourceFsSize Integer 20

源数据库文件系统容量。
Status String accomplished

快照状态。可能值：

  • progressing
  • accomplished
  • failed
TotalCount Integer 32

查询结果总条数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListSnapshot
&PageNumber=1
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<ListSnapshotResponse>
      <TotalCount>32</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <PageNumber>1</PageNumber>
      <Snapshots>
            <Status>accomplished</Status>
            <Progress>100%</Progress>
            <Description>testDescription</Description>
            <Category>standard</Category>
            <RetentionDays>30</RetentionDays>
            <SourceFsSize>20</SourceFsSize>
            <SnapshotName>testSnapshotName</SnapshotName>
            <SourceFsId>dbfs-bp67acfmxazb4p****</SourceFsId>
            <SnapshotId>s-bp67acfmxazb4p****</SnapshotId>
            <LastModifiedTime>1609330367000</LastModifiedTime>
            <CreationTime>1609330367000</CreationTime>
            <SnapshotType>user</SnapshotType>
            <RemainTime>38</RemainTime>
      </Snapshots>
</ListSnapshotResponse>

JSON 格式 

{
    "TotalCount": 32,
    "PageSize": 10,
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "PageNumber": 1,
    "Snapshots": [{
        "Status": "accomplished",
        "Progress": "100%",
        "Description": "testDescription",
        "Category": "standard",
        "RetentionDays": 30,
        "SourceFsSize": 20,
        "SnapshotName": "testSnapshotName",
        "SourceFsId": "dbfs-bp67acfmxazb4p****",
        "SnapshotId": "s-bp67acfmxazb4p****",
        "LastModifiedTime": 1609330367000,
        "CreationTime": 1609330367000,
        "SnapshotType": "user",
        "RemainTime": 38
    }]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidRegion.DBFS The region is not supported. 不支持的区域。

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

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