DocsKnowledge BaseAPI Explorer
Documentation›Explore more›ZStack Cloud›RESTful API OverviewZCF
Document navigation

FlattenVmInstance

API Request

URLs
PUT zstack/v1/vm-instances/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "flattenVmInstance": {
    "full": true,
    "dryRun": false
  },
  "systemTags": [],
  "userTags": []
}
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"flattenVmInstance":{"full":true,"dryRun":false}}' http://localhost:8080/zstack/v1/vm-instances/cb728238f38a3adcadac91425f9534b3/actions
Request Parameters
Name Typ Location Description Valid Value Starting Version
uuid String url The resource UUID. 4.7.0
full boolean body (contained in the flattenVmInstance structure) Optional. Flatten all volumes attached to the VM instance. 4.7.0
dryRun boolean body (contained in the flattenVmInstance structure) Optional. Trial. Predicate the data usage. 4.7.0
systemTags List body Optional. The system tags. 4.7.0
userTags List body Optional. The user tags. 4.7.0

API Response

Sample Response
{
  "inventory": {
    "uuid": "ce09028b684c3eb78219f5e20bddc3d5",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "195b75808f5e334da0c35051b798605c",
    "clusterUuid": "9b24facbfe7e38d4a7959e15cb49932e",
    "imageUuid": "8cc2d322e48031a685dd7cf69bf69614",
    "hostUuid": "01dd8eacdf0b3b809f420fad019b4359",
    "lastHostUuid": "3462e6ec5e333d5f958c029bc9678610",
    "instanceOfferingUuid": "9b45c2c9d9323793a012be186db3dd5b",
    "rootVolumeUuid": "7197e64d225232a8947765e00de9b58c",
    "platform": "Linux",
    "defaultL3NetworkUuid": "9f1d4713936036fa905da008dc91311f",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "12dadcafdbe2331fa1b5048a86f262c9",
        "vmInstanceUuid": "ce09028b684c3eb78219f5e20bddc3d5",
        "usedIpUuid": "592c4dc8c1c83a5185488e3aded371b4",
        "l3NetworkUuid": "9f1d4713936036fa905da008dc91311f",
        "ip": "192.168.1.10",
        "mac": "00:0c:29:bd:99:fc",
        "hypervisorType": "KVM",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "deviceId": 0,
        "state": "enable",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "7197e64d225232a8947765e00de9b58c",
        "name": "Root-Volume-For-VM-ce09028b684c3eb78219f5e20bddc3d5",
        "primaryStorageUuid": "a8c0be2045ef3d5eacd48a201bccf5b8",
        "vmInstanceUuid": "ce09028b684c3eb78219f5e20bddc3d5",
        "diskOfferingUuid": "a6eb081851d531b29f771c672c194dbd",
        "rootImageUuid": "8cc2d322e48031a685dd7cf69bf69614",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-7197e64d225232a8947765e00de9b58c/7197e64d225232a8947765e00de9b58c.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}
Name Type Description Starting Version
success boolean Whether the operation succeeded. 4.7.0
inventory VmInstanceInventory See inventory. 4.7.0
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 4.7.0
#inventory
Name Type Description Starting Version
uuid String The resource UUID. 4.7.0
name String The resource name. 4.7.0
description String The resource description. 4.7.0
zoneUuid String The zone UUID. 4.7.0
clusterUuid String The cluster UUID. 4.7.0
imageUuid String The image UUID. 4.7.0
hostUuid String The host UUID. 4.7.0
lastHostUuid String The last host UUID. 4.7.0
instanceOfferingUuid String The instance offering UUID. 4.7.0
rootVolumeUuid String The root volume UUID. 4.7.0
platform String The platform. 4.7.0
architecture String The architecture. 4.7.0
defaultL3NetworkUuid String The default L3 network UUID. 4.7.0
type String The resource type. 4.7.0
hypervisorType String The hypervisor type. 4.7.0
memorySize Long The memory size. 4.7.0
cpuNum Integer The number of CPUs. 4.7.0
cpuSpeed Long The CPU speed. 4.7.0
allocatorStrategy String The allocator strategy. 4.7.0
createDate Timestamp The creation date. 4.7.0
lastOpDate Timestamp The last operation date. 4.7.0
state String The resource state. 4.7.0
guestOsType String The guest OS type. 4.7.0
vmNics List See vmNics. 4.7.0
allVolumes List See allVolumes. 4.7.0
vmCdRoms List See vmCdRoms. 4.7.0
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 4.7.0
vmInstanceUuid String The VM instance UUID. 4.7.0
l3NetworkUuid String The L3 network UUID. 4.7.0
ip String The IP address. 4.7.0
mac String The MAC address. 4.7.0
hypervisorType String The hypervisor type. 4.7.0
netmask String The netmask. 4.7.0
gateway String The gateway IP address. 4.7.0
metaData String The metadata. 4.7.0
ipVersion Integer The IP version. 4.7.0
driverType String The driver type. 4.7.0
internalName String The internal name. 4.7.0
deviceId Integer The device ID. 4.7.0
type String The resource type. 4.7.0
state String The NIC state. 4.7.0
createDate Timestamp The creation date. 4.7.0
lastOpDate Timestamp the last operation date. 4.7.0
usedIps List See usedIps. 4.7.0
#usedIps
Name Type Description Starting Version
uuid String The resource UUID. 4.7.0
ipRangeUuid String The UUID of the IP range 4.7.0
l3NetworkUuid String The L3 network UUID. 4.7.0
ipVersion Integer The IP version. 4.7.0
ip String The IP address. 4.7.0
netmask String The netmask. 4.7.0
gateway String The gateway IP address. 4.7.0
usedFor String The intended use. 4.7.0
ipInLong long The IP address represented as a long integer. 4.7.0
vmNicUuid String The VM NIC UUID. 4.7.0
createDate Timestamp The creation date. 4.7.0
lastOpDate Timestamp The last operation date, 4.7.0
#allVolumes
Name Type Description Starting Vesion
uuid String The resource UUID. 4.7.0
name String The resource name. 4.7.0
description String The resource description. 4.7.0
primaryStorageUuid String The primary storage UUID. 4.7.0
vmInstanceUuid String The VM instance UUID. 4.7.0
diskOfferingUuid String The disk offering UUID. 4.7.0
rootImageUuid String The root image UUID. 4.7.0
installPath String The installation path. 4.7.0
type String The resource type. 4.7.0
format String The format. 4.7.0
size Long The size. 4.7.0
actualSize Long The actual size. 4.7.0
deviceId Integer The device ID. 4.7.0
state String The resource state. 4.7.0
status String The resource status. 4.7.0
createDate Timestamp The creation date. 4.7.0
lastOpDate Timestamp The last operation date. 4.7.0
isShareable Boolean Whether the resource is shareable. 4.7.0
volumeQos String The volume QoS. 4.7.0
lastDetachDate Timestamp The last detach date. 4.7.0
lastVmInstanceUuid String The last VM instance UUID. 4.7.0
#vmCdRoms
Name Type Description Starting Version
uuid String The resource UUID. 4.7.0
vmInstanceUuid String The VM instance UUID. 4.7.0
deviceId Integer The device ID. 4.7.0
isoUuid String The ISO UUID. 4.7.0
isoInstallPath String The ISO install path. 4.7.0
name String The resource name. 4.7.0
description String The resource description. 4.7.0
createDate Timestamp The creation date. 4.7.0
lastOpDate Timestamp The last operation date. 4.7.0
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 4.7.0
description String The brief description of the error. 4.7.0
details String The details about the error. 4.7.0
elaboration String The reserved field. Default value: null. 4.7.0
opaque LinkedHashMap The reserved field. Default value: null. 4.7.0
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 4.7.0

SDK Sample

Java SDK
FlattenVmInstanceAction action = new FlattenVmInstanceAction();
action.uuid = "cb728238f38a3adcadac91425f9534b3";
action.full = true;
action.dryRun = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
FlattenVmInstanceAction.Result res = action.call();
Python SDK
action = FlattenVmInstanceAction()
action.uuid = "cb728238f38a3adcadac91425f9534b3"
action.full = true
action.dryRun = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()
PreviousQueryVmSchedHistoryNextExecuteGuestVmCommand
API Reference | 5.5.38 | ZStack Cloud · ZCF | ZStack Resource Center