首页 数据库文件存储 API参考 API目录 快照 ListSnapshot - 查询快照

ListSnapshot - 查询快照

调用ListSnapshot查询用户创建的数据库文件系统快照列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbfs:ListSnapshotList
  • DBFS
    acs:dbfs:{#regionId}:{#accountId}:snapshot/*
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring是

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

cn-hangzhou
PageNumberinteger否

当前页码。

1
PageSizeinteger否

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

最大值：100。

默认值：10。

10
SortKeystring否

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

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

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

默认根据创建时间倒序排列。

SnapshotSize
SortTypestring否

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

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

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

默认根据创建时间倒序排列。

desc
FilterKeystring否

查询快照时的筛选键。

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

传入SnapshotId则根据快照ID进行筛选，传入SnapshotName则根据快照名称进行筛选。

SnapshotId
FilterValuestring否

查询快照时的筛选值。

与FilterKey配合使用。

s-bp67acfmxazb4p****
FsIdstring否

数据库文件系统ID。

dbfs-GOrr********Yd0VLOyBpg
Statusstring否

快照状态。取值范围：

  • progressing：正在创建的快照。

  • accomplished：创建成功的快照。

  • failed：创建失败的快照。

  • all（默认）：所有快照状态。

accomplished
SnapshotNamestring否

快照名称。

testSnapshotName
SnapshotTypestring否

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

  • user：手动创建快照。

  • all（默认）：所有的快照创建类型。

user
SnapshotIdsstring否

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

["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"]

返回参数

名称类型描述示例值
object
TotalCountinteger

查询结果总条数。

32
PageSizeinteger

输入时设置的每页条数。

10
RequestIdstring

请求ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

当前页码。

1
Snapshotsarray

快照集合。

object
Statusstring

快照状态。可能值：

  • progressing

  • accomplished

  • failed

accomplished
CreationTimestring

快照创建时间。

1609330367000
Progressstring

快照进度。

100%
SourceFsSizeinteger

源数据库文件系统容量。

20
RetentionDaysinteger

快照保留天数。

30
RemainTimeinteger

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

38
LastModifiedTimestring

快照最后修改时间。

1609330367000
SnapshotTypestring

快照创建类型。可能值：

  • auto：自动创建快照。

  • user：手动创建快照。

  • all（默认）：所有的快照创建类型。

user
SnapshotNamestring

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

testSnapshotName
Descriptionstring

快照描述。

testDescription
SourceFsIdstring

源数据库文件系统ID。

dbfs-bp67acfmxazb4p****
SnapshotIdstring

快照ID。

s-bp67acfmxazb4p****
Categorystring

快照类型。可能值：

  • standard：标准版。

  • enterprise：企业版。

standard
SourceFsStripeWidthinteger

源数据库文件系统条带宽度。

1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidRegion.DBFSThe region is not supported.不支持的区域。

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

变更历史

变更时间变更内容概要操作
2022-01-07OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码：400
出参OpenAPI 返回结构发生变更
阿里云首页 数据库文件存储 相关技术圈