Get Memory Snapshot Group Reference

GET/zstack/v1/memory-snapshots/group/reference

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/memory-snapshots/group/reference?resourceUuid=293e9dd057c831608cf59cd377ba0d03&resourceType=L3NetworkVO

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
resourceUuidStringqueryResource UUID 4.4.24
resourceTypeStringqueryResource type 4.4.24
systemTags (Optional)ListquerySystem tags 4.4.24
userTags (Optional)ListqueryUser tags 4.4.24

API Response

{
  "inventories": [
    {
      "uuid": "22f6a9534922339f95c15db177ac2c75",
      "snapshotCount": 1.0,
      "name": "group",
      "vmInstanceUuid": "e5c0251850be3ffe85db33e7ecf12b75",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "volumeSnapshotRefs": [
        {
          "volumeSnapshotUuid": "bfb9af2450753ac292c46c3afcadd7a6",
          "volumeSnapshotGroupUuid": "22f6a9534922339f95c15db177ac2c75",
          "deviceId": 0.0,
          "snapshotDeleted": false,
          "volumeUuid": "976ab88982753cc8951efd915b76573f",
          "volumeName": "ROOT-volume",
          "volumeType": "Root",
          "volumeSnapshotInstallPath": "/zstack_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"
        }
      ]
    }
  ],
  "resourceUuid": "c8a0949c175c380db27cc5c78e8d01f7"
}
NameTypeDescriptionStarting Version
resourceUuidStringResource UUID4.4.24
successboolean 4.4.24
inventoriesListFor details, see inventories4.4.24
errorErrorCodeThe error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error4.4.24

inventories

NameTypeDescriptionStarting Version
uuidStringThe UUID of the resource. Uniquely identifies the resource4.4.24
snapshotCountIntegerThe number of snapshots in the group4.4.24
nameStringResource name4.4.24
descriptionStringDetailed description of the resource4.4.24
vmInstanceUuidStringVirtual Machine UUID4.4.24
createDateTimestampCreation time4.4.24
lastOpDateTimestampLast modification time4.4.24
volumeSnapshotRefsListFor details, see volumeSnapshotRefs4.4.24

volumeSnapshotRefs

NameTypeDescriptionStarting Version
volumeSnapshotUuidStringDisk snapshot UUID4.4.24
volumeSnapshotGroupUuidStringSnapshot group UUID4.4.24
deviceIdintThe device ID of the disk when the snapshot was taken4.4.24
snapshotDeletedbooleanWhether the snapshot has been deleted4.4.24
volumeUuidStringDisk UUID4.4.24
volumeNameStringDisk name4.4.24
volumeTypeStringDisk type4.4.24
volumeSnapshotInstallPathStringSnapshot install path4.4.24
volumeSnapshotNameStringSnapshot name4.4.24
createDateTimestampCreation time4.4.24
lastOpDateTimestampLast modification time4.4.24

error

NameTypeDescriptionStarting Version
codeStringThe error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.10014.4.24
descriptionStringA brief description of the error4.4.24
detailsStringThe detailed error information4.4.24
elaborationStringA reserved field. The default value is null4.4.24
opaqueLinkedHashMapA reserved field. The default value is null4.4.24
causeErrorCodeThe root error. The source error that caused the current error. If no root error exists, this field is null4.4.24

SDK Examples

Java SDK

GetMemorySnapshotGroupReferenceAction action = new GetMemorySnapshotGroupReferenceAction();
action.resourceUuid = "293e9dd057c831608cf59cd377ba0d03";
action.resourceType = "L3NetworkVO";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetMemorySnapshotGroupReferenceAction.Result res = action.call();

Python SDK

GetMemorySnapshotGroupReferenceAction action = GetMemorySnapshotGroupReferenceAction()
action.resourceUuid = "293e9dd057c831608cf59cd377ba0d03"
action.resourceType = "L3NetworkVO"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetMemorySnapshotGroupReferenceAction.Result res = action.call()