文档首页/ 云备份 CBR/ API参考/ API/ 备份/ 更新备份 - UpdateBackup
更新时间:2026-10-20 GMT+08:00
分享

更新备份 - UpdateBackup

功能介绍

根据备份ID更改备份

授权信息

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

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

URI

PUT /v3/{project_id}/backups/{backup_id}

表1 路径参数

参数

是否必选

参数类型

描述

backup_id

是

String

参数解释:

备份ID,获取方法请参见获取备份ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

project_id

是

String

参数解释:

项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

backup

否

BackupUpdate object

参数解释:

更新请求参数体

约束限制:

不涉及

表3 BackupUpdate

参数

是否必选

参数类型

描述

name

否

String

参数解释:

备份名称。

约束限制:

不涉及

取值范围:

只能由数字、中文、英文大小写字母、下划线"_"和中横线"-"组成,最大支持64个字符

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

backup

BackupResp object

备份副本

表5 BackupResp

参数

参数类型

描述

checkpoint_id

String

参数解释:

还原点ID

取值范围:

不涉及

created_at

String

参数解释:

创建时间,使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSSSS,例如:"2020-02-05T10:38:34.209782"

取值范围:

不涉及

description

String

参数解释:

备份描述

取值范围:

不涉及

expired_at

String

参数解释:

过期时间,使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSSSS,例如:"2020-02-05T10:38:34.209782"

取值范围:

不涉及

extend_info

BackupExtendInfo object

参数解释:

扩展信息

id

String

参数解释:

备份ID

取值范围:

不涉及

image_type

String

参数解释:

备份类型

取值范围:

backup:普通备份;replication:跨区域复制备份。

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::Ironic::BareMetalServer:裸金属服务器;OS::Sfs::Turbo:SFS Turbo文件系统;OS::Workspace::DesktopV2:云桌面。

scheduled_operation_id

String

参数解释:

策略ID

取值范围:

不涉及

status

String

参数解释:

备份状态

取值范围:

  • available: 可用

  • protecting: 保护中

  • deleting: 删除中

  • restoring: 恢复中

  • error: 异常

  • waiting_protect: 等待保护

  • waiting_delete: 等待删除

  • waiting_restore: 等待恢复

updated_at

String

参数解释:

更新时间,使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSSSS,例如:"2020-02-05T10:38:34.209782

取值范围:

不涉及

vault_id

String

参数解释:

存储库ID

取值范围:

不涉及

replication_records

Array of ReplicationRecordGet objects

参数解释:

复制记录

enterprise_project_id

String

参数解释:

企业项目ID

取值范围:

不涉及

provider_id

String

参数解释:

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

取值范围:

0daac4c5-6707-4851-97ba-169e36266b66,该值代表备份对象为云服务器。d1603440-187d-4516-af25-121250c7cc97,该值代表备份对象为云硬盘。3f3c3220-245c-4805-b811-758870015881, 该值代表备份对象为SFS Turbo。a13639de-00be-4e94-af30-26912d75e4a2,该值代表备份对象为混合云VMware备份。

children

Array of BackupResp objects

参数解释:

子副本列表

incremental

Boolean

参数解释:

是否是增备

取值范围:

  • true:增量备份

  • false:全量备份

version

Integer

参数解释:

备份副本快照类型

取值范围:

不涉及

表6 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:非系统盘

is_multi_az

Boolean

参数解释:

存储库是否具有多AZ属性,即底层备份是否为多AZ备份

取值范围:

  • true:存储库具有多AZ属性

  • false:存储库不具有多AZ属性

表7 ImageData

参数

参数类型

描述

image_id

String

参数解释:

镜像ID

取值范围:

不涉及

表8 ReplicationRecordGet

参数

参数类型

描述

created_at

String

参数解释:

复制的开始时间,使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSSSS,例如:"2020-02-05T10:38:34.209782"

取值范围:

不涉及

destination_backup_id

String

参数解释:

复制的目标区域备份ID

取值范围:

不涉及

destination_checkpoint_id

String

参数解释:

复制的目的备份记录ID

取值范围:

不涉及

destination_project_id

String

参数解释:

复制时目标区域项目ID

取值范围:

不涉及

destination_region

String

参数解释:

复制的目标区域

取值范围:

不涉及

destination_vault_id

String

参数解释:

目标存储库ID

取值范围:

不涉及

extra_info

ReplicationRecordsExtraInfo object

参数解释:

复制附加信息

id

String

参数解释:

复制记录ID

取值范围:

不涉及

source_backup_id

String

参数解释:

复制时源端备份ID

取值范围:

不涉及

source_checkpoint_id

String

参数解释:

复制的源备份记录ID

取值范围:

不涉及

source_project_id

String

参数解释:

复制时源端区域的项目ID

取值范围:

不涉及

source_region

String

参数解释:

复制的源区域

取值范围:

不涉及

status

String

参数解释:

复制的状态

取值范围:

  • replicating: 复制中

  • success: 成功

  • fail: 失败

  • skip: 跳过

  • waiting_replicate: 等待复制

vault_id

String

参数解释:

备份所在的存储库ID

取值范围:

不涉及

表9 ReplicationRecordsExtraInfo

参数

参数类型

描述

progress

Integer

参数解释:

复制进度

取值范围:

[1,100]

fail_code

String

参数解释:

失败错误码,成功时为空

取值范围:

不涉及

fail_reason

String

参数解释:

错误原因

取值范围:

不涉及

auto_trigger

Boolean

参数解释:

是否自动触发

取值范围:

  • true:自动触发

  • false:非自动触发

destination_vault_id

String

参数解释:

目标端的存储库ID

取值范围:

不涉及

请求示例

更改指定备份的备份名称。

PUT https://{endpoint}/v3/4229d7a45436489f8c3dc2b1d35d4987/backups/6df2b54c-dd62-4059-a07c-1b8f24f2725d

{
  "backup" : {
    "name" : "backup-name02"
  }
}

响应示例

状态码:200

{
  "backup": {
    "provider_id": "0daac4c5-6707-4851-97ba-169e36266b66",
    "checkpoint_id": "8b0851a8-adf3-4f4c-a914-dead08bf9664",
    "enterprise_project_id": "827f5075cb6d420cb4eb3a11d8967e12",
    "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",
        "replication_records": [],
        "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",
    "replication_records": [],
    "name": "backup-name02",
    "created_at": 2019-05-10T07:59:12.085+00:00,
    "resource_type": "OS::Nova::Server"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档