文档

ListSnapshot - 查询快照

更新时间:

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
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
Snapshotsobject []

快照集合。

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 返回结构发生变更