Updating snapshots
PUT /v3/{project_id}/snapshots/{snapshot_id}
Update a snapshot.
Request
Parameters
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. |
snapshot
|
body | object | A snapshot object. |
name
|
body | string | The name of the snapshot. |
description (Optional) |
body | string | A description for the snapshot. Default is
None . |
Example
# curl -ks -X PUT -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' -d ' { "snapshot": { "name": "snapshot2", "description": "New description" } }' https://<node_IP_addr>:8776/v3/f5d834d636c642c7bfe8af86139c6f26/snapshots/aebe052f-6c13-417a-8ea9-771f40d6667f
Response
Parameters
Name | In | Type | Description |
---|---|---|---|
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. |
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). |
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 |
Status codes
Success
Code | Reason |
---|---|
200 - OK
|
Request was successful. |
Example
{ "snapshot": { "status": "available", "size": 2, "metadata": {}, "name": "snapshot2", "volume_id": "cb623b3c-f14a-48d6-a339-d9fda95be662", "created_at": "2020-03-11T14:01:54.381048", "description": "New description", "id": "aebe052f-6c13-417a-8ea9-771f40d6667f", "updated_at": "2020-03-11T14:01:56.522040" } }