Updated on 2024-05-11 GMT+08:00

Modifying a Backup

Function

This API is used to modify a backup based on a given backup ID.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

backup_id

Yes

String

Backup ID

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

backup

No

BackupUpdate object

Request body for modifying the backup name

Table 3 BackupUpdate

Parameter

Mandatory

Type

Description

name

No

String

Backup name

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

backup

BackupResp object

Backup

Table 5 BackupResp

Parameter

Type

Description

checkpoint_id

String

Restore point ID

created_at

String

Creation time, for example, 2020-02-05T10:38:34.209782

description

String

Backup description

expired_at

String

Expiration time, for example, 2020-02-05T10:38:34.209782

extend_info

BackupExtendInfo object

Extended information

id

String

Backup ID

image_type

String

Backup type, which can be backup or replication.

name

String

Backup name

parent_id

String

Parent backup ID

project_id

String

Project ID

protected_at

String

Backup time

resource_az

String

Resource availability zone

resource_id

String

Resource ID

resource_name

String

Resource name

resource_size

Integer

Resource size, in GB

resource_type

String

Resource type, which can be OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, or OS::Workspace::DesktopV2

status

String

Backup status

Enumeration values:

  • available
  • protecting
  • deleting
  • restoring
  • error
  • waiting_protect
  • waiting_delete
  • waiting_restore

updated_at

String

Update time, for example, 2020-02-05T10:38:34.209782

vault_id

String

Vault ID

replication_records

Array of ReplicationRecordGet objects

Replication record

enterprise_project_id

String

Enterprise project ID. Its default value is 0.

provider_id

String

Backup provider ID, which is used to distinguish backup objects. The value can be as follows: 0daac4c5-6707-4851-97ba-169e36266b66 indicates that backup objects are cloud servers; d1603440-187d-4516-af25-121250c7cc97 indicates that backup objects are cloud disks; 3f3c3220-245c-4805-b811-758870015881 indicates that backup objects are SFS Turbo file systems; a13639de-00be-4e94-af30-26912d75e4a2 indicates that backup objects are hybrid cloud VMware backups.

children

Array of BackupResp objects

Backup list

incremental

Boolean

Whether incremental backup is used

Table 6 BackupExtendInfo

Parameter

Type

Description

auto_trigger

Boolean

Whether the backup is automatically generated

bootable

Boolean

Whether the backup is a system disk backup

snapshot_id

String

Snapshot ID of the disk backup

support_lld

Boolean

Whether to allow lazyloading for fast restoration

supported_restore_mode

String

Restoration mode. Possible values are na, snapshot, and backup. snapshot indicates the backup can be used to create a full-server image. backup indicates the data is restored from backups of the EVS disks of the server. na indicates the backup can only be used to create new resources but cannot be used for restoration.

Default: na

Enumeration values:

  • na
  • backup
  • snapshot

os_images_data

Array of ImageData objects

ID list of images created using backups

contain_system_disk

Boolean

Whether the VM backup data contains system disk data

encrypted

Boolean

Whether the backup is encrypted

system_disk

Boolean

Whether the disk is a system disk

is_multi_az

Boolean

Whether multi-AZ backup redundancy is used

Default: false

Table 7 ImageData

Parameter

Type

Description

image_id

String

Image ID

Table 8 ReplicationRecordGet

Parameter

Type

Description

created_at

String

Start time of the replication

destination_backup_id

String

ID of the destination backup used for replication

destination_checkpoint_id

String

Record ID of the destination backup used for replication

destination_project_id

String

ID of the replication destination project

destination_region

String

Replication destination region

destination_vault_id

String

Destination vault ID

extra_info

ReplicationRecordsExtraInfo object

Additional information of the replication

id

String

Replication record ID

source_backup_id

String

ID of the source backup used for replication

source_checkpoint_id

String

ID of the source backup record used for replication

source_project_id

String

ID of the replication source project

source_region

String

Replication source region

status

String

Replication status

Enumeration values:

  • replicating
  • success
  • fail
  • skip
  • waiting_replicate

vault_id

String

ID of the vault where the backup resides

Table 9 ReplicationRecordsExtraInfo

Parameter

Type

Description

progress

Integer

Replication progress

fail_code

String

Error code. This field is empty if the operation is successful.

fail_reason

String

Error cause

auto_trigger

Boolean

Whether replication is automatically scheduled

destinatio_vault_id

String

Destination vault ID

Example Requests

Changing the name of a backup

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

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

Example Responses

Status code: 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",
      "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"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.