Listing backups with details
GET /v3/{project_id}/backups/detail
List backups with details to which the project has access.
Source: https://docs.openstack.org/api-ref/block-storage/v3/#list-backups-with-detail
Request
Parameters
Name | In | Type | Description |
---|---|---|---|
project_id
|
path | string | The UUID of the project. |
all_tenants (Optional) |
query | string | Shows details for all project. Admin only. |
sort (Optional) |
query | string | Comma-separated list of sort keys and optional sort directions in the form of <key>[:<direction>] . A valid sort key value is name , status , container_format , disk_format , size , id , created_at , or updated_at . Default is created_at . A valid direction is asc (ascending) or desc (descending). |
limit (Optional) |
query | integer | Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request. |
offset (Optional) |
query | integer | Used in conjunction with limit to return a slice of items. offset specifies where to start in the list. |
marker (Optional) |
query | string | The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request. |
with_count (Optional)
|
query | boolean |
Whether to show count in the API response or not, default is New in version 3.45 |
Example
# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \ https://<node_IP_addr>:8776/v3/3046fb2c2a314a0fbb32607caa1e5277/backups/detail
Response
Parameters
Name | In | Type | Description |
---|---|---|---|
backups
|
body | array |
A list of backup objects. |
id
|
body | string | The UUID of the backup. |
backup_id
|
body | string | The UUID of the backup. |
volume_id
|
body | string | The UUID of the volume. |
status
|
body | string | The backup status. |
object_count
|
body | integer | The number of objects in the backup. |
fail_reason
|
body | string | If the backup failed, the reason for the failure. Otherwise, null. |
container (Optional) |
body | string | The container name or null. |
description (Optional) |
body | string | The backup description or null. |
availability_zone (Optional) |
body | string | The name of the availability zone. |
created_at
|
body | string |
The date and time when the resource was created.
The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, The |
updated_at
|
body | string |
The date and time when the resource was updated.
The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, The |
links
|
body | array | Links for the backup. |
name
|
body | string | The backup name. |
has_dependent_backups (Optional) |
body | boolean | If this value is true , there are other backups depending on this backup. |
size
|
body | integer | The size of the volume, in gibibytes (GiB). |
is_incremental (Optional) |
body | boolean | Indicates whether the backup mode is incremental. If this value is true , the backup mode is incremental. If this value is false , the backup mode is full. |
data_timestamp
|
body | string | The time when the data on the volume was first saved. If it is a backup from a volume, it will be the same as created_at for a backup. If it is a backup from a snapshot, it will be the same as created_at for the snapshot. |
snapshot_id (Optional) |
body | string | The UUID of the source volume snapshot. |
os-backup-project-attr:project_id
|
body | string |
The UUID of the owning project. New in version 3.18 |
metadata (Optional) |
body | object |
The backup metadata key value pairs. New in version 3.43 |
user_id
|
body | string |
The UUID of the project owner. New in version 3.56 |
encryption_key_id (Optional) |
body | string |
The UUID of the encryption key. Only included for encrypted volumes. New in version 3.64 |
Status codes
Success
Code | Reason |
---|---|
200 - OK
|
Request was successful. |
Error
Code | Reason |
---|---|
400 - Bad Request
|
Some content in the request was invalid. |
Example
{ "backups": [ { "id": "1e49d21e-44e1-401c-acc5-59115c12f0c4", "status": "available", "size": 1, "object_count": 4, "availability_zone": null, "container": "bucket1", "created_at": "2024-05-09T10:41:14.272633", "updated_at": "2024-05-09T10:41:28.005870", "name": "vm2/cirros/Boot volume-2024-05-09T10:41:13", "description": null, "fail_reason": null, "volume_id": "98db149d-b9e6-42d7-814d-492563c56fef", "links": [ { "rel": "self", "href": "https://<node_IP_addr>:8776/v3/3046fb2c2a314a0fbb32607caa1e5277/backups/1e49d21e-44e1-401c-acc5-59115c12f0c4" }, { "rel": "bookmark", "href": "https://<node_IP_addr>:8776/3046fb2c2a314a0fbb32607caa1e5277/backups/1e49d21e-44e1-401c-acc5-59115c12f0c4" } ], "is_incremental": false, "has_dependent_backups": false, "snapshot_id": null, "data_timestamp": "2024-05-09T10:41:14.272633", "progress": 100.0 } ] }