ZStack ZSphere Documentation
All Version
All
ZStack ZSphere Documentation>ZSphere API Reference(v5.0.0)>Data Protection>Snapshot Interfaces
Get PDF

Data Protection


Create Snapshot Group (CreateVolumeSnapshotGroup)

API Request

URLs
POST zstack/v1/volume-snapshots/group
Headers
Authorization: OAuth the-session-uuid
Body
{   "params": {     "rootVolumeUuid": "901cae4fd9f43a1ca20da4146ddaec50",     "name": "test"   },   "systemTags": [],   "userTags": [] }
Note: The systemTags and userTags fields in the above example are optional. They are listed to indicate that the body can contain these two fields.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"rootVolumeUuid":"901cae4fd9f43a1ca20da4146ddaec50","name":"test"}}' http://localhost:8080/zstack/v1/volume-snapshots/group
Parameter List
Name Type Location Description Allowed Values Starting Version
rootVolumeUuid String body (contained in the params structure) Root disk UUID 3.6.0
name String body (contained in the params structure) Resource name 3.6.0
description (optional) String body (contained in the params structure) Detailed description of the resource 3.6.0
resourceUuid (optional) String body (contained in the params structure) 3.6.0
tagUuids (optional) List body (contained in the params structure) Tag UUID list 3.6.0
systemTags (optional) List body 3.6.0
userTags (optional) List body 3.6.0

API Response

Response Example
{   "inventory": {     "uuid": "4b13e23059033e2dbfac63b5b16eba11",     "snapshotCount": 1.0,     "name": "group",     "vmInstanceUuid": "9ff17180fded31c2b9e4e5751ebcb2ba",     "createDate": "Nov 14, 2017 10:20:57 PM",     "lastOpDate": "Nov 14, 2017 10:20:57 PM",     "volumeSnapshotRefs": [       {         "volumeSnapshotUuid": "e83b2d306f0d353a889096ca0b44b444",         "volumeSnapshotGroupUuid": "4b13e23059033e2dbfac63b5b16eba11",         "deviceId": 0.0,         "snapshotDeleted": false,         "volumeUuid": "edc07fe8d8a335ec8aa00f23b88fc1c6",         "volumeName": "ROOT-volume",         "volumeType": "Root",         "volumeSnapshotInstallPath": "/Cloud_ps/to/path/snap.qcow2",         "volumeSnapshotName": "group-ROOT-volume",         "createDate": "Nov 14, 2017 10:20:57 PM",         "lastOpDate": "Nov 14, 2017 10:20:57 PM"       }     ]   } }
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error 3.6.0
inventory VolumeSnapshotGroupInventory For details, see inventory 3.6.0
#error
Name Type Description Starting Version
code String Error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001 3.6.0
description String Brief description of the error 3.6.0
details String Detailed information about the error 3.6.0
elaboration String Reserved field. Default is null 3.6.0
opaque LinkedHashMap Reserved field. Default is null 3.6.0
cause ErrorCode Root error. The source error that caused the current error. This field is null if no root error exists 3.6.0
#inventory
Name Type Description Starting Version
uuid String UUID of the resource. Uniquely identifies the resource 3.6.0
snapshotCount Integer Number of snapshots in the group 3.6.0
name String Resource name 3.6.0
description String Detailed description of the resource 3.6.0
vmInstanceUuid String Virtual Machine UUID 3.6.0
createDate Timestamp Creation time 3.6.0
lastOpDate Timestamp Last modification time 3.6.0
volumeSnapshotRefs List For details, see volumeSnapshotRefs 3.6.0
#volumeSnapshotRefs
Name Type Description Starting Version
volumeSnapshotUuid String Disk snapshot UUID 3.6.0
volumeSnapshotGroupUuid String Snapshot group UUID 3.6.0
deviceId int Device mount order when the snapshot was taken 3.6.0
snapshotDeleted boolean Whether the snapshot has been deleted 3.6.0
volumeUuid String Disk UUID 3.6.0
volumeName String Disk name 3.6.0
volumeType String Disk type 3.6.0
volumeSnapshotInstallPath String Snapshot installation path 3.6.0
volumeSnapshotName String Snapshot name 3.6.0
createDate Timestamp Creation time 3.6.0
lastOpDate Timestamp Last modification time 3.6.0

SDK Examples

Java SDK
CreateVolumeSnapshotGroupAction action = new CreateVolumeSnapshotGroupAction(); action.rootVolumeUuid = "901cae4fd9f43a1ca20da4146ddaec50"; action.name = "test"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateVolumeSnapshotGroupAction.Result res = action.call();
Python SDK
CreateVolumeSnapshotGroupAction action = CreateVolumeSnapshotGroupAction() action.rootVolumeUuid = "901cae4fd9f43a1ca20da4146ddaec50" action.name = "test" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateVolumeSnapshotGroupAction.Result res = action.call()

Delete Snapshot Group (DeleteVolumeSnapshotGroup)

API Request

URLs
DELETE zstack/v1/volume-snapshots/group/{uuid}?deleteMode={deleteMode}
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/volume-snapshots/group/f7b2175eebba3161b029689cb32f9b14?deleteMode=Permissive
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url UUID of the resource. Uniquely identifies the resource 3.6.0
deleteMode (optional) String body 3.6.0
systemTags (optional) List body 3.6.0
userTags (optional) List body 3.6.0

API Response

Response Example
{   "results": [     {       "success": false,       "error": {         "code": "SYS.1001",         "description": "internal error"       }     }   ] }
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error 3.6.0
results List For details, see results 3.6.0
#error
Name Type Description Starting Version
code String Error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001 3.6.0
description String Brief description of the error 3.6.0
details String Detailed information about the error 3.6.0
elaboration String Reserved field. Default is null 3.6.0
opaque LinkedHashMap Reserved field. Default is null 3.6.0
cause ErrorCode Root error. The source error that caused the current error. This field is null if no root error exists 3.6.0
#results
Name Type Description Starting Version
snapshotUuid String Snapshot UUID 3.6.0
volumeUuid String Disk UUID 3.6.0
success boolean 3.6.0
error ErrorCode For details, see error 3.6.0
#error
Name Type Description Starting Version
code String Error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001 3.6.0
description String Brief description of the error 3.6.0
details String Detailed information about the error 3.6.0
elaboration String Reserved field. Default is null 3.6.0
opaque LinkedHashMap Reserved field. Default is null 3.6.0
cause ErrorCode Root error. The source error that caused the current error. This field is null if no root error exists 3.6.0

SDK Examples

Java SDK
DeleteVolumeSnapshotGroupAction action = new DeleteVolumeSnapshotGroupAction(); action.uuid = "f7b2175eebba3161b029689cb32f9b14"; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DeleteVolumeSnapshotGroupAction.Result res = action.call();
Python SDK
DeleteVolumeSnapshotGroupAction action = DeleteVolumeSnapshotGroupAction() action.uuid = "f7b2175eebba3161b029689cb32f9b14" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DeleteVolumeSnapshotGroupAction.Result res = action.call()

Update Snapshot Group (UpdateVolumeSnapshotGroup)

API Request

URLs
PUT zstack/v1/volume-snapshots/group/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{   "updateVolumeSnapshotGroup": {     "name": "new name"   },   "systemTags": [],   "userTags": [] }
Note: The systemTags and userTags fields in the above example are optional. They are listed to indicate that the body can contain these two fields.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"updateVolumeSnapshotGroup":{"name":"new name"}}' http://localhost:8080/zstack/v1/volume-snapshots/group/c39089cddbd836628f346b14beafe2d3/actions
Parameter List
Name Type Location Description Allowed Values Starting Version
name (Optional) String body (Contained in the updateVolumeSnapshotGroup structure) Resource name 3.6.0
description (Optional) String body (Contained in the updateVolumeSnapshotGroup structure) Detailed description of the resource 3.6.0
uuid String url The UUID of the resource. Uniquely identifies the resource 3.6.0
systemTags (Optional) List body 3.6.0
userTags (Optional) List body 3.6.0

API Response

Response Example
{   "inventory": {     "uuid": "a261086918fe3c04be683430f15920a2",     "snapshotCount": 1.0,     "name": "group",     "vmInstanceUuid": "98ac921100b43981b493071b6430bb2b",     "createDate": "Nov 14, 2017 10:20:57 PM",     "lastOpDate": "Nov 14, 2017 10:20:57 PM",     "volumeSnapshotRefs": [       {         "volumeSnapshotUuid": "7ac8675cd8a9389ca343a2a7d49c47d7",         "volumeSnapshotGroupUuid": "a261086918fe3c04be683430f15920a2",         "deviceId": 0.0,         "snapshotDeleted": false,         "volumeUuid": "6fb0e4a0c3d6315bbb5c08a1a33bc231",         "volumeName": "ROOT-volume",         "volumeType": "Root",         "volumeSnapshotInstallPath": "/Cloud_ps/to/path/snap.qcow2",         "volumeSnapshotName": "group-ROOT-volume",         "createDate": "Nov 14, 2017 10:20:57 PM",         "lastOpDate": "Nov 14, 2017 10:20:57 PM"       }     ]   } }
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error 3.6.0
inventory VolumeSnapshotGroupInventory For details, see inventory 3.6.0
#error
Name Type Description Starting Version
code String The error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001 3.6.0
description String A brief description of the error 3.6.0
details String The detailed error information 3.6.0
elaboration String A reserved field. The default value is null 3.6.0
opaque LinkedHashMap A reserved field. The default value is null 3.6.0
cause ErrorCode The root error. The source error that caused the current error. If no root error exists, this field is null 3.6.0
#inventory
Name Type Description Starting Version
uuid String The UUID of the resource. Uniquely identifies the resource 3.6.0
snapshotCount Integer The number of snapshots in the group 3.6.0
name String Resource name 3.6.0
description String Detailed description of the resource 3.6.0
vmInstanceUuid String Virtual Machine UUID 3.6.0
createDate Timestamp Creation time 3.6.0
lastOpDate Timestamp Last modification time 3.6.0
volumeSnapshotRefs List For details, see volumeSnapshotRefs 3.6.0
#volumeSnapshotRefs
Name Type Description Starting Version
volumeSnapshotUuid String Disk snapshot UUID 3.6.0
volumeSnapshotGroupUuid String Snapshot group UUID 3.6.0
deviceId int The device ID of the disk when the snapshot was taken 3.6.0
snapshotDeleted boolean Whether the snapshot has been deleted 3.6.0
volumeUuid String Disk UUID 3.6.0
volumeName String Disk name 3.6.0
volumeType String Disk type 3.6.0
volumeSnapshotInstallPath String Snapshot install path 3.6.0
volumeSnapshotName String Snapshot name 3.6.0
createDate Timestamp Creation time 3.6.0
lastOpDate Timestamp Last modification time 3.6.0

SDK Examples

Java SDK
UpdateVolumeSnapshotGroupAction action = new UpdateVolumeSnapshotGroupAction(); action.name = "new name"; action.uuid = "c39089cddbd836628f346b14beafe2d3"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; UpdateVolumeSnapshotGroupAction.Result res = action.call();
Python SDK
UpdateVolumeSnapshotGroupAction action = UpdateVolumeSnapshotGroupAction() action.name = "new name" action.uuid = "c39089cddbd836628f346b14beafe2d3" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" UpdateVolumeSnapshotGroupAction.Result res = action.call()








Archives

Download Document Archives

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Cannot be empty.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.
同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.