Listing snapshots
GET /v3/{project_id}/snapshots
Lists all volume snapshots, with summary information that the project can access.
Request
Parameters
Name | In | Type | Description |
---|---|---|---|
project_id
|
path | string | The UUID of the project in a multi-tenancy cloud. |
all_tenants (Optional) |
query | string | Shows details for all projects. Admin only. |
sort (Optional) |
query | string | Comma-separated list of sort keys and optional
sort directions in the form of <key>[:<direction>] . 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
is 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 New in version 3.45 |
Example
# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \ https://<node_IP_addr>:8776/v3/f5d834d636c642c7bfe8af86139c6f26/snapshots
Response
Parameters
Name | In | Type | Description |
---|---|---|---|
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. |
name
|
body | string | The name of the snapshot. |
status
|
body | string | The status for the snapshot. |
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, The |
metadata
|
body | object | One or more metadata key and value pairs for the snapshot, if any. |
id
|
body | string | The snapshot UUID. |
size
|
body | integer | The size of the volume, in gibibytes (GiB). |
count (Optional) |
body | integer |
The total count of requested resource before pagination is applied. New in version 3.45 |
updated_at
|
body | string |
The date and time when the resource was updated. If the resource has
not been updated, this field will be The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, The |
snapshots_links (Optional) |
body | array | Links for the snapshot. |
Status codes
Success
Code | Reason |
---|---|
200 - OK
|
Request was successful. |
Error
Code | Reason |
---|---|
400 - Bad Request
|
Some content in the request was invalid. |
Example
{ "snapshots": [ { "status": "available", "size": 2, "metadata": {}, "name": "Snapshot-vol1/2020-03-11 05:01:53", "volume_id": "cb623b3c-f14a-48d6-a339-d9fda95be662", "created_at": "2020-03-11T14:01:54.381048", "description": null, "id": "aebe052f-6c13-417a-8ea9-771f40d6667f", "updated_at": "2020-03-11T14:01:56.522040" } ] }