Queries the information about one or more backup 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 number of the page to return. Pages start from page 1. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 99. Default value: 10. | 10 |
SourceType | string | Yes | The type of the data source. Valid values:
| ECS_FILE |
SortDirection | string | No | The order in which you want to sort the results. Valid values:
| DESCEND |
Filters | object [] | No | The keys in the filter. | |
Key | string | No | The key in the filter. Valid values:
| VaultId |
Values | array | No | The variable values of 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
JSON
format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 8,
"BackupJobs": {
"BackupJob": [
{
"Status": "COMPLETE",
"ErrorMessage": "PARTIAL_COMPLETE",
"ActualItems": 6,
"VaultId": "v-0006******q",
"ActualBytes": 600,
"CreateTime": 1607436917,
"BackupType": "COMPLETE",
"Prefix": "example/",
"SourceType": "ECS_FILE",
"Options": "{\"UseVSS\":false}",
"ClientId": "c-*********************",
"ItemsDone": 8,
"BytesTotal": 1000,
"Exclude": "[\"/var\", \"/proc\"]",
"JobName": "jobname",
"CompleteTime": 1554347313,
"CreatedTime": 1554347313,
"Bucket": "hbr-backup-oss",
"Progress": 10000,
"SpeedLimit": "0:24:5120",
"InstanceId": "i-*********************",
"PlanId": "plan-20********35",
"FileSystemId": "005494",
"StartTime": 1554347313,
"UpdatedTime": 1554347313,
"JobId": "job-000g********w7",
"ItemsTotal": 10,
"Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
"BytesDone": 800,
"Paths": {
"Path": [
"\"/home\""
]
},
"Detail": {
"DoCopy": true,
"DestinationNativeSnapshotId": "s-******************",
"DestinationNativeSnapshotProgress": 85,
"DestinationNativeSnapshotStatus": "COMPLETE",
"DestinationRetention": 30,
"DestinationSnapshotId": "s-******************",
"DestinationNativeSnapshotErrorMessage": "ECS.CreatingSnapshot",
"NativeSnapshotId": "s-******************",
"DiskNativeSnapshotIdList": {
"DiskNativeSnapshotId": [
""
]
}
},
"InstanceName": "instancename",
"OtsDetail": {
"TableNames": {
"TableName": [
"[\"table1\", \"table2\", \"table3\"]"
]
}
},
"Speed": 500,
"TableName": "table1",
"CrossAccountType": "SELF_ACCOUNT",
"CrossAccountUserId": 0,
"CrossAccountRoleName": "BackupRole",
"Identifier": "",
"DestSourceType": "OSS",
"DestDataSourceId": "ds-000cov4ufudxklj24zdk",
"DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
"ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
"FilesTotal": 10,
"FilesDone": 9,
"ActualFiles": 8
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||
---|---|---|---|---|
2023-11-16 | The response structure of the API has changed | see changesets | ||
| ||||
2023-09-21 | The response structure of the API has changed | see changesets | ||
| ||||
2023-07-31 | The response structure of the API has changed | see changesets | ||
| ||||
2023-04-21 | The response structure of the API has changed | see changesets | ||
| ||||
2023-03-29 | The response structure of the API has changed | see changesets | ||
|