Querying All Backups

project_id

Yes

String

Project ID

checkpoint_id

No

String

Restore point ID

dec

No

Boolean

Dedicated cloud

end_time

No

String

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

image_type

No

String

Backup type, which can be backup or replication.

limit

No

Integer

Number of records displayed per page. The value must be a positive integer.

marker

No

String

ID of the last record displayed on the previous page

member_status

No

String

Backup sharing status

Enumeration values:

• pending
• accepted
• rejected

name

No

String

Backup name

offset

No

Integer

Offset value. The value must be a positive integer.

own_type

No

String

Owning type of a backup. private backups are queried by default.

Default: private

Enumeration values:

• all_granted
• private
• shared

parent_id

No

String

Parent backup ID

resource_az

No

String

AZ-based filtering is supported.

resource_id

No

String

Resource ID

resource_name

No

String

Resource name

resource_type

No

String

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

sort

No

String

A group of properties separated by commas (,) and sorting directions. The value format is [:],[:], where the value of direction is asc (in ascending order) or desc (in descending order). If the parameter direction is not specified, the default sorting direction is desc. The value of sort contains a maximum of 255 characters. The value range of key is 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

Status When the API is called, multiple statuses can be transferred for filtering, for example, status=available&status=error.

Enumeration values:

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

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

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.

backups

Array of BackupResp objects

Backup list

count

Integer

Number of backups

offset

Integer

Offset where the query starts

Minimum: 0

Default: 0

limit

Integer

Number of records displayed on each page

Minimum: 1

Maximum: 1000

Default: 1000

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, or OS::Sfs::Turbo

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

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

auto_trigger

Boolean

Whether the backup is automatically generated

bootable

Boolean

Whether the backup is a system disk backup

incremental

Boolean

Whether the backup is an incremental 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

image_id

String

Image ID

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

200

OK