文档首页 > > API参考> API> 任务> 查询任务列表

查询任务列表

分享
更新时间:2020/10/29 GMT+08:00

功能介绍

查询任务列表

URI

GET /v3/{project_id}/operation-logs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

end_time

String

任务结束时间,格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-02-01T12:00:00Z

enterprise_project_id

String

企业项目id或all_granted_eps,all_granted_eps表示查询用户有权限的所有企业项目id

limit

Integer

每页显示的条目数量,正整数

最小值:1

offset

Integer

偏移值,正整数

最小值:1

operation_type

String

任务类型

枚举值:

  • backup

  • copy

  • replication

  • delete

  • restore

  • vault_delete

  • remove_resource

  • sync

provider_id

String

备份提供商ID

resource_id

String

该任务操作的资源ID

resource_name

String

该任务操作的资源名称

start_time

String

任务开始时间,格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-01-01T12:00:00Z

status

String

任务状态

枚举值:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

vault_id

String

存储库ID,该任务操作的资源所属绑定的存储库。

vault_name

String

存储库名称,该任务操作资源所绑定的存储库名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码为 200 时:

表4 响应Body参数

参数

参数类型

描述

operation_logs

Array of OperationLog objects

任务列表

count

Integer

任务个数

表5 OperationLog

参数

参数类型

描述

checkpoint_id

String

备份记录id

created_at

String

创建时间,例如: "2020-02-23T01:00:32Z"

ended_at

String

任务结束时间,例如: "2020-02-23T01:00:32Z"

error_info

OpErrorInfo object

任务错误信息

extra_info

OpExtraInfo object

任务扩展信息

id

String

任务id

operation_type

String

任务类型

枚举值:

  • backup

  • copy

  • replication

  • restore

  • delete

  • sync

  • vault_delete

  • remove_resource

policy_id

String

策略ID

project_id

String

项目ID

provider_id

String

备份提供商ID。用于区分备份对象。

started_at

String

任务开始时间,例如: "2020-02-23T01:00:32Z"

status

String

任务状态

枚举值:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

updated_at

String

修改时间,例如: "2020-02-23T01:00:32Z"

vault_id

String

任务操作资源所属存储库ID

vault_name

String

任务操作资源所属存储库名称

表6 OpErrorInfo

参数

参数类型

描述

code

String

请参见错误码

message

String

错误信息

表7 OpExtraInfo

参数

参数类型

描述

backup

OpExtendInfoBckup object

备份扩展参数

common

OpExtendInfoCommon object

公共参数

delete

OpExtendInfoDelete object

删除扩展参数

sync

OpExtendInfoSync object

扩展同步信息

remove_resources

OpExtendInfoRemoveResources object

移除Vault的资源

replication

OpExtendInfoReplication object

扩展复制信息

resource

Resource object

资源信息

restore

OpExtendInfoRestore object

扩展恢复信息

vault_delete

OpExtendInfoVaultDelete object

删除vault

表8 OpExtendInfoBckup

参数

参数类型

描述

app_consistency_error_code

String

应用一致性备份失败错误码。请参见错误码

app_consistency_error_message

String

应用一致性备份错误信息

app_consistency_status

String

应用一致性备份状态;0:非应用一致性,1:应用一致性备份

枚举值:

  • 0

  • 1

backup_id

String

备份副本ID

backup_name

String

备份名称

incremental

String

是否增备

枚举值:

  • "true"

  • "false"

表9 OpExtendInfoCommon

参数

参数类型

描述

progress

Integer

进度,取值为0-100

最小值:0

最大值:100

request_id

String

请求id

task_id

String

备份任务id

表10 OpExtendInfoDelete

参数

参数类型

描述

backup_id

String

备份副本ID

backup_name

String

备份名称

表11 OpExtendInfoSync

参数

参数类型

描述

sync_backup_num

Integer

同步备份副本数

delete_backup_num

Integer

删除的备份副本数

err_sync_backup_num

Integer

同步失败备副本数

表12 OpExtendInfoRemoveResources

参数

参数类型

描述

fail_count

Integer

删除失败的资源ID列表

total_count

Integer

删除的备份数量

resources

Array of Resource objects

表13 Resource

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id

name

String

待备份资源名称,长度限制:0-255

最小长度:0

最大长度:255

type

String

待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo

表14 OpExtendInfoReplication

参数

参数类型

描述

destination_backup_id

String

目标副本ID

destination_checkpoint_id

String

目标还原点ID

destination_project_id

String

目标project_id

destination_region

String

目标区域

source_backup_id

String

源副本ID

source_checkpoint_id

String

源还原点ID

source_project_id

String

源project_id

source_region

String

源区域

source_backup_name

String

源备份名称

destination_backup_name

String

目标备份名称

表15 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅虚拟机磁盘级备份有效

include_volumes

Array of ResourceExtraInfoIncludeVolumes objects

要备份的卷

表16 ResourceExtraInfoIncludeVolumes

参数

参数类型

描述

id

String

卷ID,仅支持uuid

os_version

String

操作系统类型

表17 OpExtendInfoRestore

参数

参数类型

描述

backup_id

String

备份副本ID

backup_name

String

备份名称

target_resource_id

String

恢复目标资源ID

target_resource_name

String

恢复目标资源名称

表18 OpExtendInfoVaultDelete

参数

参数类型

描述

fail_count

Integer

删除失败的资源ID列表

total_count

Integer

删除的备份数量

状态码为 404 时:

表19 响应Body参数

参数

参数类型

描述

operation_logs

Array of OperationLog objects

任务列表

count

Integer

任务个数

表20 OperationLog

参数

参数类型

描述

checkpoint_id

String

备份记录id

created_at

String

创建时间,例如: "2020-02-23T01:00:32Z"

ended_at

String

任务结束时间,例如: "2020-02-23T01:00:32Z"

error_info

OpErrorInfo object

任务错误信息

extra_info

OpExtraInfo object

任务扩展信息

id

String

任务id

operation_type

String

任务类型

枚举值:

  • backup

  • copy

  • replication

  • restore

  • delete

  • sync

  • vault_delete

  • remove_resource

policy_id

String

策略ID

project_id

String

项目ID

provider_id

String

备份提供商ID。用于区分备份对象。

started_at

String

任务开始时间,例如: "2020-02-23T01:00:32Z"

status

String

任务状态

枚举值:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

updated_at

String

修改时间,例如: "2020-02-23T01:00:32Z"

vault_id

String

任务操作资源所属存储库ID

vault_name

String

任务操作资源所属存储库名称

表21 OpErrorInfo

参数

参数类型

描述

code

String

请参见错误码

message

String

错误信息

表22 OpExtraInfo

参数

参数类型

描述

backup

OpExtendInfoBckup object

备份扩展参数

common

OpExtendInfoCommon object

公共参数

delete

OpExtendInfoDelete object

删除扩展参数

sync

OpExtendInfoSync object

扩展同步信息

remove_resources

OpExtendInfoRemoveResources object

移除Vault的资源

replication

OpExtendInfoReplication object

扩展复制信息

resource

Resource object

资源信息

restore

OpExtendInfoRestore object

扩展恢复信息

vault_delete

OpExtendInfoVaultDelete object

删除vault

表23 OpExtendInfoBckup

参数

参数类型

描述

app_consistency_error_code

String

应用一致性备份失败错误码。请参见错误码

app_consistency_error_message

String

应用一致性备份错误信息

app_consistency_status

String

应用一致性备份状态;0:非应用一致性,1:应用一致性备份

枚举值:

  • 0

  • 1

backup_id

String

备份副本ID

backup_name

String

备份名称

incremental

String

是否增备

枚举值:

  • "true"

  • "false"

表24 OpExtendInfoCommon

参数

参数类型

描述

progress

Integer

进度,取值为0-100

最小值:0

最大值:100

request_id

String

请求id

task_id

String

备份任务id

表25 OpExtendInfoDelete

参数

参数类型

描述

backup_id

String

备份副本ID

backup_name

String

备份名称

表26 OpExtendInfoSync

参数

参数类型

描述

sync_backup_num

Integer

同步备份副本数

delete_backup_num

Integer

删除的备份副本数

err_sync_backup_num

Integer

同步失败备副本数

表27 OpExtendInfoRemoveResources

参数

参数类型

描述

fail_count

Integer

删除失败的资源ID列表

total_count

Integer

删除的备份数量

resources

Array of Resource objects

表28 Resource

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id

name

String

待备份资源名称,长度限制:0-255

最小长度:0

最大长度:255

type

String

待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo

表29 OpExtendInfoReplication

参数

参数类型

描述

destination_backup_id

String

目标副本ID

destination_checkpoint_id

String

目标还原点ID

destination_project_id

String

目标project_id

destination_region

String

目标区域

source_backup_id

String

源副本ID

source_checkpoint_id

String

源还原点ID

source_project_id

String

源project_id

source_region

String

源区域

source_backup_name

String

源备份名称

destination_backup_name

String

目标备份名称

表30 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅虚拟机磁盘级备份有效

include_volumes

Array of ResourceExtraInfoIncludeVolumes objects

要备份的卷

表31 ResourceExtraInfoIncludeVolumes

参数

参数类型

描述

id

String

卷ID,仅支持uuid

os_version

String

操作系统类型

表32 OpExtendInfoRestore

参数

参数类型

描述

backup_id

String

备份副本ID

backup_name

String

备份名称

target_resource_id

String

恢复目标资源ID

target_resource_name

String

恢复目标资源名称

表33 OpExtendInfoVaultDelete

参数

参数类型

描述

fail_count

Integer

删除失败的资源ID列表

total_count

Integer

删除的备份数量

请求示例

响应示例

状态码: 200

OK

{
  "count" : 1,
  "operation_logs" : [ {
    "status" : "success",
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "checkpoint_id" : "b432511f-d889-428f-8b0e-5f47c524c6b6",
    "updated_at" : "2019-05-23T14:35:23.584418",
    "error_info" : {
      "message" : "",
      "code" : ""
    },
    "started_at" : "2019-05-23T14:31:36.007230",
    "id" : "4827f2da-b008-4507-ab7d-42d0df5ed912",
    "extra_info" : {
      "resource" : {
        "type" : "OS::Nova::Server",
        "id" : "1dab32fa-ebf2-415a-ab0b-eabe6353bc86",
        "name" : "ECS-0001"
      },
      "backup" : {
        "backup_name" : "manualbk_backup",
        "backup_id" : "0e5d0ef6-7f0a-4890-b98c-cb12490e31c1"
      },
      "common" : {
        "progress" : 100,
        "request_id" : "req-cdb98cc4-e87b-4f40-9b4a-57ec036620bc"
      }
    },
    "ended_at" : "2019-05-23T14:35:23.511155",
    "created_at" : "2019-05-23T14:31:36.039365",
    "operation_type" : "backup",
    "project_id" : "04f1829c788037ac2fb8c01eb2b04b95"
  } ]
}

状态码

状态码

描述

200

OK

404

Not Found

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问