查询一个或者多个符合条件的备份任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 否 | 分页页码,从1开始,默认值为1。 | 1 |
PageSize | integer | 否 | 分页大小,最小值为1,最大值为99,默认值为10。 | 10 |
SourceType | string | 是 | 数据源类型,取值范围:
| ECS_FILE |
SortDirection | string | 否 | 排序方向。取值范围:
| DESCEND |
Filters | array | 否 | 查询过滤器中的键值。 | |
object | 否 | 查询过滤器。 | ||
Key | string | 否 | 查询过滤器中的键值。取值包括:
| VaultId |
Values | array | 否 | 查询过滤器的变量值。 | |
string | 否 | 查询过滤器中的待匹配的值。 | ["v-*********************"] | |
Operator | string | 否 | 匹配方式。默认为IN。即过滤器中Key和Value支持的匹配操作(Operator)方式,取值包括:
说明当使用CompleteTime作为Key查询时,暂时不支持IN操作。 | IN |
返回参数
示例
正常返回示例
JSON
格式
{
"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",
"Report": {
"TotalFiles": "/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv",
"SuccessFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip",
"FailedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip",
"SkippedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip",
"ReportTaskStatus": "COMPLETE"
}
}
]
}
}
错误码
访问错误中心查看更多错误码。