SearchHistoricalSnapshots - 获取备份快照 - 混合云备份 HBR

获取一个或者多个符合条件的历史备份快照。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
SourceType	string	是	数据源类型。取值范围： ECS_FILE：表示ECS文件的备份快照。 OSS：表示阿里云OSS的备份快照。 NAS：表示阿里云NAS的备份快照。	ECS_FILE
Query	array	否	查询条件。Query示例如下： `[ { "field": "VaultId", "value": "v-0003rf9m***qx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2*e9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vk***gkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": 1626769913, "operation": "GREATER_THAN_OR_EQUAL" } ]` 支持的field如下： VaultId：必选参数，表示仓库ID。 InstanceId：仅当SourceType=ECS_FILE时，必选参数，表示ECS实例ID。 Bucket ：仅当SourceType=OSS时，必选参数，表示OSS bucket名称。 FileSystemId：仅当SourceType=NAS时，必选参数，表示NAS文件系统ID。 CreateTime ：仅当SourceType=NAS时，必选参数，表示NAS文件系统创建时间。 CompleteTime：快照完成时间。 PlanId：备份计划ID。支持的operation如下： MATCH_TERM：精确匹配。 GREATER_THAN：大于。 GREATER_THAN_OR_EQUAL：大于等于。 LESS_THAN：小于。 LESS_THAN_OR_EQUAL：小于等于。 BETWEEN：区间，value为JSON数组 `[下界,上界]`。 IN：在集合中，value为数组。 NOT_IN：不在集合中，value为数组。
	any	否
Limit	integer	否	本次查询需要返回的最大数量。如果只为了获取行数，无需具体数据，可以设置`limit=0`，即不返回任意一行数据。	10
NextToken	string	否	获取下一页快照所需的Token。	caeba0bbb2be03f84eb48b699f0a****

返回参数

名称	类型	描述	示例值
	object
NextToken	string	获取下一页快照所需的Token。	BE
RequestId	string	请求ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	请求是否成功。 true：成功。 false：失败。	true
Limit	integer	当前页显示历史快照数量。	10
Code	string	返回码，200表示成功。	200
Message	string	返回信息描述，成功一般返回successful，错误时会返回相应错误信息。	successful
TotalCount	integer	符合条件的快照总数。	20
Snapshots	array	历史快照列表。
	object
Status	string	备份快照任务的状态。取值范围： COMPLETE：成功 PARTIAL_COMPLETE：部分成功 FAILED：失败	COMPLETE
SnapshotHash	string	快照HASH值。	f2fe...
VaultId	string	保存备份库快照的仓库ID。	v-0003rf9m17pap3ltpqx5
ActualItems	long	快照实际项目数。说明目前仅文件备份可用。	6
BackupType	string	备份类型。取值为COMPLETE，表示全量备份。	COMPLETE
CreateTime	long	仅当SourceType取值为NAS时，该参数有效。表示文件系统创建时间。UNIX时间，单位为秒。	1607436917
ActualBytes	long	去重后快照实际数据量。单位为字节。	600
SourceType	string	数据源类型。取值范围： ECS_FILE：ECS文件的备份快照。 OSS：阿里云OSS的备份快照。 NAS：阿里云NAS的备份快照。	ECS_FILE
Prefix	string	仅当SourceType取值为OSS时，该参数有效。表示备份前缀。	example/
ClientId	string	仅当SourceType取值为ECS_FILE时，该参数有效。表示备份客户端ID。	c-*********************
BytesTotal	long	数据源总量。单位为字节。	1000
ItemsDone	long	备份项目数。说明目前仅文件备份可用。	8
CompleteTime	long	备份快照完成时间。UNIX时间，单位为秒。	1554347313
Retention	long	备份快照保留天数。	7
CreatedTime	long	备份快照的创建时间。UNIX时间，单位为秒。	1554347313
Bucket	string	仅当SourceType取值为OSS时，该参数有效。表示OSS bucket名称。	hbr-backup-oss
ParentSnapshotHash	string	父备份的快照HASH值。	f2fe..
InstanceId	string	仅当SourceType取值为ECS_FILE时，该参数有效。表示ECS实例ID。	i-*********************
FileSystemId	string	仅当SourceType取值为NAS时，该参数有效。表示文件系统ID。	005494
ErrorFile	string	记录备份失败信息的文件，包含备份部分完成的信息。	Item Error Message C:\Program Files (x86)\Symantec\Symantec Endpoint Protection\14.3.558.0000.105\Bin\service.dat Open: open \\?\C:\Program Files (x86)\Symantec\Symantec Endpoint Protection\14.3.558.0000.105\Bin\service.dat: The process cannot access the file because it is being used by another process. C:\ProgramData\McAfee\Agent\data\InstallerFiles\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini Open: open \\?\C:\ProgramData\McAfee\Agent\data\InstallerFiles\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini: Access is denied.
StartTime	long	快照开始时间。UNIX时间，单位为秒。	1554347313
UpdatedTime	long	备份快照的更新时间。UNIX时间，单位为秒。	1554347313
SnapshotId	string	备份快照ID。	s-*********************
JobId	string	备份任务ID。	v-*********************
Path	string	仅当SourceType取值为ECS_FILE时，该参数有效。表示备份的文件路径。	["/home"]
ItemsTotal	long	数据源项目总数。说明目前仅文件备份可用。	10
BytesDone	long	增量备份的数据量。单位为字节。	800
Paths	array	备份文件路径列表。
	string	仅当SourceType取值为NAS时，该参数有效。表示备份的文件路径。	"/home"
InstanceName	string	表格存储实例名称。	instancename
TableName	string	表格存储实例的数据表名称。	table2
RangeStart	long	备份任务开始执行时间。UNIX时间，单位为毫秒。	1642492553038
RangeEnd	long	备份任务结束执行时间。UNIX时间，单位为毫秒。	1642521709966
ExpireTime	long	快照到期时间，UNIX时间，单位为秒。	1640334062

示例

正常返回示例

JSON格式

{
  "NextToken": "BE",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Limit": 10,
  "Code": "200",
  "Message": "successful",
  "TotalCount": 20,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "COMPLETE",
        "SnapshotHash": "f2fe...",
        "VaultId": "v-0003rf9m17pap3ltpqx5",
        "ActualItems": 6,
        "BackupType": "COMPLETE",
        "CreateTime": 1607436917,
        "ActualBytes": 600,
        "SourceType": "ECS_FILE",
        "Prefix": "example/",
        "ClientId": "c-*********************",
        "BytesTotal": 1000,
        "ItemsDone": 8,
        "CompleteTime": 1554347313,
        "Retention": 7,
        "CreatedTime": 1554347313,
        "Bucket": "hbr-backup-oss",
        "ParentSnapshotHash": "f2fe..",
        "InstanceId": "i-*********************",
        "FileSystemId": "005494",
        "ErrorFile": "Item\tError Message C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat\tOpen: open \\\\?\\C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat: The process cannot access the file because it is being used by another process. C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini\tOpen: open \\\\?\\C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini: Access is denied.",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "SnapshotId": "s-*********************",
        "JobId": "v-*********************",
        "Path": "[\"/home\"]",
        "ItemsTotal": 10,
        "BytesDone": 800,
        "Paths": {
          "Path": [
            "\"/home\""
          ]
        },
        "InstanceName": "instancename",
        "TableName": "table2",
        "RangeStart": 1642492553038,
        "RangeEnd": 1642521709966,
        "ExpireTime": 1640334062
      }
    ]
  }
}

错误码

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