文档首页/云备份 CBR/API参考/API/任务/查询单个任务 - ShowOpLog
更新时间：2025-12-05 GMT+08:00
查看PDF
分享

查询单个任务 - ShowOpLog

功能介绍

根据指定任务ID查询任务

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/operation-logs/{operation_log_id}

表1 路径参数

参数

是否必选

参数类型

描述

operation_log_id

是

String

任务ID

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

operation_log

OperationLog object

任务信息

表4 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: 跨Region复制

  • restore: 恢复

  • delete: 删除

  • sync: 同步

  • vault_delete: 删除存储库

  • remove_resource: 解绑资源

  • migrate_resources:迁移资源

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

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

表5 OpErrorInfo

参数

参数类型

描述

code

String

请参见错误码。

message

String

错误信息

表6 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

表7 OpExtendInfoBckup

参数

参数类型

描述

app_consistency_error_code

String

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

app_consistency_error_message

String

应用一致性备份错误信息

app_consistency_status

String

应用一致性备份状态，默认取值不涉及。

  • 0: 非应用一致性

  • 1: 应用一致性备份

backup_id

String

备份ID。默认取值不涉及。

获取方法请参见"获取备份ID"。

backup_name

String

备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。

incremental

String

是否增备

  • "true"

  • "false"

表8 OpExtendInfoCommon

参数

参数类型

描述

progress

Integer

进度，取值为0-100

request_id

String

请求id

task_id

String

备份任务id

表9 OpExtendInfoDelete

参数

参数类型

描述

backup_id

String

备份ID。默认取值不涉及。

获取方法请参见"获取备份ID"。

backup_name

String

备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。

表10 OpExtendInfoSync

参数

参数类型

描述

sync_backup_num

Integer

同步备份副本数

delete_backup_num

Integer

删除的备份副本数

err_sync_backup_num

Integer

同步失败备份副本数

表11 OpExtendInfoRemoveResources

参数

参数类型

描述

fail_count

Integer

删除失败的资源数量

total_count

Integer

删除的备份数量

resources

Array of Resource objects

资源信息

表12 Resource

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id，需要该资源已经绑定到该存储库中，且属于可备份的状态。默认取值不涉及。

获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。

name

String

待备份资源名称，长度限制：0-255字符。默认取值不涉及。

type

String

待备份资源的类型: OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。默认取值不涉及。

表13 OpExtendInfoReplication

参数

参数类型

描述

destination_backup_id

String

目标区域备份ID，默认取值不涉及。

获取方法请参见"获取备份ID"，其中project_id需填写目标区域的project_id。

destination_checkpoint_id

String

目标还原点ID

destination_project_id

String

目标区域项目ID，默认取值不涉及。

获取方法请参见"获取项目ID"。

destination_region

String

目标区域，默认取值不涉及。

获取方法请参见"地区和终端节点查询"。

source_backup_id

String

源端备份ID，默认取值不涉及。

获取方法请参见"获取备份ID"，其中project_id需填写源端的project_id。

source_checkpoint_id

String

源还原点ID

source_project_id

String

源端区域的项目ID，默认取值不涉及。

获取方法请参见"获取项目ID"。

source_region

String

复制的源区域。默认取值不涉及。

获取方法请参见"地区和终端节点查询"。

source_backup_name

String

源备份名称

destination_backup_name

String

目标备份名称

表14 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。默认取值不涉及。

表15 OpExtendInfoRestore

参数

参数类型

描述

backup_id

String

备份副本ID，默认取值不涉及。

获取方法请参见"获取备份ID"。

backup_name

String

备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。

target_resource_id

String

恢复目标资源ID，格式为UUID。默认取值不涉及。

target_resource_name

String

恢复目标资源名称

表16 OpExtendInfoVaultDelete

参数

参数类型

描述

fail_count

Integer

本次任务删除失败的资源数量

total_count

Integer

本次任务删除的备份总数

状态码：404

表17 响应Body参数

参数

参数类型

描述

error_code

String

请参见错误码。

error_msg

String

错误信息

请求示例

GET https://{endpoint}/v3/{project_id}/operation-logs/{operation_log_id}

响应示例

状态码：200

OK

{
  "operation_log" : {
    "status" : "success",
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "checkpoint_id" : "b432511f-d889-428f-8b0e-5f47c524c6b6",
    "updated_at" : "2019-05-23T14:35:23.584+00:00",
    "error_info" : {
      "message" : "",
      "code" : ""
    },
    "started_at" : "2019-05-23T14:31:36.007+00:00",
    "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_1234",
        "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.511+00:00",
    "created_at" : "2019-05-23T14:31:36.039+00:00",
    "operation_type" : "backup",
    "project_id" : "04f1829c788037ac2fb8c01eb2b04b95"
  }
}

状态码：404

任务ID不存在

{
  "error_code" : "BackupService.6500",
  "error_msg" : "Operation log does not exist."
}

状态码

状态码

描述

200

OK

404

任务ID不存在

错误码

请参见错误码。

父主题：任务

相关文档