All Products
Search
Document Center

Hybrid Backup Recovery:DescribeRestoreJobs2

Last Updated:Nov 14, 2022

Queries one or more restore jobs that meet the specified conditions.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.

10
RestoreTypestringYes

The type of the data source. Valid values:

  • ECS_FILE: Elastic Compute Service (ECS) files
  • OSS: Object Storage Service (OSS) buckets
  • NAS: Apsara File Storage NAS file systems
  • OTS_TABLE: Tablestore instances
  • UDM_ECS_ROLLBACK: ECS instances
ECS_FILE
FiltersarrayNo

The key-value of the query filter.

objectNo
KeystringNo

The keys in the filter. Valid values:

  • RegionId: the ID of a region
  • PlanId: the ID of a backup plan
  • JobId: the ID of a backup job
  • VaultId: the ID of a backup vault
  • InstanceId: the ID of an ECS instance
  • Bucket: the name of an OSS bucket
  • FileSystemId: the ID of a file system
  • Status: the status of a backup job
  • CompleteTime: the end time of a backup job
VaultId
ValuesarrayNo

The value of the query filter.

stringNo

The values that you want to match in the filter.

["v-*********************"]
OperatorstringNo

The matching method. Default value: IN. This parameter specifies the operator that you want to use to match a key and a value in the filter. Valid values:

  • EQUAL: equal to
  • NOT_EQUAL: not equal to
  • 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.

**

Note If you specify CompleteTime as a key to query backup jobs, you cannot use the IN operator to perform a match.

IN

Response parameters

ParameterTypeDescriptionExample
object
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
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
PageNumberinteger

The page number of the returned page. Pages start from page 1. Default value: 1.

1
PageSizeinteger

The number of entries returned per page. Valid values: 1 to 99. Default value: 10.

1
TotalCountinteger

The total number of returned entries.

1
RestoreJobsarray

The details about the restore job.

object

The details about the restore job.

SnapshotHashstring

The hash value of the backup snapshot.

f2fe...
Statusstring

The status of the restore job. Valid values:

  • COMPLETE: The restore job is completed.
  • PARTIAL_COMPLETE: The restore job is partially completed.
  • FAILED: The restore job has failed.
COMPLETE
ErrorMessagestring

The error message that is returned for the restore job.

PARTIAL_COMPLETE
ActualItemslong

This parameter is returned only if the SourceType parameter is set to ECS_FILE. This parameter indicates the actual number of objects that are restored by the restore job.

6
VaultIdstring

The ID of the backup vault.

v-0006******q
ActualByteslong

The actual amount of data that is restored after duplicates are removed. Unit: bytes.

600
UdmDetailstring

The details about server backup.

{\"doCopy\":true,\"doBackup\":false,\"instanceName\":\"instance example\",\"appConsistent\":false,\"destinationRegionId\":\"cn-shanghai\",\"enableFsFreeze\":true,\"osNameEn\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"osName\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"diskIdList\":[],\"backupVaultId\":\"\",\"snapshotGroup\":true,\"destinationRetention\":35,\"platform\":\"Windows Server 2012\",\"timeoutInSeconds\":60,\"backupRetention\":1,\"osType\":\"windows\",\"preScriptPath\":\"\",\"postScriptPath\":\"\",\"enableWriters\":true,\"ecsDeleted\":false}
SourceTypestring

The type of the data source. Valid values:

  • ECS_FILE: ECS files
  • OSS: OSS buckets
  • NAS: NAS file systems
  • OTS_TABLE: Tablestore instances
  • UDM_ECS: ECS instances
ECS_FILE
Optionsstring

This parameter is returned only if the SourceType parameter is set to ECS_FILE. This parameter indicates whether Windows VSS is used to define a restoration path.

  • This parameter is available only for Windows ECS instances.
  • If data changes occur in the backup source, the source data must be the same as the data to be backed up before the system sets this parameter to ["UseVSS":true].
  • If you use VSS, you cannot restore data from multiple directories.
{"UseVSS":false}
TargetInstanceIdstring

The ID of the destination instance for the restore job.

i-2ze3m7ktcgw******cs
RestoreTypestring

The type of the restore job.

ECS_FILE
TargetCreateTimelong

This parameter is returned only for NAS file systems. This parameter indicates the time when the file system was created.

1634714531
ItemsDonelong

This parameter is returned only if the SourceType parameter is set to ECS_FILE. This parameter indicates the number of restored objects.

8
BytesTotallong

The total amount of data that is restored from the data source. Unit: bytes.

1000
Excludestring

This parameter is returned only if the SourceType parameter is set to ECS_FILE. This parameter indicates the paths to the files that are excluded from the restore job. The value can be 1 to 255 characters in length.

["/var", "/proc"]
ParentIdstring

The ID of the parent job.

r-0003hd2an3x4dyv0l18b
CompleteTimelong

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

1554347313
CreatedTimelong

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

1554347313
TargetBucketstring

The name of the destination OSS bucket. This parameter is returned only for OSS buckets.

target-bucket
ClusterIdstring

The ID of the client group used for restoration.

cl-000******hp6
TargetFileSystemIdstring

The ID of the destination NAS file system. This parameter is returned only for NAS file systems.

0be9****9c9
Progressinteger

The progress of the restore job. For example, 10000 indicates that the progress is 100%.

10000
ExpireTimelong

The time when the restore job expires.

1634714531
TargetDataSourceIdstring

The ID of the destination data source.

ds-000*****997
TargetPrefixstring

The prefix of objects that are restored. This parameter is returned only for OSS buckets.

"/target"
TargetPathstring

The destination file path of the restore job.

"D:\\rebk"
ErrorFilestring

The list of files that failed to be restored.

"test.csv"
StartTimelong

The start time of the restore job. This value is a UNIX timestamp. Unit: seconds.

1554347313
UpdatedTimelong

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

1554347313
SnapshotIdstring

The ID of the snapshot used for restoration.

s-0002******ga88
RestoreIdstring

The ID of the restore job.

r-0003*****8a
TargetClientIdstring

The ID of the destination client.

c-000e*****397
ItemsTotallong

This parameter is returned only if the SourceType parameter is set to ECS_FILE. This parameter indicates the total number of objects in the data source.

10
Includestring

The paths to the files that are included in the restore job.

["/home/alice/*.pdf", "/home/bob/*.txt"]
BytesDonelong

The amount of data that was restored. Unit: bytes.

800
TargetInstanceNamestring

The name of the destination Tablestore instance.

instancename
TargetTableNamestring

The name of the table that stores the restored data.

tablename
Speedlong

The average speed at which data was restored. Unit: KB/s.

500
TargetTimelong

The time when data was restored to the Tablestore instance. This value is a UNIX timestamp. Unit: seconds.

1642560261
OtsDetailobject

The details about the Tablestore instance.

BatchChannelCountinteger

The number of channels processed by each Tablestore restore job.

2
OverwriteExistingboolean

Indicates whether the existing Tablestore restore job was overwritten.

false
CrossAccountTypestring

The type of cross account backup.

  • SELF_ACCOUNT: Local account backup.
  • CROSS_ACCOUNT: Cross account backup.
SELF_ACCOUNT
CrossAccountUserIdlong

The original account ID of cross account backup managed by the current account.

158975xxxxxx4625
CrossAccountRoleNamestring

The role name created in the original account RAM of cross account backup managed by the current account.

BackupRole

Example

Request example

http(s)://[Endpoint]/?Action=DescribeRestoreJobs2
&PageNumber=1
&PageSize=10
&RestoreType=ECS_FILE
&Filters=[{"Key":"VaultId","Values":["[\"v-*********************\"]"],"Operator":"IN"}]
&Common request parameters

Normal return example

JSONFormat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 1,
  "TotalCount": 1,
  "RestoreJobs": [
    {
      "SnapshotHash": "f2fe...",
      "Status": "COMPLETE",
      "ErrorMessage": "PARTIAL_COMPLETE",
      "ActualItems": 6,
      "VaultId": "v-0006******q",
      "ActualBytes": 600,
      "UdmDetail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
      "SourceType": "ECS_FILE",
      "Options": "{\"UseVSS\":false}",
      "TargetInstanceId": "i-2ze3m7ktcgw******cs",
      "RestoreType": "ECS_FILE",
      "TargetCreateTime": 1634714531,
      "ItemsDone": 8,
      "BytesTotal": 1000,
      "Exclude": "[\"/var\", \"/proc\"]",
      "ParentId": "r-0003hd2an3x4dyv0l18b",
      "CompleteTime": 1554347313,
      "CreatedTime": 1554347313,
      "TargetBucket": "target-bucket",
      "ClusterId": "cl-000******hp6",
      "TargetFileSystemId": "0be9****9c9",
      "Progress": 10000,
      "ExpireTime": 1634714531,
      "TargetDataSourceId": "ds-000*****997",
      "TargetPrefix": "\"/target\"",
      "TargetPath": "\"D:\\\\rebk\"",
      "ErrorFile": "\"test.csv\"",
      "StartTime": 1554347313,
      "UpdatedTime": 1554347313,
      "SnapshotId": "s-0002******ga88",
      "RestoreId": "r-0003*****8a",
      "TargetClientId": "c-000e*****397",
      "ItemsTotal": 10,
      "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
      "BytesDone": 800,
      "TargetInstanceName": "instancename",
      "TargetTableName": "tablename",
      "Speed": 500,
      "TargetTime": 1642560261,
      "OtsDetail": {
        "BatchChannelCount": 2,
        "OverwriteExisting": true
      },
      "CrossAccountType": "SELF_ACCOUNT",
      "CrossAccountUserId": 0,
      "CrossAccountRoleName": "BackupRole"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperate
2022-07-29The response structure of the API operation has changed
Change itemChange content
Output ParametersThe response structure of the API operation has changed