加载网络到网卡

POST/zstack/v1/nics/{vmNicUuid}/l3-networks/{l3NetworkUuid}

Request

cURL

curl --request POST \
  --url '/v1/nics/{vmNicUuid}/l3-networks/{l3NetworkUuid}' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/nics/{vmNicUuid}/l3-networks/{l3NetworkUuid}"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {},
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' \
http://localhost:8080/zstack/v1/nics/573a061841c833f098482a47474a4514/l3-networks/8ad81f74fbf539d98c542fa94ecfa7d9

参数列表

名字	类型	位置	描述	起始版本
vmNicUuid	String	url	虚拟机网卡UUID	3.1.0
l3NetworkUuid	String	url	分布式端口组UUID	3.1.0
staticIp (可选)	String	body(包含在params结构中)	指定分配给虚拟机的IP地址	3.1.0
systemTags (可选)	List	body		3.1.0
userTags (可选)	List	body		3.1.0

API返回

返回示例

{
  "inventory": {
    "uuid": "243f7b018d8931c0a3098c61a982c4cb",
    "vmInstanceUuid": "1d109154036639d990acd002eda6b353",
    "usedIpUuid": "dc7bd6facfce3d4fa3e713374f574be0",
    "l3NetworkUuid": "a4fd5f8fb7e33b3c92ac0d4c6d96c800",
    "ip": "192.168.1.10",
    "mac": "00:0c:29:bd:99:fc",
    "netmask": "255.255.255.0",
    "gateway": "192.168.1.1",
    "deviceId": 0,
    "state": "enable"
  }
}

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

error

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

inventory

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

usedIps

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

SDK示例

Java SDK

AttachL3NetworkToVmNicAction action = new AttachL3NetworkToVmNicAction();
action.vmNicUuid = "573a061841c833f098482a47474a4514";
action.l3NetworkUuid = "8ad81f74fbf539d98c542fa94ecfa7d9";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachL3NetworkToVmNicAction.Result res = action.call();

Python SDK

action = AttachL3NetworkToVmNicAction()
action.vmNicUuid = "573a061841c833f098482a47474a4514"
action.l3NetworkUuid = "8ad81f74fbf539d98c542fa94ecfa7d9"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()