8.3. Showing snapshot details

GET /v3/{project_id}/snapshots/{snapshot_id}

Shows the details of a snapshot with the specified ID.

Source: https://docs.openstack.org/api-ref/block-storage/v3/index.html#show-a-snapshot-s-details

8.3.1. Request

Name In Type Description
project_id path string The UUID of the project in a multi-tenancy cloud.
snapshot_id path string The UUID of the snapshot.

8.3.1.1. Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:8776/v3/f5d834d636c642c7bfe8af86139c6f26/snapshots/aebe052f-6c13-417a-8ea9-771f40d6667f

8.3.2. Response

Name In Type Description
status body string The status for the snapshot.
os-extended-snapshot-attributes:progress body string A percentage value for the build progress.
description body string A description for the snapshot.
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.

name body string The name of the Volume Transfer.
snapshot body object A snapshot object.
user_id body string

The UUID of the user.

New in version 3.41

volume_id body string If the snapshot was created from a volume, the volume ID.
os-extended-snapshot-attributes:project_id body string The UUID of the owning project.
size body integer The size of the volume, in gibibytes (GiB).
id body string The snapshot UUID.
metadata body object One or more metadata key and value pairs for the snapshot, if any.
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 the previous example, the offset value is -05:00.

If the updated_at date and time stamp is not set, its value is null.

8.3.2.1. Status codes

8.3.2.1.1. Success

Code Reason
200 - OK Request was successful.

8.3.2.2. Example

{
  "snapshot": {
    "status": "available",
    "description": null,
    "updated_at": "2020-03-11T14:01:56.522040",
    "volume_id": "cb623b3c-f14a-48d6-a339-d9fda95be662",
    "id": "aebe052f-6c13-417a-8ea9-771f40d6667f",
    "size": 2,
    "os-extended-snapshot-attributes:progress": "100%",
    "name": "Snapshot-vol1/2020-03-11 05:01:53",
    "os-extended-snapshot-attributes:project_id": "f5d834d636c642c7bfe8af86139c6f26",
    "created_at": "2020-03-11T14:01:54.381048",
    "metadata": {}
  }
}