Showing backup details

GET /v3/{project_id}/backups/{backup_id}

Shows details for a backup.

Source: https://docs.openstack.org/api-ref/block-storage/v3/#show-backup-detail

Request

Parameters

Name	In	Type	Description
`project_id`	path	string	The UUID of the project.
`backup_id`	path	string	The UUID for a backup.

Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:8776/v3/3046fb2c2a314a0fbb32607caa1e5277/backups/bcb8fc88-a0ba-4cd0-801a-e9face1eac88

Response

Parameters

Name	In	Type	Description
`backup`	body	object	A `backup` object.
`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, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In this example, the offset value is `-05:00`.
`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, `2015-08-27T09:49:58-05:00`. The `±hh:mm` value, if included, is the time zone as an offset from UTC. In this example, the offset value is `-05:00`.
`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
`401 - Unauthorized`	User must authenticate before making a request.
`404 - Not Found`	The requested resource could not be found.

Example

{
  "backup": {
    "id": "bcb8fc88-a0ba-4cd0-801a-e9face1eac88",
    "status": "available",
    "size": 1,
    "object_count": 4,
    "availability_zone": null,
    "container": "bucket1",
    "created_at": "2024-05-09T14:16:49.594833",
    "updated_at": "2024-05-09T14:17:03.236015",
    "name": "vm2/cirros/Boot volume-2024-05-09T10:41:13",
    "description": "New backup",
    "fail_reason": null,
    "volume_id": "98db149d-b9e6-42d7-814d-492563c56fef",
    "links": [
      {
        "rel": "self",
        "href": "https://<node_IP_addr>:8776/v3/3046fb2c2a314a0fbb32607caa1e5277/backups/bcb8fc88-a0ba-4cd0-801a-e9face1eac88"
      },
      {
        "rel": "bookmark",
        "href": "https://<node_IP_addr>:8776/3046fb2c2a314a0fbb32607caa1e5277/backups/bcb8fc88-a0ba-4cd0-801a-e9face1eac88"
      }
    ],
    "is_incremental": false,
    "has_dependent_backups": false,
    "snapshot_id": null,
    "data_timestamp": "2024-05-09T14:16:49.594833",
    "progress": 100.0
  }
}