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. For details about how to obtain the backup ID, see Obtaining a Backup ID.
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a 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	Checkpoint ID. For details, see Creating a Checkpoint and Querying All Backups.
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. The value can be backup (common backup) or replication (cross-region replication backup).
name	String	Backup name. The value can contain a maximum of 255 characters, including digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-).
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, in UUID format. You can query the resource status based on the type of the resource to be backed up.
resource_name	String	Name of the resource to be backed up. The value can contain a maximum of 255 characters.
resource_size	Integer	Resource size, in GB
resource_type	String	Type of the resource to be backed up: OS::Nova::Server: ECS; OS::Cinder::Volume: EVS disks; OS::Ironic::BareMetalServer: Bare Metal Servers; OS::Sfs::Turbo: SFS Turbo file systems; OS::Workspace::DesktopV2: Workspaces
status	String	Backup status
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. For details, see Obtaining an Enterprise Project ID.
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.
version	Integer	Backup snapshot type.

**Table 6** BackupExtendInfo
Parameter	Type	Description
auto_trigger	Boolean	Whether the backup is automatically generated. true: The backup is automatically generated. false: The backup is not automatically generated.
bootable	Boolean	Whether the backup is a system disk backup. - true: The backup is a system disk backup. - false: The backup is not a system disk backup.
snapshot_id	String	Snapshot ID of the disk backup
support_lld	Boolean	Whether to allow lazy loading for fast restoration. - true: Lazy loading is allowed for quick restoration. - false: Lazy loading is not allowed for quick 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.
os_images_data	Array of ImageData objects	ID list of images created using backups
contain_system_disk	Boolean	Whether the system disk is included in the entire-server backup. The options are as follows: - true: The system disk is included in the entire-server backup. - false: The system disk is not included in the entire-server backup.
encrypted	Boolean	Whether the backup is encrypted. The options are as follows: - true: The backup is encrypted. - false: The backup is not encrypted.
system_disk	Boolean	Specifies whether the disk is a system disk. - true: The disk is a system disk. - false: The disk is not a system disk.
is_multi_az	Boolean	Specifies whether the vault has the multi-AZ attribute, that is, whether the underlying backup is a multi-AZ backup. The default value is false. The options are as follows: true: The vault has the multi-AZ attribute. false: The vault does not have the multi-AZ attribute.

**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	Backup ID in the destination region. For details about how to obtain the backup ID, see Obtaining a Backup ID, where project_id must be set to the project ID of the destination region.
destination_checkpoint_id	String	Record ID of the destination backup used for replication
destination_project_id	String	Project ID of the destination region. For details about how to obtain the project ID, see Obtaining a Project ID, where project_id must be set to the project ID of the destination region.
destination_region	String	Destination region. For details about how to obtain the region, see Querying Regions and Endpoints.
destination_vault_id	String	Target vault ID. For details about how to obtain the vault ID, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region.
extra_info	ReplicationRecordsExtraInfo object	Additional information of the replication
id	String	Replication record ID
source_backup_id	String	Project ID of the source region. For details about how to obtain the project ID, see Obtaining a Project ID, where project_id must be set to the project ID of the source region.
source_checkpoint_id	String	ID of the source backup record used for replication
source_project_id	String	Project ID of the source region. For details about how to obtain the project ID, see Obtaining a Project ID.
source_region	String	Source region. For details about how to obtain the region, see Querying Regions and Endpoints.
status	String	Replication status
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 the task is automatically triggered. Default value: false. true: The task is automatically triggered. false: The task is not automatically triggered.
destination_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

{
  "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"
  }
}