更新云主机信息(UpdateVmInstance)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

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

Note: 上述示例中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
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": 8.589934592E9,
    "cpuNum": 1.0,
    "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.0,
        "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": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-761df8e1eef933ee8d7f3b7f8551b754/761df8e1eef933ee8d7f3b7f8551b754.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 1.073741824E11,
        "actualSize": 2.147483648E10,
        "deviceId": 0.0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	VmInstanceInventory	详情参考inventory	0.6

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
name	String	资源名称	0.6
description	String	资源的详细描述	0.6
zoneUuid	String	区域UUID	0.6
clusterUuid	String	集群UUID	0.6
imageUuid	String	镜像UUID	0.6
hostUuid	String	物理机UUID	0.6
lastHostUuid	String		0.6
instanceOfferingUuid	String	计算规格UUID	0.6
rootVolumeUuid	String	根云盘UUID	0.6
platform	String		0.6
defaultL3NetworkUuid	String		0.6
type	String		0.6
hypervisorType	String		0.6
memorySize	Long		0.6
cpuNum	Integer		0.6
cpuSpeed	Long		0.6
allocatorStrategy	String		0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
state	String		0.6
vmNics	List	详情参考vmNics	0.6
allVolumes	List	详情参考allVolumes	0.6

#vmNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
vmInstanceUuid	String	云主机UUID	0.6
l3NetworkUuid	String	三层网络UUID	0.6
ip	String	IP地址	4.1.0
mac	String	MAC地址	4.1.0
hypervisorType	String	虚拟化类型	4.1.0
netmask	String	子网掩码	4.1.0
gateway	String	网关	4.1.0
metaData	String		0.6
ipVersion	Integer	IP地址版本	3.1.0
deviceId	Integer	设备ID	0.6
type	String	网卡类型	4.1.0
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
usedIps	List	详情参考usedIps	0.6

#usedIps

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
ipRangeUuid	String	IP段UUID	0.6
l3NetworkUuid	String	三层网络UUID	0.6
ipVersion	Integer	IP协议号	3.1.0
ip	String	IP地址	0.6
netmask	String	网络掩码	0.6
gateway	String	网关地址	0.6
usedFor	String		0.6
ipInLong	long		0.6
vmNicUuid	String	云主机网卡UUID	3.1.0
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

#allVolumes

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
name	String	资源名称	0.6
description	String	资源的详细描述	0.6
primaryStorageUuid	String	主存储UUID	0.6
vmInstanceUuid	String	云主机UUID	0.6
diskOfferingUuid	String	云盘规格UUID	0.6
rootImageUuid	String	云盘根镜像UUID	4.1.0
installPath	String	云盘在主存储上的路径	4.1.0
type	String	云盘类型，数据云盘/根云盘	4.1.0
format	String	云盘格式	4.1.0
size	Long	云盘大小	4.1.0
actualSize	Long	云盘真实大小	4.1.0
deviceId	Integer		0.6
state	String	云盘是否开启	4.1.0
status	String	云盘状态	4.1.0
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
isShareable	Boolean		0.6

SDK示例

Java SDK

UpdateVmInstanceAction action = new UpdateVmInstanceAction();
action.uuid = "c424899cef6f4723baf0aae3acbe6020";
action.name = "new vm name";
action.sessionId = "4320eeda74fa41788522c75ed42ec889";
UpdateVmInstanceAction.Result res = action.call();

Python SDK

UpdateVmInstanceAction action = UpdateVmInstanceAction()
action.uuid = "fb287c6cb9134d208d1ed054577ad249"
action.name = "new vm name"
action.sessionId = "2f01595d029449dbbf6c052ad1914271"
UpdateVmInstanceAction.Result res = action.call()

上一篇获取云主机能力(GetVmCapabilities)下一篇克隆云主机(CloneVmInstance)