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

请求参数

名称 类型 是否必选 示例值 描述
Action String SearchHistoricalSnapshots

系统规定参数。取值:SearchHistoricalSnapshots

SourceType String ECS_FILE

数据源类型。取值范围:

  • ECS_FILE:表示ECS文件的备份快照。
  • OSS:表示阿里云OSS的备份快照。
  • NAS:表示阿里云NAS的备份快照。
Query Json [ { "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" } ]

查询条件。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:快照完成时间。
  • 支持的operation如下:
    • MATCH_TERM:精确匹配。
    • GREATER_THAN:大于。
    • GREATER_THAN_OR_EQUAL:大于等于。
    • LESS_THAN:小于。
    • LESS_THAN_OR_EQUAL:小于等于。
    • BETWEEN:区间,value为Json数组 [下界,上界]
    • IN:在集合中,value为数组。
    • NOT_IN:不在集合中,value为数组。
Limit Integer 10

本次查询需要返回的最大数量。

如果只为了获取行数,无需具体数据,可以设置limit=0,即不返回任意一行数据。

NextToken String caeba0bbb2be03f84eb48b699f0a****

获取下一页快照所需的Token。

返回数据

名称 类型 示例值 描述
Code String 200

返回码,200表示成功。

Limit Integer 10

当前页显示历史快照数量。

Message String successful

返回信息描述,成功一般返回successful,错误时会返回相应错误信息。

NextToken String BE

获取下一页快照所需的Token。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Snapshots Array of Snapshot

历史快照列表。

Snapshot
ActualBytes Long 600

去重后快照实际数据量。单位为字节。

ActualItems Long 6

快照实际项目数。

说明 目前仅文件备份可用。
BackupType String COMPLETE

备份类型。取值为COMPLETE,表示全量备份。

Bucket String hbr-backup-oss

仅当SourceType取值为OSS时,该参数有效。表示OSS bucket名称。

BytesDone Long 800

增量备份的数据量。单位为字节。

BytesTotal Long 1000

数据源总量。单位为字节。

ClientId String c-*********************

仅当SourceType取值为ECS_FILE时,该参数有效。表示备份客户端ID。

CompleteTime Long 1554347313

备份快照完成时间。UNIX时间,单位为秒。

CreateTime Long 1607436917

仅当SourceType取值为NAS时,该参数有效。表示文件系统创建时间。UNIX时间,单位为秒。

CreatedTime Long 1554347313

备份快照的创建时间。UNIX时间,单位为秒。

FileSystemId String 005494

仅当SourceType取值为NAS时,该参数有效。表示文件系统ID。

InstanceId String i-*********************

仅当SourceType取值为ECS_FILE时,该参数有效。表示ECS实例ID。

ItemsDone Long 8

备份项目数。

说明 目前仅文件备份可用。
ItemsTotal Long 10

数据源项目总数。

说明 目前仅文件备份可用。
JobId String v-*********************

备份任务ID。

ParentSnapshotHash String f2fe..

父备份的快照HASH值。

Path String ["/home"]

仅当SourceType取值为ECS_FILE时,该参数有效。表示备份的文件路径。

Paths List "/home"

仅当SourceType取值为NAS时,该参数有效。表示备份的文件路径。

Prefix String example/

仅当SourceType取值为OSS时,该参数有效。表示备份前缀。

Retention Long 7

备份快照保留天数。

SnapshotHash String f2fe...

快照HASH值。

SnapshotId String s-*********************

备份快照ID。

SourceType String ECS_FILE

数据源类型。取值范围:

  • ECS_FILE:表示ECS文件的备份快照。
  • OSS:表示阿里云OSS的备份快照。
  • NAS:表示阿里云NAS的备份快照。
StartTime Long 1554347313

快照开始时间。UNIX时间,单位为秒。

Status String COMPLETE

备份快照任务的状态。取值范围:

  • COMPLETE:成功
  • PARTIAL_COMPLETE:部分成功
  • FAILED:失败
UpdatedTime Long 1554347313

备份快照的更新时间。UNIX时间,单位为秒。

VaultId String v-0003rf9m17pap3ltpqx5

保存备份库快照的仓库ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。
TotalCount Integer 20

符合条件的快照总数。

示例

请求示例

http(s)://[Endpoint]/?Action=SearchHistoricalSnapshots
&SourceType=ECS_FILE
&<公共请求参数>

正常返回示例

XML格式

<SearchHistoricalSnapshotsResponse>
  <TotalCount>20</TotalCount>
  <NextToken>BE</NextToken>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <Limit>10</Limit>
  <Code>200</Code>
  <Snapshots>
        <Snapshot>
              <CreatedTime>1554347313</CreatedTime>
              <SourceType>ECS_FILE</SourceType>
              <Prefix>example/</Prefix>
              <VaultId>v-0003rf9m17pap3ltpqx5</VaultId>
              <Retention>7</Retention>
              <BytesTotal>1000</BytesTotal>
              <ErrorFile></ErrorFile>
              <ActualItems>6</ActualItems>
              <ItemsDone>8</ItemsDone>
              <BytesDone>800</BytesDone>
              <ClientId>c-*********************</ClientId>
              <FileSystemId>005494</FileSystemId>
              <BackupType>COMPLETE</BackupType>
              <ActualBytes>600</ActualBytes>
              <CompleteTime>1554347313</CompleteTime>
              <JobId>v-*********************</JobId>
              <Path>["/home"]</Path>
              <Status>COMPLETE</Status>
              <InstanceId>i-*********************</InstanceId>
              <ItemsTotal>10</ItemsTotal>
              <CreateTime>1607436917</CreateTime>
              <StartTime>1554347313</StartTime>
              <SnapshotHash>f2fe...</SnapshotHash>
              <SnapshotId>s-*********************</SnapshotId>
              <Bucket>hbr-backup-oss</Bucket>
              <ParentSnapshotHash>f2fe..</ParentSnapshotHash>
              <UpdatedTime>1554347313</UpdatedTime>
              <Paths>
                    <Path>"/home"</Path>
              </Paths>
        </Snapshot>
  </Snapshots>
  <Success>true</Success>
</SearchHistoricalSnapshotsResponse>

JSON格式

{
    "TotalCount": 20,
    "NextToken": "BE",
    "Message": "successful",
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "Limit": 10,
    "Code": 200,
    "Snapshots": {
        "Snapshot": {
            "CreatedTime": 1554347313,
            "SourceType": "ECS_FILE",
            "Prefix": "example/",
            "VaultId": "v-0003rf9m17pap3ltpqx5",
            "Retention": 7,
            "BytesTotal": 1000,
            "ErrorFile": "",
            "ActualItems": 6,
            "ItemsDone": 8,
            "BytesDone": 800,
            "ClientId": "c-*********************",
            "FileSystemId": 5494,
            "BackupType": "COMPLETE",
            "ActualBytes": 600,
            "CompleteTime": 1554347313,
            "JobId": "v-*********************",
            "Path": "[\"/home\"]",
            "Status": "COMPLETE",
            "InstanceId": "i-*********************",
            "ItemsTotal": 10,
            "CreateTime": 1607436917,
            "StartTime": 1554347313,
            "SnapshotHash": "f2fe...",
            "SnapshotId": "s-*********************",
            "Bucket": "hbr-backup-oss",
            "ParentSnapshotHash": "f2fe..",
            "UpdatedTime": 1554347313,
            "Paths": {
                "Path": "\"/home\""
            }
        }
    },
    "Success": true
}

错误码

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