All Products
Search
Document Center

Hybrid Backup Recovery:SearchHistoricalSnapshots

Last Updated:Nov 14, 2022

Queries one or more historical backup snapshots that meet the specified conditions.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceTypestringYes

The type of the data source. Valid values:

  • ECS_FILE: backup snapshots for Elastic Compute Service (ECS) files
  • OSS: backup snapshots for Object Storage Service (OSS) buckets
  • NAS: backup snapshots for Apsara File Storage NAS file systems
ECS_FILE
QueryobjectNo

The query conditions. Example:


[
  {
    "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"
  }
]
                                
  • The following fields are supported:

    • VaultId: specifies the ID of the backup vault. This field is required.
    • InstanceId: specifies the ID of the ECS instance. If the SourceType parameter is set to ECS_FILE, this field is required.
    • Bucket: specifies the ID of the OSS bucket. If the SourceType parameter is set to OSS, this field is required.
    • FileSystemId: specifies the ID of the NAS file system. If the SourceType parameter is set to NAS, this field is required.
    • CreateTime: specifies the time when the NAS file system was created. If the SourceType parameter is set to NAS, this field is required.
    • CompleteTime: specifies the time when the backup snapshot was completed.
  • The following operations are supported:

    • MATCH_TERM: exact match.
    • GREATER_THAN: greater than.
    • GREATER_THAN_OR_EQUAL: greater than or equal to.
    • LESS_THAN: less than.
    • LESS_THAN_OR_EQUAL: less than or equal to.
    • BETWEEN: specifies a JSON array as a range. The results must fall within the range in the [Minimum value,maximum value] format.
    • IN: specifies an array as a collection. The results must fall within the collection.
    • NOT_IN: specifies an array as a collection. The results cannot fall within the collection.
LimitintegerNo

The maximum number of rows that you want the current query to return.

To query only the number of matched rows without the need to return specific data, you can set the Limit parameter to 0. Then, the operation returns only the number of matched rows.

10
NextTokenstringNo

The token that is required to obtain the next page of backup snapshots.

caeba0bbb2be03f84eb48b699f0a****

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The token that is required to obtain the next page of backup snapshots.

BE
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
Limitinteger

The number of historical backup snapshots that are displayed on the current page.

10
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
TotalCountinteger

The total number of returned backup snapshots that meet the specified conditions.

20
Snapshotsarray

The historical backup snapshots.

object
Statusstring

The status of the backup job. Valid values:

  • COMPLETE: The backup job is completed.
  • PARTIAL_COMPLETE: The backup job is partially completed.
  • FAILED: The backup job has failed.
COMPLETE
SnapshotHashstring

The hash value of the backup snapshot.

f2fe...
VaultIdstring

The ID of the backup vault that stores the backup snapshot.

v-0003rf9m17pap3ltpqx5
ActualItemslong

The actual number of backup snapshots.

**

Note This parameter is available only for file backup.

6
BackupTypestring

The backup type. Valid value: COMPLETE, which indicates full backup.

COMPLETE
CreateTimelong

This parameter is returned only if the SourceType parameter is set to NAS. This parameter indicates the time when the file system was created. This value is a UNIX timestamp. Unit: seconds.

1607436917
ActualByteslong

The actual amount of backup snapshots after duplicates are removed. Unit: bytes.

600
SourceTypestring

The type of the data source. Valid values:

  • ECS_FILE: backup snapshots for ECS files
  • OSS: backup snapshots for OSS buckets
  • NAS: backup snapshots for NAS file systems
ECS_FILE
Prefixstring

This parameter is returned only if the SourceType parameter is set to OSS. This parameter indicates the prefix of objects that are backed up.

example/
ClientIdstring

This parameter is returned only if the SourceType parameter is set to ECS_FILE. This parameter indicates the ID of the backup client.

c-*********************
BytesTotallong

The total amount of data. Unit: bytes.

1000
ItemsDonelong

The number of objects that are backed up.

**

Note This parameter is available only for file backup.

8
CompleteTimelong

The time when the backup snapshot was completed. This value is a UNIX timestamp. Unit: seconds.

1554347313
Retentionlong

The retention period of the backup snapshot.

7
CreatedTimelong

The time when the backup snapshot was created. This value is a UNIX timestamp. Unit: seconds.

1554347313
Bucketstring

This parameter is returned only if the SourceType parameter is set to OSS. This parameter indicates the name of the OSS bucket.

hbr-backup-oss
ParentSnapshotHashstring

The hash value of the parent backup snapshot.

f2fe..
InstanceIdstring

This parameter is returned only if the SourceType parameter is set to ECS_FILE. This parameter indicates the ID of the ECS instance.

i-*********************
FileSystemIdstring

This parameter is returned only if the SourceType parameter is set to NAS. This parameter indicates the ID of the NAS file system.

005494
ErrorFilestring

The files that record the information about backup failures, including the information about partially completed backups.

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.
StartTimelong

The start time of the backup snapshot. This value is a UNIX timestamp. Unit: seconds.

1554347313
UpdatedTimelong

The time when the backup snapshot was updated. This value is a UNIX timestamp. Unit: seconds.

1554347313
SnapshotIdstring

The ID of the backup snapshot.

s-*********************
JobIdstring

The ID of the backup job.

v-*********************
Pathstring

This parameter is returned only if the SourceType parameter is set to ECS_FILE. This parameter indicates the path to the files that are backed up.

["/home"]
ItemsTotallong

The total number of objects in the data source.

**

Note This parameter is available only for file backup.

10
BytesDonelong

The actual amount of data that is generated by incremental backups. Unit: bytes.

800
Pathsarray

This parameter is returned only if the SourceType parameter is set to NAS. This parameter indicates the path to the files that are backed up.

string

This parameter is returned only if the SourceType parameter is set to NAS. This parameter indicates the path to the files that are backed up.

"/home"
InstanceNamestring

The name of the Tablestore instance.

instancename
TableNamestring

The name of the table in the Tablestore instance.

table2
RangeStartlong

The time when the backup job started. This value is a UNIX timestamp. Unit: seconds.

1642492553038
RangeEndlong

The time when the backup job ended. This value is a UNIX timestamp. Unit: seconds.

1642521709966
ExpireTimelong

The time when the backup snapshot expires.

1640334062

Example

Request example

http(s)://[Endpoint]/?Action=SearchHistoricalSnapshots
&SourceType=ECS_FILE
&Limit=10
&NextToken=caeba0bbb2be03f84eb48b699f0a****
&Common request parameters

Normal return example

JSONFormat

{
  "NextToken": "BE",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Limit": 10,
  "Code": "200",
  "Message": "successful",
  "TotalCount": 20,
  "Snapshots": [
    {
      "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": [
        "\"/home\""
      ],
      "InstanceName": "instancename",
      "TableName": "table2",
      "RangeStart": 1642492553038,
      "RangeEnd": 1642521709966,
      "ExpireTime": 1640334062
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.