接口介绍
获取该用户所有备份任务列表
接口约束
无
URI
GET /v4/backup/query-task-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码。 | 参考状态码 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
bakupTaskCount | 是 | Integer | 备份任务的数量 | 参考响应示例 | |
backupTaskList | 是 | Array of Objects | 备份任务的详情列表 | 参考响应示例 |
表 backupTaskList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
backupTaskID | 是 | String | 备份任务ID | 参考响应示例 | |
backupPolicyName | 是 | String | 备份计划名称 | 参考响应示例 | |
backupSrcInstanceID | 是 | String | 备份云主机ID | 参考响应示例 | |
backupSrcInstanceName | 是 | String | 备份云主机名称 | 参考响应示例 | |
backupStorageID | 是 | String | 存储库ID | 参考响应示例 | |
backupStorageName | 是 | String | 存储库名称 | 参考响应示例 | |
backupPaths | 是 | Array of String | 备份路径列表 | 参考响应示例 | |
backupFileCount | 是 | Integer | 已备份文件数量 | 参考响应示例 | |
backupTaskStatus | 是 | String | 备份任务状态描述(5种,执行中,执行准备中,执行失败,执行完成,未知) | 参考状态枚举表 | |
backupTaskStartTime | 是 | String | 备份任务开始时间 | 参考响应示例 | |
backupTaskDoneTime | 是 | String | 备份任务完成时间 | 参考响应示例 | |
backupTaskErrMsg | 是 | String | 备份任务执行过程中的错误信息描述 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
}
响应示例
{
"returnObj": {
"backupTaskCount": 1,
"backupTaskList":[
{
"backupTaskID" : "73f321ea-62ff-11ec-a8bc-005056898fe0",
"backupPolicyName" : "backup-1",
"backupSrcInstanceID" : "cafa8c74-42e7-4e32-921c-d7b2c75dac27",
"backupSrcInstanceName" : "ecs001",
"backStorageID" : "b2c75dea-42e7-11ec-921c-005056898fe0",
"backkstorageName" : "ecs001",
"backupPaths" : ["/root/ecs/"],
"backupFileCount" : 12306,
"backupTaskStatus" : "Done",
"backupTaskStartTime" : "2022-11-08T10:07:28Z",
"backupTaskDoneTime" : "2022-11-08T11:07:28Z",
"backupTaskErrMsg" : "",
}
]
},
"statusCode": 800,
"message": "SUCCESS",
"description": "成功"
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码