更新时间:2022-08-16 GMT+08:00

查询指定备份

功能介绍

根据指定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

BackupDetail object

备份副本

表4 BackupDetail

参数

参数类型

描述

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

备份名称

parent_id

String

父备份ID

project_id

String

项目ID

protected_at

String

备份时间

resource_az

String

资源可用区

resource_id

String

资源ID

resource_name

String

资源名称

resource_size

Integer

资源大小,单位为GB

resource_type

String

资源类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::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

enterprise_project_id

String

企业项目id,默认为‘0’。

children

Array of BackupResp objects

  
表5 BackupExtendInfo

参数

参数类型

描述

auto_trigger

Boolean

是否是自动生成的备份副本

bootable

Boolean

是否系统盘备份

incremental

Boolean

是否是增备

snapshot_id

String

卷备份副本的快照id

support_lld

Boolean

是否支持lazyloading快速恢复

supported_restore_mode

String

备份支持恢复的方式,当前取值包含na,snapshot和backup。如果该字段取值为snapshot,代表备份此时已经支持创建整机镜像;如果该字段取值为backup,备份支持通过云服务器上硬盘的备份进行恢复;如果该字段取值为na,备份不支持直接恢复,只支持备份创建新资源等操作。

缺省值:na

枚举值:

  • na
  • backup
  • snapshot

os_images_data

Array of ImageData objects

备份注册镜像ID列表

contain_system_disk

Boolean

整机备份是否包含系统盘

encrypted

Boolean

是否加密

system_disk

Boolean

是否是系统盘

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

备份名称

parent_id

String

父备份ID

project_id

String

项目ID

protected_at

String

备份时间

resource_az

String

资源可用区

resource_id

String

资源ID

resource_name

String

资源名称

resource_size

Integer

资源大小,单位为GB

resource_type

String

资源类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::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

enterprise_project_id

String

企业项目id,默认为‘0’。

表7 ImageData

参数

参数类型

描述

image_id

String

镜像ID

表8 ReplicationRecordsExtraInfo

参数

参数类型

描述

progress

Integer

复制进度

fail_code

String

失败错误码,成功时为空

fail_reason

String

错误原因

auto_trigger

Boolean

是否为自动调度复制

destinatio_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",
    "updated_at" : null,
    "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",
      "updated_at" : null,
      "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
      "id" : "5d822633-2bbf-4af8-a16e-5ab1c7705235",
      "resource_az" : null,
      "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,
        "supported_restore_mode" : null,
        "os_images_data" : null,
        "snapshot_id" : "5230a977-1a94-4092-8edd-519303a44cda",
        "bootable" : true,
        "progress" : null,
        "support_lld" : null,
        "encrypted" : true
      },
      "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
      "status" : "available",
      "resource_name" : "ecs-1f0f-0002",
      "description" : null,
      "expired_at" : null,
      "name" : "autobk_a843_ecs-1f0f-0002",
      "created_at" : "2019-05-10T07:59:59.450700",
      "protected_at" : null,
      "resource_type" : "OS::Cinder::Volume"
    } ],
    "parent_id" : null,
    "extend_info" : {
      "auto_trigger" : true,
      "supported_restore_mode" : "backup",
      "os_images_data" : null,
      "contain_system_disk" : true,
      "snapshot_id" : null,
      "bootable" : null,
      "progress" : null,
      "support_lld" : true
    },
    "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
    "status" : "available",
    "resource_name" : "ecs-1f0f-0002",
    "description" : "backup_description",
    "expired_at" : null,
    "name" : "backup_name",
    "created_at" : "2019-05-10T07:59:12.084695",
    "protected_at" : null,
    "resource_type" : "OS::Nova::Server"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码