Volume snapshots
1. snapshots()
Get the list of snapshots
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string | if specified, you get exactly one snapshot instance |
Return value: List of Snapshot instance
Return value example:
istack/volumev2/v2/snapshot Snapshot
status : error
name : snap-test-php
created_at : 2016-08-19T16:20:36.000000
size : 10
volume_id : 043d96d8-e605-4ebb-8c06-b8f2e19aee1d
metadata : {}
id : 4e1d18e9-d095-44f6-abb5-3ad6fd77b73d
description : Daily backup
2. create_snapshot(**attrs)
Create a snapshot
Parameters:
| Name | Type | Description |
|---|---|---|
| name (Optional) | xsd:string | The name of the snapshot. Default is None. |
| description (Optional) | xsd:string | A description for the snapshot. Default is None. |
| volume_id | csapi:UUID | To create a snapshot from an existing volume, specify the UUID of the existing volume. |
| force (Optional) | xsd:boolean | Indicates whether to snapshot, even if the volume is attached. Default is false. |
Return value: Snapshot Instance
Return value example:
istack/volumev2/v2/snapshot Snapshot
status : error
name : snap-test-php
created_at : 2016-08-19T16:20:36.000000
size : 10
volume_id : 043d96d8-e605-4ebb-8c06-b8f2e19aee1d
metadata : {}
id : 4e1d18e9-d095-44f6-abb5-3ad6fd77b73d
description : Daily backup
3. update_snapshot(snapshot, **attrs)
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string(inside snapshot param) | must be specified |
| name (Optional) | xsd:string | The name of the snapshot. Default is None. |
| description (Optional) | xsd:string | A description for the snapshot. Default is None. |
Return value: Snapshot Instance
Return value example:
istack/volumev2/v2/snapshot Snapshot
status : error
name : snap-test-php
created_at : 2016-08-19T16:20:36.000000
size : 10
volume_id : 043d96d8-e605-4ebb-8c06-b8f2e19aee1d
metadata : {}
id : 4e1d18e9-d095-44f6-abb5-3ad6fd77b73d
description : Daily backup
4. delete_snapshot(snapshot)
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string(inside snapshot param) | must be specified |
Return value: None
5. snapshot_metadata(snapshot)
Get the metadata of snapshot
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string(inside snapshot param) | must be specified |
Return value: dict
Return value example:
{u’name’:u’pythonL’}
6. update_snapshot_metadata(snapshot, **attrs)
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string(inside snapshot param) | must be specified |
| name(optional) | string | name |
Return value: dict
Return value example:
{u’name’:u’pythonL’}