虚拟机相关接口

更新虚拟机信息

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateVmInstance": {
    "name": "new vm name"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8"\
 -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateVmInstance":{"name":"new vm name"}}' \
http://localhost:8080/zstack/v1/vm-instances/dfa2feae60f431ac8d5f071f5594cfc1/actions

参数列表

名字

类型

位置

描述

可选值

起始版本

uuid

String

url

虚拟机UUID

 

0.6

name (可选)

String

body(包含在updateVmInstance结构中)

虚拟机名

 

0.6

description (可选)

String

body(包含在updateVmInstance结构中)

虚拟机详细描述

 

0.6

state (可选)

String

body(包含在updateVmInstance结构中)

虚拟机状态- 通常不应该直接更新虚拟机状态，否则会导致虚拟化平台对虚拟机状态发生误判。

  • 该字段只应用于虚拟机真实状态和虚拟化平台记录状态发生不一致，而虚拟化平台同步机制已失效时（通常意味着bug）。
  • 管理员应完全理解使用该字段的后果。
  • Stopped
  • Running

0.6

defaultL3NetworkUuid (可选)

String

body(包含在updateVmInstance结构中)

默认分布式端口组UUID

 

0.6

platform (可选)

String

body(包含在updateVmInstance结构中)

虚拟机平台类型

  • Linux
  • Windows
  • WindowsVirtio
  • Other
  • Paravirtualization

0.6

cpuNum (可选)

Integer

body(包含在updateVmInstance结构中)

  • 虚拟机CPU数量。需停止/启动虚拟机后生效
  • 当系统参数NUMA为true情况下创建的虚拟机，支持动态调整

 

0.6

memorySize (可选)

Long

body(包含在updateVmInstance结构中)

  • 虚拟机内存大小。需停止/启动虚拟机后生效
  • 系统参数NUMA为true情况下创建的虚拟机，支持动态调整。

 

0.6

guestOsType (可选)

String

body(包含在updateVmInstance结构中)

 

 

4.1.0

reservedMemorySize (可选)

Long

body(包含在updateVmInstance结构中)

 

 

4.7.21

systemTags (可选)

List

body

系统标签

 

0.6

userTags (可选)

List

body

用户标签

 

0.6

API返回

返回示例

{
  "inventory": {
    "uuid": "6710cdffb0653455809b6511a6b3aaa4",
    "name": "new vm name",
    "description": "web server VM",
    "zoneUuid": "aa63c5a3b3c436fa94e5e851f057fe23",
    "clusterUuid": "48b424d94ed239f1b18e1ce37db24cf8",
    "imageUuid": "4e1ac550da8d30c7b07162acc39773c1",
    "hostUuid": "1f3ffea4673e3e4197681ee030d1794b",
    "lastHostUuid": "d334dadb7cfc34da8f6f7d74dfd04692",
    "instanceOfferingUuid": "33b38aff5cbe3e24a9266300f7163d20",
    "rootVolumeUuid": "761df8e1eef933ee8d7f3b7f8551b754",
    "platform": "Linux",
    "defaultL3NetworkUuid": "3a3c91f4a28a31beb410d6d1c3dc862c",
    "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": "ae19167e24713aeea9c45e6f2d27249d",
        "vmInstanceUuid": "6710cdffb0653455809b6511a6b3aaa4",
        "usedIpUuid": "010f4817011b32d3b476faa3f393d765",
        "l3NetworkUuid": "3a3c91f4a28a31beb410d6d1c3dc862c",
        "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": "761df8e1eef933ee8d7f3b7f8551b754",
        "name": "Root-Volume-For-VM-6710cdffb0653455809b6511a6b3aaa4",
        "primaryStorageUuid": "da81ed018a9738ff97a16d7b7a43327d",
        "vmInstanceUuid": "6710cdffb0653455809b6511a6b3aaa4",
        "diskOfferingUuid": "bd9b406d36c13fc7ad3f995535415898",
        "rootImageUuid": "4e1ac550da8d30c7b07162acc39773c1",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-761df8e1eef933ee8d7f3b7f8551b754/761df8e1eef933ee8d7f3b7f8551b754.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"
      }
    ]
  }
}
名字类型描述起始版本
successboolean 0.6
errorErrorCode错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error0.6
inventoryVmInstanceInventory详情参考inventory0.6

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根硬盘UUID0.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，唯一标示该资源0.6
vmInstanceUuidString虚拟机UUID0.6
l3NetworkUuidString分布式端口组UUID0.6
ipStringIP地址4.1.0
macStringMAC地址4.1.0
hypervisorTypeString虚拟化类型4.1.0
netmaskString子网掩码4.1.0
gatewayString网关4.1.0
metaDataString 0.6
ipVersionIntegerIP地址版本3.1.0
driverTypeString 4.7.13
internalNameString 4.7.13
deviceIdInteger设备ID0.6
typeString网卡类型4.1.0
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
usedIpsList详情参考usedIps0.6

usedIps

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源0.6
ipRangeUuidStringIP段UUID0.6
l3NetworkUuidString分布式端口组UUID0.6
ipVersionIntegerIP协议号3.1.0
ipStringIP地址0.6
netmaskString网络掩码0.6
gatewayString网关地址0.6
usedForString 0.6
ipInLonglong 0.6
vmNicUuidString虚拟机网卡UUID3.1.0
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6

allVolumes

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源0.6
nameString资源名称0.6
descriptionString资源的详细描述0.6
primaryStorageUuidString数据存储UUID0.6
vmInstanceUuidString虚拟机UUID0.6
diskOfferingUuidString硬盘规格UUID0.6
rootImageUuidString硬盘根镜像UUID4.1.0
installPathString硬盘在数据存储上的路径4.1.0
typeString硬盘类型，数据硬盘/根硬盘4.1.0
formatString硬盘格式4.1.0
sizeLong硬盘大小4.1.0
actualSizeLong硬盘真实大小4.1.0
deviceIdInteger 0.6
stateString硬盘是否开启4.1.0
statusString硬盘状态4.1.0
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
isShareableBoolean 0.6
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

UpdateVmInstanceAction action = new UpdateVmInstanceAction();
action.uuid = "dfa2feae60f431ac8d5f071f5594cfc1";
action.name = "new vm name";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateVmInstanceAction.Result res = action.call();

Python SDK

action = UpdateVmInstanceAction()
action.uuid = "dfa2feae60f431ac8d5f071f5594cfc1"
action.name = "new vm name"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET获取虚拟机能力

上一页

PUT克隆虚拟机

下一页