Queries one or more restore jobs that meet the specified conditions.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 99. Default value: 10. | 10 |
| RestoreType | string | Yes | The type of the data source. Valid values:
| ECS_FILE |
| Filters | object [] | No | The keys in the filter. | |
| Key | string | No | The key in the filter. Valid values:
| VaultId |
| Values | array | No | The values that you want to match in the filter. | |
| string | No | The value that you want to match in the filter. | ["v-*********************"] | |
| Operator | string | No | 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:
Note
If you specify the CompleteTime parameter as a key to query backup jobs, you cannot use the IN operator to perform a match.
| IN |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 1,
"TotalCount": 1,
"RestoreJobs": {
"RestoreJob": [
{
"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": false
},
"CrossAccountType": "SELF_ACCOUNT",
"CrossAccountUserId": 0,
"CrossAccountRoleName": "BackupRole"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history