ListSnapshots - 查询备份点列表 - 云备份

查询备份点列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	分页游标。首次查询无需传入，翻页时传入上一页返回的 NextToken。NextToken 为空说明没有下一页。不能与 Skip 同时使用。	eyJJbmRleCI6NjUwMX0=
MaxResults	integer	否	分页查询时设置的最大返回数量。默认值：10。取值必须大于 1。	10
Skip	integer	否	跳过的数量。必须为非负整数，且为 MaxResults 的整数倍。不能与 NextToken 同时使用。	0
SourceType	string	是	数据源类型。必须与已保护的资源（ProtectedResourceId）的数据源类型一致。目前支持的数据源类型如枚举值所示。枚举值： NAS : 阿里云 NAS 备份 COMMON_FILE_SYSTEM : CPFS 备份 ECS_FILE : ECS 文件备份 COMMON_NAS : 本地 NAS 备份 File : 本地文件备份 OSS : OSS 备份	ECS_FILE
ProtectedResourceId	string	是	已保护的资源 ID。已保护的资源必须存在，且其数据源类型必须与 SourceType 参数一致。	pr-123***7890
VaultId	string	否	存储库 ID。可选过滤条件，传入时仅返回该备份库中的备份点。	v-00030j3c******sn
CompleteTimeStart	integer	否	起始完成时间。UNIX 时间戳，单位为秒。仅返回备份完成时间大于等于该时间的备份点。	1776059082
CompleteTimeEnd	integer	否	截止完成时间。UNIX 时间戳，单位为秒。仅返回备份完成时间小于该时间的备份点。	1776059382
PlanId	string	否	计划 ID。可选过滤条件，传入时仅返回该备份计划下的备份点。	po-0000****123

返回参数

名称	类型	描述	示例值
	object	响应
RequestId	string	请求 ID	17189276-**--**-0FF51B5A41A0
Code	string	返回码。200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
Success	boolean	请求是否成功。 true：成功 false：失败	true
Snapshots	array<object>	备份点列表
	object	备份点信息
Status	string	备份点状态。枚举值： COMPLETE : 备份完成 ARCHIVING : 后台归档中 PARTIAL_COMPLETE : 备份部分完成	COMPLETE
SnapshotHash	string	备份点哈希值。	f2ac5fd243**********************bc4451777be019
VaultId	string	存储备份数据的备份库 ID	v-00030j*******sn
ActualItems	integer	实际节点数	6
BackupType	string	备份类型。取值为 COMPLETE，表示全量备份。	COMPLETE
CreateTime	integer	备份点创建时间（秒）	1607436917
ActualBytes	integer	实际写入数据量（字节）。	600
SourceType	string	数据源类型。取值范围： ECS_FILE：ECS 文件备份 File：本地文件备份 OSS：OSS 备份 NAS：阿里云 NAS 备份 COMMON_NAS：本地 NAS 备份 CONTAINER：容器备份 OTS_TABLE：表格存储备份 COMMON_FILE_SYSTEM：CPFS 备份	ECS_FILE
ClientId	string	当 SourceType 取值为ECS_FILE或 File 时，表示备份客户端 ID。其他时候代表备份数据源的 ID。	c-*********************
BytesTotal	integer	需备份总数据量（字节）。	1000
ItemsDone	integer	完成备份的节点数。	8
CompleteTime	integer	备份完成时间。UNIX 时间戳，单位为秒。	1642496679
Retention	integer	备份保留天数。	7
CreatedTime	integer	备份创建时间。	1642496679
InstanceId	string	备份数据源实例 ID。	i-*********************
ErrorFile	string	记录备份失败信息的文件，包含备份部分完成的信息。	temp/report/123456789/job-xxxxxxxxx_failed.zip
SnapshotId	string	备份点 ID。	s-00047mxg17p26*****b
JobId	string	备份任务 ID。	job-00030j3chkt******2
Path	string	备份路径。	/home
ItemsTotal	integer	需备份总节点数。	10
BytesDone	integer	完成备份的数据量（字节）。	800
Paths	array	备份路径列表。
	string	备份路径。	/home
InstanceName	string	表格存储实例名称。	instancename
TableName	string	表格存储实例的数据表名称。	table2
RangeStart	integer	表格存储备份任务开始执行时间。UNIX 时间，单位为毫秒。	1642492553038
RangeEnd	integer	表格存储备份任务结束执行时间。UNIX 时间，单位为毫秒。	1642521709966
ExpireTime	integer	备份过期时间。	1771901707
StorageClass	string	存储类型。枚举值： ARCHIVE : 归档存储 STANDARD : 标准存储	STANDARD
ArchiveTime	integer	转归档时间。	1640334062
Include	string	备份任务包含的备份路径。	[\"/test/example_cn-huhehaote_3.txt\", \"/test/example_cn-huhehaote_9.txt\", \"/test/example_cn-huhehaote_5.txt\", \"/test/example_cn-huhehaote_1.txt\", \"/test/example_cn-huhehaote_7.txt\"]
Exclude	string	备份任务不包含的备份路径。	[\"/test/example_cn-hangzhou_7.txt\", \"/test/example_cn-hangzhou_1.txt\", \"/test/example_cn-hangzhou_3.txt\", \"/test/example_cn-hangzhou_9.txt\", \"/test/example_cn-hangzhou_6.txt\"]
ProtectedDataSize	integer	保护的源端数据量，单位 Byte。当 SourceType=ECS_FILE 时，表示已保护的云盘容量。	42949672960
PlanId	string	备份计划 ID	po-123***7890
TotalCount	integer	总记录数。	3
MaxResults	integer	最大返回结果数	10
NextToken	string	下一页开始的 Token，NextToken 为空说明没有下一页。	aWQj********MCMy

示例

正常返回示例

JSON格式

{
  "RequestId": "17189276-****-****-****-0FF51B5A41A0",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2ac5fd243**********************bc4451777be019",
      "VaultId": "v-00030j*******sn",
      "ActualItems": 6,
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": 600,
      "SourceType": "ECS_FILE",
      "ClientId": "c-*********************",
      "BytesTotal": 1000,
      "ItemsDone": 8,
      "CompleteTime": 1642496679,
      "Retention": 7,
      "CreatedTime": 1642496679,
      "InstanceId": "i-*********************",
      "ErrorFile": "temp/report/123456789/job-xxxxxxxxx_failed.zip",
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "Path": "/home",
      "ItemsTotal": 10,
      "BytesDone": 800,
      "Paths": [
        "/home"
      ],
      "InstanceName": "instancename",
      "TableName": "table2",
      "RangeStart": 1642492553038,
      "RangeEnd": 1642521709966,
      "ExpireTime": 1771901707,
      "StorageClass": "STANDARD",
      "ArchiveTime": 1640334062,
      "Include": "[\\\"/test/example_cn-huhehaote_3.txt\\\", \\\"/test/example_cn-huhehaote_9.txt\\\", \\\"/test/example_cn-huhehaote_5.txt\\\", \\\"/test/example_cn-huhehaote_1.txt\\\", \\\"/test/example_cn-huhehaote_7.txt\\\"]",
      "Exclude": "[\\\"/test/example_cn-hangzhou_7.txt\\\", \\\"/test/example_cn-hangzhou_1.txt\\\", \\\"/test/example_cn-hangzhou_3.txt\\\", \\\"/test/example_cn-hangzhou_9.txt\\\", \\\"/test/example_cn-hangzhou_6.txt\\\"]",
      "ProtectedDataSize": 42949672960,
      "PlanId": "po-123***7890"
    }
  ],
  "TotalCount": 3,
  "MaxResults": 10,
  "NextToken": "aWQj********MCMy"
}

错误码

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

变更历史

更多信息，参考变更详情。