调用ListSnapshot查询快照_数据库文件存储(DBFS)-阿里云帮助中心

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

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dbfs:ListSnapshot	get	Snapshot `acs:dbfs:{#regionId}:{#accountId}:snapshot/`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	DBFS 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
PageNumber	integer	否	当前页码。	1
PageSize	integer	否	分页查询时设置的每页条数。最大值：100。默认值：10。	10
SortKey	string	否	查询快照时设置排序方式。与 SortType 配合使用，取值必须为 SnapshotSize 或 CreatedTime。取值为 SnapshotSize 则根据快照容量排序，取值为 CreatedTime 则根据创建时间排序。默认根据创建时间倒序排列。	SnapshotSize
SortType	string	否	查询快照时设置排序方式。与 SortKey 配合使用，取值必须为 asc 或 desc。取值为 asc 则正序排列，取值为 desc 则降序排列。默认根据创建时间倒序排列。	desc
FilterKey	string	否	查询快照时的筛选键。与 FilterValue 配合使用，取值必须为 SnapshotId 或 SnapshotName。传入 SnapshotId 则根据快照 ID 进行筛选，传入 SnapshotName 则根据快照名称进行筛选。	SnapshotId
FilterValue	string	否	查询快照时的筛选值。与 FilterKey 配合使用。	s-bp67acfmxazb4p****
FsId	string	否	数据库文件系统 ID。	dbfs-GOrr********Yd0VLOyBpg
Status	string	否	快照状态。取值范围： progressing：正在创建的快照。 accomplished：创建成功的快照。 failed：创建失败的快照。 all（默认）：所有快照状态。	accomplished
SnapshotName	string	否	快照名称。	testSnapshotName
SnapshotType	string	否	快照创建类型。目前仅支持手动快照。 user：手动创建快照。 all（默认）：所有的快照创建类型。	user
SnapshotIds	string	否	快照标识编码。取值可以由多个快照 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。	["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	查询结果总条数。	32
PageSize	integer	输入时设置的每页条数。	10
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	当前页码。	1
Snapshots	array<object>	快照集合。
Snapshots	object
Status	string	快照状态。可能值： progressing accomplished failed	accomplished
CreationTime	string	快照创建时间。	1609330367000
Progress	string	快照进度。	100%
SourceFsSize	integer	源数据库文件系统容量。	20
RetentionDays	integer	快照保留天数。	30
RemainTime	integer	正在创建的快照剩余完成时间，单位为秒。	38
LastModifiedTime	string	快照最后修改时间。	1609330367000
SnapshotType	string	快照创建类型。可能值： auto：自动创建快照。 user：手动创建快照。 all（默认）：所有的快照创建类型。	user
SnapshotName	string	快照显示名称。如果创建时指定了快照显示名称，则返回。	testSnapshotName
Description	string	快照描述。	testDescription
SourceFsId	string	源数据库文件系统 ID。	dbfs-bp67acfmxazb4p****
SnapshotId	string	快照 ID。	s-bp67acfmxazb4p****
Category	string	快照类型。可能值： standard：标准版。 enterprise：企业版。	standard
SourceFsStripeWidth	integer	源数据库文件系统条带宽度。	1
AccessDeniedDetail	object
PolicyType	string	PolicyType
AuthPrincipalOwnerId	string	AuthPrincipalOwnerId
EncodedDiagnosticMessage	string	EncodedDiagnosticMessage
AuthPrincipalType	string	AuthPrincipalType
AuthPrincipalDisplayName	string	AuthPrincipalDisplayName
NoPermissionType	string	NoPermissionType
AuthAction	string	AuthAction

示例

正常返回示例

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
    }
  ],
  "AccessDeniedDetail": {
    "PolicyType": "",
    "AuthPrincipalOwnerId": "",
    "EncodedDiagnosticMessage": "",
    "AuthPrincipalType": "",
    "AuthPrincipalDisplayName": "",
    "NoPermissionType": "",
    "AuthAction": ""
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-12-31	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-01-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情