文档首页/ 云备份 CBR/ API参考/ API/ 任务/ 查询任务列表 - ListOpLogs

更新时间：2025-11-03 GMT+08:00

查看PDF

查询任务列表 - ListOpLogs

功能介绍

查询任务列表

授权信息

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

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

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	每页显示的条目数量，正整数，建议显式指定该参数值
offset	否	Integer	偏移值，正整数
operation_type	否	String	任务类型，分backup,replication,delete,restore,vault_delete,remove_resource,sync,copy,migrate_resources类型： backup：备份任务 replication：复制任务 delete：删除任务 restore：恢复任务 vault_delete：删除存储库任务 remove_resource：解绑资源任务 sync：同步任务 copy: 老版复制任务，现阶段复制任务均使用replication migrate_resources:迁移资源任务
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类型 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	任务个数
limit	Integer	每页显示的条目数量
offset	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: 跨Region复制 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: 应用一致性备份
backup_id	String	备份ID。默认取值不涉及。获取方法请参见"获取备份ID"。
backup_name	String	备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。
incremental	String	是否增备 "true" "false"

表9 OpExtendInfoCommon
参数	参数类型	描述
progress	Integer	进度，取值为0-100
request_id	String	请求id
task_id	String	备份任务id

**表10** OpExtendInfoDelete
参数	参数类型	描述
backup_id	String	备份ID。默认取值不涉及。获取方法请参见"获取备份ID"。
backup_name	String	备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。

**表11** OpExtendInfoSync
参数	参数类型	描述
sync_backup_num	Integer	同步备份副本数
delete_backup_num	Integer	删除的备份副本数
err_sync_backup_num	Integer	同步失败备份副本数

**表12** OpExtendInfoRemoveResources
参数	参数类型	描述
fail_count	Integer	删除失败的资源数量
total_count	Integer	删除的备份数量
resources	Array of Resource objects	资源信息

**表13** 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：云桌面。默认取值不涉及。

**表14** 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	目标备份名称

**表15** ResourceExtraInfo
参数	参数类型	描述
exclude_volumes	Array of strings	需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。默认取值不涉及。

**表16** OpExtendInfoRestore
参数	参数类型	描述
backup_id	String	备份副本ID，默认取值不涉及。获取方法请参见"获取备份ID"。
backup_name	String	备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。
target_resource_id	String	恢复目标资源ID，格式为UUID。默认取值不涉及。
target_resource_name	String	恢复目标资源名称

**表17** OpExtendInfoVaultDelete
参数	参数类型	描述
fail_count	Integer	本次任务删除失败的资源数量
total_count	Integer	本次任务删除的备份总数

状态码：404

**表18** 响应Body参数
参数	参数类型	描述
operation_logs	Array of OperationLog objects	任务列表
count	Integer	任务个数
limit	Integer	每页显示的条目数量
offset	Integer	偏移量，表示从此偏移量开始查询

**表19** 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: 移除资源
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	任务操作资源所属存储库名称

**表20** OpErrorInfo
参数	参数类型	描述
code	String	请参见错误码。
message	String	错误信息

**表21** 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

**表22** 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"

**表23** OpExtendInfoCommon
参数	参数类型	描述
progress	Integer	进度，取值为0-100
request_id	String	请求id
task_id	String	备份任务id

**表24** OpExtendInfoDelete
参数	参数类型	描述
backup_id	String	备份ID。默认取值不涉及。获取方法请参见"获取备份ID"。
backup_name	String	备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。

**表25** OpExtendInfoSync
参数	参数类型	描述
sync_backup_num	Integer	同步备份副本数
delete_backup_num	Integer	删除的备份副本数
err_sync_backup_num	Integer	同步失败备份副本数

**表26** OpExtendInfoRemoveResources
参数	参数类型	描述
fail_count	Integer	删除失败的资源数量
total_count	Integer	删除的备份数量
resources	Array of Resource objects	资源信息

**表27** 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：云桌面。默认取值不涉及。

**表28** 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	目标备份名称

**表29** ResourceExtraInfo
参数	参数类型	描述
exclude_volumes	Array of strings	需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。默认取值不涉及。

**表30** OpExtendInfoRestore
参数	参数类型	描述
backup_id	String	备份副本ID，默认取值不涉及。获取方法请参见"获取备份ID"。
backup_name	String	备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。默认取值不涉及。
target_resource_id	String	恢复目标资源ID，格式为UUID。默认取值不涉及。
target_resource_name	String	恢复目标资源名称

**表31** OpExtendInfoVaultDelete
参数	参数类型	描述
fail_count	Integer	本次任务删除失败的资源数量
total_count	Integer	本次任务删除的备份总数

请求示例

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

响应示例

状态码：200

{
  "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.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_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.511+00:00",
    "created_at" : "2019-05-23T14:31:36.039+00:00",
    "operation_type" : "backup",
    "project_id" : "04f1829c788037ac2fb8c01eb2b04b95"
  } ]
}

状态码

状态码	描述
200	OK
404	Not Found

错误码

请参见错误码。

父主题： 任务

上一篇：查询单个任务 - ShowOpLog

下一篇：存储库

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消