文档首页/ 云备份 CBR/ API参考（联盟区域）/ API/ 备份/ 查询指定备份
更新时间：2026-01-09 GMT+08:00
查看PDF
分享

查询指定备份

功能介绍

根据指定id查询单个副本。

URI

GET /v3/{project_id}/backups/{backup_id}

表1 路径参数

参数

是否必选

参数类型

描述

backup_id

是

String

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

project_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

backup

BackupResp object

备份副本
表4 BackupResp

参数

参数类型

描述

checkpoint_id

String

还原点ID。

created_at

String

创建时间，例如:"2020-02-05T10:38:34.209782"。

description

String

备份描述，取值范围不涉及。

expired_at

String

过期时间，例如:"2020-02-05T10:38:34.209782"。

extend_info

BackupExtendInfo object

扩展信息，取值范围不涉及。

id

String

备份ID，取值范围不涉及。

image_type

String

备份类型。取值范围为：backup：普通备份。

name

String

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

parent_id

String

父备份ID，取值范围不涉及。

project_id

String

项目ID，取值范围不涉及。

protected_at

String

备份时间，取值范围不涉及。

resource_az

String

资源可用区，取值范围不涉及。

resource_id

String

资源ID，格式为UUID。可根据待备份的资源类型查询对应的资源情况。

resource_name

String

待备份资源名称，长度限制：0-255字符。

resource_size

Integer

资源大小，单位为GB，取值范围不涉及。

resource_type

String

待备份资源的类型: OS::Nova::Server：云服务器；OS::Cinder::Volume：云硬盘；OS::Sfs::Turbo：SFS Turbo文件系统。

status

String

备份状态，取值范围如下：

  • available: 可用

  • protecting: 保护中

  • deleting: 删除中

  • restoring: 恢复中

  • error: 异常

  • waiting_protect: 等待保护

  • waiting_delete: 等待删除

  • waiting_restore: 等待恢复

updated_at

String

更新时间，例如:"2020-02-05T10:38:34.209782"。

vault_id

String

存储库ID，取值范围不涉及。

children

Array of BackupResp objects

子副本列表

incremental

Boolean

是否是增备

  • true：增量备份

  • false：全量备份

version

Integer

备份副本快照类型，取值范围不涉及。
表5 BackupExtendInfo

参数

参数类型

描述

auto_trigger

Boolean

功能说明：是否是自动生成的备份副本。默认取值不涉及。

取值范围：

  • true：自动生成的备份副本

  • false：非自动生成的备份副本

bootable

Boolean

功能说明：是否系统盘备份。默认取值不涉及。

取值范围：

  • true：系统盘备份。

  • false：非系统盘备份。

snapshot_id

String

卷备份副本的快照id

support_lld

Boolean

功能说明：是否支持lazyloading快速恢复。默认取值不涉及。

取值范围：

  • true：支持lazyloading快速恢复。

  • false：不支持lazyloading快速恢复。

supported_restore_mode

String

功能说明：备份支持恢复的方式，默认取值不涉及。

取值范围：

  • na: 备份不支持直接恢复，只支持备份创建新资源等操作。

  • backup: 备份支持通过云服务器上硬盘的备份进行恢复。

  • snapshot: 备份此时已经支持创建整机镜像。

os_images_data

Array of ImageData objects

备份注册镜像ID列表

contain_system_disk

Boolean

功能说明：整机备份是否包含系统盘。默认取值不涉及。

取值范围：

  • true：整机备份包含系统盘

  • false：整机备份不包含系统盘

encrypted

Boolean

功能说明：是否加密备份。默认取值不涉及。

  • true：加密备份

  • false：非加密备份

system_disk

Boolean

功能说明：是否是系统盘。默认取值不涉及。

取值范围：

  • true：系统盘

  • false：非系统盘
表6 ImageData

参数

参数类型

描述

image_id

String

镜像ID
表7 ReplicationRecordsExtraInfo

参数

参数类型

描述

progress

Integer

复制进度

fail_code

String

失败错误码，成功时为空

fail_reason

String

错误原因

auto_trigger

Boolean

是否自动触发。默认为false。

  • true:自动触发

  • false：非自动触发

destination_vault_id

String

目标端的存储库id

请求示例

查询单个备份副本。

GET https://{endpoint}/v3/{project_id}/backups/{backup_id}

响应示例

状态码：200

OK

{
  "backup" : {
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "checkpoint_id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664",
    "enterprise_project_id" : 0,
    "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
    "id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d",
    "resource_az" : "az1.dc1",
    "image_type" : "backup",
    "resource_id" : "94eba8b2-acc9-4d82-badc-127144cc5526",
    "resource_size" : 40,
    "children" : [ {
      "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
      "checkpoint_id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664",
      "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
      "id" : "5d822633-2bbf-4af8-a16e-5ab1c7705235",
      "image_type" : "backup",
      "resource_id" : "eccbcfdd-f843-4bbb-b2c0-a5ce861f9376",
      "resource_size" : 40,
      "children" : [ ],
      "parent_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d",
      "extend_info" : {
        "auto_trigger" : true,
        "snapshot_id" : "5230a977-1a94-4092-8edd-519303a44cda",
        "bootable" : true,
        "encrypted" : true
      },
      "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
      "status" : "available",
      "resource_name" : "ecs-1f0f-0002",
      "name" : "autobk_a843_ecs-1f0f-0002",
      "created_at" : "2019-05-10T07:59:59.451+00:00",
      "resource_type" : "OS::Cinder::Volume"
    } ],
    "extend_info" : {
      "auto_trigger" : true,
      "supported_restore_mode" : "backup",
      "contain_system_disk" : true,
      "support_lld" : true
    },
    "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
    "status" : "available",
    "resource_name" : "ecs-1f0f-0002",
    "description" : "backup_description",
    "name" : "backup_name",
    "created_at" : "2019-05-10T07:59:12.085+00:00",
    "resource_type" : "OS::Nova::Server"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 备份