虚拟机相关接口

设置虚拟机控制台模式

PUT/zstack/v1/vm-instances/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "setVmConsoleMode": {
    "mode": "vnc"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"setVmConsoleMode":{"mode":"vnc"}}' \
http://localhost:8080/zstack/v1/vm-instances/457f2f9aa0373d5486df01556bf995b2/actions

参数列表

名字类型位置描述可选值起始版本
uuidStringurl资源的UUID，唯一标示该资源 3.7.0
modeStringbody(包含在setVmConsoleMode结构中)  3.7.0
systemTags (可选)Listbody  3.7.0
userTags (可选)Listbody  3.7.0

API返回

返回示例

{
  "inventory": {
    "uuid": "bd5f6b44171130a389d39318c49f338c",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "ae3bc988c4ec3c1cb4d3998099499ecb",
    "clusterUuid": "2e8dda4c14093d8bac5e2a0c0543483c",
    "imageUuid": "6cb82e96abd3374bbdc8bc927a86cad6",
    "hostUuid": "cadb2c70ab9f33b4a3c33d5b09369572",
    "lastHostUuid": "8ba7ab53d75f3881853138acdbe4eb65",
    "instanceOfferingUuid": "a13d6f6bb99830a2b097bccfc634ca36",
    "rootVolumeUuid": "f4324804b25236ffaf75f827300bd3cb",
    "platform": "Linux",
    "defaultL3NetworkUuid": "5d74add19ca63d63994ff87a64d12747",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM",
    "state": "Stopped",
    "vmNics": [
      {
        "uuid": "b80845c40f1237839ecb623a792f895c",
        "vmInstanceUuid": "bd5f6b44171130a389d39318c49f338c",
        "usedIpUuid": "506c07c24d363c1c9eeac5416dadb23d",
        "l3NetworkUuid": "5d74add19ca63d63994ff87a64d12747",
        "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 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "f4324804b25236ffaf75f827300bd3cb",
        "name": "Root-Volume-For-VM-bd5f6b44171130a389d39318c49f338c",
        "primaryStorageUuid": "6a431d5d6e153d5d80746aa06d64d80b",
        "vmInstanceUuid": "bd5f6b44171130a389d39318c49f338c",
        "diskOfferingUuid": "79c4d5de73e33508b8413528a3d5fa26",
        "rootImageUuid": "6cb82e96abd3374bbdc8bc927a86cad6",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-f4324804b25236ffaf75f827300bd3cb/f4324804b25236ffaf75f827300bd3cb.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ]
  }
}
名字类型描述起始版本
successboolean 0.6
errorErrorCode错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error3.7.0
inventoryVmInstanceInventory详情参考inventory3.7.0

error

名字类型描述起始版本
codeString错误码号，错误的全局唯一标识，例如SYS.1000, HOST.10010.6
descriptionString错误的概要描述0.6
detailsString错误的详细信息0.6
elaborationString保留字段，默认为null0.6
opaqueLinkedHashMap保留字段，默认为null0.6
causeErrorCode根错误，引发当前错误的源错误，若无原错误，该字段为null0.6

inventory

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源0.6
nameString资源名称0.6
descriptionString资源的详细描述0.6
zoneUuidString数据中心UUID0.6
clusterUuidString集群UUID0.6
imageUuidString镜像UUID0.6
hostUuidString主机UUID0.6
lastHostUuidString 0.6
instanceOfferingUuidString计算规格UUID0.6
rootVolumeUuidString硬盘1UUID0.6
platformString 0.6
architectureString 0.6
defaultL3NetworkUuidString 0.6
typeString 0.6
hypervisorTypeString 0.6
memorySizeLong 0.6
cpuNumInteger 0.6
cpuSpeedLong 0.6
allocatorStrategyString 0.6
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
stateString 0.6
guestOsTypeString 4.1.2
vmNicsList详情参考vmNics0.6
allVolumesList详情参考allVolumes0.6
vmCdRomsList详情参考vmCdRoms0.6

vmNics

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.7.13
vmInstanceUuidString虚拟机UUID4.7.13
l3NetworkUuidString分布式端口组UUID4.7.13
ipString 4.7.13
macString 4.7.13
hypervisorTypeString 4.7.13
netmaskString 4.7.13
gatewayString 4.7.13
metaDataString 4.7.13
ipVersionInteger 4.7.13
driverTypeString 4.7.13
internalNameString 4.7.13
deviceIdInteger 4.7.13
typeString 4.7.13
stateString网卡状态4.7.13
createDateTimestamp创建时间4.7.13
lastOpDateTimestamp最后一次修改时间4.7.13
usedIpsList详情参考usedIps4.7.13

usedIps

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.10.0
ipRangeUuidStringIP段UUID4.10.0
l3NetworkUuidString分布式端口组UUID4.10.0
ipVersionInteger 4.10.0
ipString 4.10.0
netmaskString 4.10.0
gatewayString 4.10.0
usedForString 4.10.0
ipInLonglong 4.10.0
vmNicUuidString虚拟机网卡UUID4.10.0
createDateTimestamp创建时间4.10.0
lastOpDateTimestamp最后一次修改时间4.10.0

allVolumes

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.7.13
nameString资源名称4.7.13
descriptionString资源的详细描述4.7.13
primaryStorageUuidString数据存储UUID4.7.13
vmInstanceUuidString虚拟机UUID4.7.13
diskOfferingUuidString硬盘规格UUID4.7.13
rootImageUuidString 4.7.13
installPathString 4.7.13
typeString 4.7.13
formatString 4.7.13
sizeLong 4.7.13
actualSizeLong 4.7.13
deviceIdInteger 4.7.13
stateString 4.7.13
statusString 4.7.13
createDateTimestamp创建时间4.7.13
lastOpDateTimestamp最后一次修改时间4.7.13
isShareableBoolean 4.7.13
volumeQosString 4.7.13
lastDetachDateTimestamp 4.7.13
lastVmInstanceUuidString 4.7.13

vmCdRoms

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源4.7.13
vmInstanceUuidString虚拟机UUID4.7.13
deviceIdInteger 4.7.13
isoUuidString 4.7.13
isoInstallPathString 4.7.13
nameString资源名称4.7.13
descriptionString资源的详细描述4.7.13
createDateTimestamp创建时间4.7.13
lastOpDateTimestamp最后一次修改时间4.7.13

SDK示例

Java SDK

SetVmConsoleModeAction action = new SetVmConsoleModeAction();
action.uuid = "457f2f9aa0373d5486df01556bf995b2";
action.mode = "vnc";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetVmConsoleModeAction.Result res = action.call();

Python SDK

action = SetVmConsoleModeAction()
action.uuid = "457f2f9aa0373d5486df01556bf995b2"
action.mode = "vnc"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET查询容错虚拟机组

上一页

PUT设置虚拟机安全级别

下一页