获取一个或者多个符合条件的历史备份快照。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hbr:SearchHistoricalSnapshots | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SourceType | string | 是 | 数据源类型。取值范围：
| ECS_FILE |
| Query | array | 是 | 查询条件。Query 示例如下：
| |
| any | 是 | 查询条件。Query 示例如下：
| [ { "field": "VaultId", "value": "v-0003rf9m17pap3ltpqx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2wuzdie9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vkqhpesqgkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": 1626769913, "operation": "GREATER_THAN_OR_EQUAL" } ] | |
| Limit | integer | 否 | 本次查询需要返回的最大数量。
如果只为了获取行数，无需具体数据，可以设置 | 10 |
| NextToken | string | 否 | 获取下一页快照所需的 Token。 | caeba0bbb2be03f84eb48b699f0a**** |
| SortBy | string | 否 | 排序字段。 | CreatedTime |
| Order | string | 否 | 排序方式，默认值为 ASC。
| ASC |
返回参数
示例
正常返回示例
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,
"SourceSnapshotHash": "qwer***",
"SourceParentSnapshotHash": "qwer***",
"StorageClass": "STANDARD",
"ArchiveTime": 1640334062,
"UseCommonNas": false,
"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\\\"]"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-05 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-07-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |