Updated on 2025-08-25 GMT+08:00

Querying All Backups

Function

This API is used to query all backups.

For details about how to create a backup, see Creating a Checkpoint.

Debugging

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

URI

GET /v3/{project_id}/backups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

checkpoint_id

No

String

Checkpoint ID.

For details, see Creating a Checkpoint and Querying All Backups.

dec

No

Boolean

Whether it is a DeC scenario. The value can be true (DeC scenario) or false (non-DeC scenario).

end_time

No

String

Time when the backup ends, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, 2018-02-01T12:00:00Z.

enterprise_project_id

No

String

Enterprise project ID or all_granted_eps. all_granted_eps indicates to query the IDs of all enterprise projects on which the user has permissions.

For details, see Obtaining an Enterprise Project ID.

image_type

No

String

Backup type. The value can be backup (common backup) or replication (cross-region replication backup).

incremental

No

Boolean

Whether the backup is an incremental backup.

  • true: incremental backup

  • false: full backup

limit

No

Integer

Maximum number of records to be returned. The value ranges from 1 to 1000. The default value is 1000.

marker

No

String

ID of the last record displayed on the previous page

member_status

No

String

Sharing status. The value can be:

  • pending: The sharing invitation has been sent, but the target project (or user) has not accepted or rejected the request.

  • accepted: The target project (or user) has accepted the request and can use the backup in their vault.

  • rejected: The target project (or user) has rejected the request.

name

No

String

Backup name. The value can contain a maximum of 255 characters, including only letters, digits, underscores (_), and hyphens (-).

offset

No

Integer

Offset. The default value is 0.

own_type

No

String

Ownership type. The default value is private.

  • private: private backup. Only the backups owned in the current project are queried.

  • shared: shared backup. Backups shared by other projects to the current project are queried.

  • all_granted: all backups. All private and shared backups are queried.

parent_id

No

String

Parent backup ID, in UUID format.

For details about how to obtain the backup ID, see Obtaining a Backup ID.

resource_az

No

String

ID of the region where the backup resources are located.

For details about how to obtain the region, see Querying Regions and Endpoints.

resource_id

No

String

Resource ID, in UUID format.

resource_name

No

String

Resource name, which can contain a maximum of 255 characters.

resource_type

No

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

show_replication

No

Boolean

Whether to return replication records. - true: Return replication records. - false: Not return replication records.

sort

No

String

A group of properties separated by commas (,) and sorting directions. The value is in the format of <key1>[:<direction>],<key2>[:<direction>], where the value of direction is asc (ascending order) or desc (descending order). If a direction is not specified, the default sorting direction is desc. The value of sort can contain a maximum of 255 characters. The key can be as follows: created_at, updated_at, name, status, protected_at, id

start_time

No

String

Time when the backup starts, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, 2018-02-01T12:00:00Z.

status

No

String

Backup status. When the API is called, multiple status values can be transferred for filtering. Example: status=available&status=error The options are as follows:

  • available: The backup is available.

  • protecting: The backup is being protected.

  • deleting: The backup is being deleted.

  • restoring: The restoration in progress.

  • error: The backup is abnormal.

  • waiting_protect: The backup is waiting to be protected.

  • waiting_delete: The backup is waiting to be deleted.

  • waiting_restore: The backup is waiting to be restored.

used_percent

No

String

Backups are filtered based on the occupied vault capacity. The value ranges from 1 to 100. For example, if used_percent is set to 80, all backups who occupied 80% or more of the vault capacity are displayed.

vault_id

No

String

Vault ID.

For details about how to obtain the vault ID, see Obtaining a Vault ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

backups

Array of BackupResp objects

Backup list

count

Integer

Number of backups

offset

Integer

Offset where the query starts

limit

Integer

Number of records displayed on each page

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

Querying all backups

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

Example Responses

Status code: 200

OK

{
  "count" : 2,
  "backups" : [ {
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99",
    "updated_at" : "2020-02-21T07:07:25.114+00:00",
    "vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515",
    "id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910",
    "resource_az" : "br-iaas-odin1a",
    "image_type" : "backup",
    "resource_id" : "1a503932-ee8f-4dd5-8248-8dfb57e584c5",
    "resource_size" : 40,
    "children" : [ ],
    "extend_info" : {
      "auto_trigger" : true,
      "supported_restore_mode" : "backup",
      "contain_system_disk" : true,
      "support_lld" : true,
      "system_disk" : false
    },
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "status" : "available",
    "resource_name" : "test001-02",
    "description" : "",
    "expired_at" : "2020-05-21T07:00:54.060+00:00",
    "name" : "autobk_b629",
    "created_at" : "2020-02-21T07:00:54.065+00:00",
    "resource_type" : "OS::Nova::Server"
  }, {
    "provider_id" : "d1603440-187d-4516-af25-121250c7cc97",
    "checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12",
    "updated_at" : "2020-02-21T07:09:37.767+00:00",
    "vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d",
    "id" : "5606aab5-2dc2-4498-8144-dc848d099af5",
    "resource_az" : "br-iaas-odin1a",
    "image_type" : "backup",
    "resource_id" : "54f7ccbc-072f-4ec5-a7b7-b24dabdb4539",
    "resource_size" : 40,
    "children" : [ ],
    "extend_info" : {
      "auto_trigger" : true,
      "snapshot_id" : "e3def9a8-e4b4-4c12-b132-f4ba8ce9a34f",
      "bootable" : true,
      "support_lld" : true,
      "encrypted" : false,
      "system_disk" : false
    },
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "status" : "available",
    "resource_name" : "qsy_000",
    "description" : "",
    "expired_at" : "2020-03-22T07:00:34.878+00:00",
    "name" : "autobk_6809",
    "created_at" : "2020-02-21T07:00:34.882+00:00",
    "resource_type" : "OS::Cinder::Volume"
  } ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.