修改虚拟机网卡状态

PUT/zstack/v1/vm-instances/nics/{vmNicUuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/vm-instances/nics/{vmNicUuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/vm-instances/nics/{vmNicUuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "changeVmNicState": {
    "state": "disable"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeVmNicState":{"state":"disable"}}' \
http://localhost:8080/zstack/v1/vm-instances/nics/17d47a3b35813bb5a90f9643200a0f40/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
vmNicUuid	String	url	虚拟机网卡UUID		4.6.0
state	String	body(包含在`changeVmNicState`结构中)	虚拟机网卡状态	enable disable	4.6.0
systemTags (可选)	List	body	系统标签		4.6.0
userTags (可选)	List	body	用户标签		4.6.0

API返回

返回示例

{
  "inventory": {
    "uuid": "11d9330dd53b3140a933afff53484a4c",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "9959e99dec6032a1b6ddc7557f33db64",
    "clusterUuid": "d1675e2a3a07326989def39ea008fc1d",
    "imageUuid": "2392ef4f86e63aaaa2b5614f6795e262",
    "hostUuid": "b1e0e26f93503ff1a36d1e52d722b9ab",
    "lastHostUuid": "799326ef34543e4d988893b236c846ce",
    "instanceOfferingUuid": "7acf02facef6324b8f5b945d920afd75",
    "rootVolumeUuid": "561bc94863f43272afb18628ff29e137",
    "platform": "Linux",
    "defaultL3NetworkUuid": "f011105734bb39189bb8105fdc081d58",
    "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": "836ece7a894337b782404822f6c200bd",
        "vmInstanceUuid": "11d9330dd53b3140a933afff53484a4c",
        "usedIpUuid": "52876b0aca4936719b11959c2e53d9dc",
        "l3NetworkUuid": "f011105734bb39189bb8105fdc081d58",
        "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": "disable",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "561bc94863f43272afb18628ff29e137",
        "name": "Root-Volume-For-VM-11d9330dd53b3140a933afff53484a4c",
        "primaryStorageUuid": "75cfe252d83c3b498f8a6b00d7f03eb6",
        "vmInstanceUuid": "11d9330dd53b3140a933afff53484a4c",
        "diskOfferingUuid": "798091e2b84f30da8652329933d3bada",
        "rootImageUuid": "2392ef4f86e63aaaa2b5614f6795e262",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-561bc94863f43272afb18628ff29e137/561bc94863f43272afb18628ff29e137.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"
      }
    ]
  }
}

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

error

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

inventory

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

vmNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.6.0
vmInstanceUuid	String	虚拟机UUID	4.6.0
l3NetworkUuid	String	分布式端口组UUID	4.6.0
ip	String		4.6.0
mac	String		4.6.0
hypervisorType	String		4.6.0
netmask	String		4.6.0
gateway	String		4.6.0
metaData	String		4.6.0
ipVersion	Integer		4.6.0
driverType	String		4.6.0
internalName	String		4.6.0
deviceId	Integer		4.6.0
type	String		4.6.0
state	String	网卡状态	4.6.0
createDate	Timestamp	创建时间	4.6.0
lastOpDate	Timestamp	最后一次修改时间	4.6.0
usedIps	List	详情参考usedIps	4.6.0

usedIps

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.6.0
ipRangeUuid	String	IP段UUID	4.6.0
l3NetworkUuid	String	分布式端口组UUID	4.6.0
ipVersion	Integer		4.6.0
ip	String		4.6.0
netmask	String		4.6.0
gateway	String		4.6.0
usedFor	String		4.6.0
ipInLong	long		4.6.0
vmNicUuid	String	虚拟机网卡UUID	4.6.0
createDate	Timestamp	创建时间	4.6.0
lastOpDate	Timestamp	最后一次修改时间	4.6.0

allVolumes

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.6.0
name	String	资源名称	4.6.0
description	String	资源的详细描述	4.6.0
primaryStorageUuid	String	数据存储UUID	4.6.0
vmInstanceUuid	String	虚拟机UUID	4.6.0
diskOfferingUuid	String	硬盘规格UUID	4.6.0
rootImageUuid	String		4.6.0
installPath	String		4.6.0
type	String		4.6.0
format	String		4.6.0
size	Long		4.6.0
actualSize	Long		4.6.0
deviceId	Integer		4.6.0
state	String		4.6.0
status	String		4.6.0
createDate	Timestamp	创建时间	4.6.0
lastOpDate	Timestamp	最后一次修改时间	4.6.0
isShareable	Boolean		4.6.0
volumeQos	String		4.6.0
lastDetachDate	Timestamp		4.6.0
lastVmInstanceUuid	String		4.6.0

vmCdRoms

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.6.0
vmInstanceUuid	String	虚拟机UUID	4.6.0
deviceId	Integer		4.6.0
isoUuid	String		4.6.0
isoInstallPath	String		4.6.0
name	String	资源名称	4.6.0
description	String	资源的详细描述	4.6.0
createDate	Timestamp	创建时间	4.6.0
lastOpDate	Timestamp	最后一次修改时间	4.6.0

SDK示例

Java SDK

ChangeVmNicStateAction action = new ChangeVmNicStateAction();
action.vmNicUuid = "17d47a3b35813bb5a90f9643200a0f40";
action.state = "disable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeVmNicStateAction.Result res = action.call();

Python SDK

action = ChangeVmNicStateAction()
action.vmNicUuid = "17d47a3b35813bb5a90f9643200a0f40"
action.state = "disable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()