批量创建Kernel适配器

POST/zstack/v1/l3-networks/{l3NetworkUuid}/kernel-interfaces

Request

cURL

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

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "structs": [
      {
        "name": "host-kernel-interface-1",
        "description": "example",
        "hostUuid": "ff0192fa70113da886101145c084bd00",
        "ip": "192.168.0.1",
        "netmask": "255.255.255.0"
      },
      {
        "name": "host-kernel-interface-2",
        "description": "example",
        "hostUuid": "ff0956f0005a313e8e1178392c01cd00",
        "ip": "192.168.0.2",
        "netmask": "255.255.255.0"
      }
    ],
    "trafficTypes": [
      "Management"
    ]
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"structs":[{"name":"host-kernel-interface-1","description":"example","hostUuid":"ff0192fa70113da886101145c084bd00","ip":"192.168.0.1","netmask":"255.255.255.0"},{"name":"host-kernel-interface-2","description":"example","hostUuid":"ff0956f0005a313e8e1178392c01cd00","ip":"192.168.0.2","netmask":"255.255.255.0"}],"trafficTypes":["Management"]}}' \
http://localhost:8080/zstack/v1/l3-networks/ff07d561c51c3ef996d682825dcff700/kernel-interfaces

参数列表

名字	类型	位置	描述	可选值	起始版本
structs	List	body(包含在`params`结构中)	Kernel适配器结构体列表		4.10.20
l3NetworkUuid	String	url	分布式端口组UUID		4.10.20
trafficTypes (可选)	List	body(包含在`params`结构中)	流量类型	Management Storage	4.10.20
systemTags (可选)	List	body	系统标签		4.10.20
userTags (可选)	List	body	用户标签		4.10.20

API返回

返回示例

{
  "results": [
    {
      "inventory": {
        "uuid": "ff054502e59933a8a494cea5dc88d700",
        "name": "host-kernel-interface",
        "description": "example",
        "hostUuid": "ff0192fa70113da886101145c084bd00",
        "l2NetworkUuid": "ff0915ef0d3e32708d3150708a72c400",
        "l3NetworkUuid": "ff07d561c51c3ef996d682825dcff700",
        "usedIps": [
          {
            "hostKernelInterfaceUuid": "ff054502e59933a8a494cea5dc88d700",
            "uuid": "ff0d1627c13c3337a92767d011d03a00",
            "l3NetworkUuid": "ff07d561c51c3ef996d682825dcff700",
            "ipVersion": 4,
            "ip": "192.168.0.2",
            "netmask": "255.255.255.0",
            "ipInLong": 3232235522,
            "ipInBinary": [
              -64,
              -88,
              0,
              2
            ],
            "createDate": "Nov 14, 2017 2:20:57 PM",
            "lastOpDate": "Nov 14, 2017 2:20:57 PM"
          }
        ],
        "trafficTypes": [
          "Management"
        ],
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    }
  ]
}

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

results

名字	类型	描述	起始版本
error	ErrorCode	详情参考error	4.10.20
inventory	HostKernelInterfaceInventory	详情参考inventory	4.10.20

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，唯一标示该资源	4.1.0
name	String	资源名称	4.1.0
description	String	资源的详细描述	4.1.0
hostUuid	String	主机UUID	4.1.0
l2NetworkUuid	String	分布式交换机UUID	4.1.0
l3NetworkUuid	String	分布式端口组UUID	4.1.0
trafficTypes	List	流量类型	4.1.0
createDate	Timestamp	创建时间	4.1.0
lastOpDate	Timestamp	最后一次修改时间	4.1.0
usedIps	List	详情参考usedIps	4.1.0

usedIps

名字	类型	描述	起始版本
hostKernelInterfaceUuid	String	Kernel适配器的UUID	4.1.0
uuid	String	资源的UUID，唯一标示该资源	4.1.0
ipRangeUuid	String	IP段UUID	4.1.0
l3NetworkUuid	String	分布式端口组UUID	4.1.0
ipVersion	Integer	IP协议号	4.1.0
ip	String	IP地址	4.1.0
netmask	String	子网掩码	4.1.0
gateway	String	网关地址	4.1.0
usedFor	String	分配原因	4.1.0
ipInLong	Long	Long存储的IP地址，仅ipv4有效	4.1.0
vmNicUuid	String	虚拟机网卡UUID	4.1.0
createDate	Timestamp	创建时间	4.1.0
lastOpDate	Timestamp	最后一次修改时间	4.1.0

error

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

SDK示例

Java SDK

BatchCreateHostKernelInterfaceAction action = new BatchCreateHostKernelInterfaceAction();
action.structs = asList([name:host-kernel-interface-1, description:example, hostUuid:ff0192fa70113da886101145c084bd00, ip:192.168.0.1, netmask:255.255.255.0],[name:host-kernel-interface-2, description:example, hostUuid:ff0956f0005a313e8e1178392c01cd00, ip:192.168.0.2, netmask:255.255.255.0]);
action.l3NetworkUuid = "ff07d561c51c3ef996d682825dcff700";
action.trafficTypes = asList("Management");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
BatchCreateHostKernelInterfaceAction.Result res = action.call();

Python SDK

action = BatchCreateHostKernelInterfaceAction()
action.structs = [[name:host-kernel-interface-1, description:example, hostUuid:ff0192fa70113da886101145c084bd00, ip:192.168.0.1, netmask:255.255.255.0], [name:host-kernel-interface-2, description:example, hostUuid:ff0956f0005a313e8e1178392c01cd00, ip:192.168.0.2, netmask:255.255.255.0]]
action.l3NetworkUuid = "ff07d561c51c3ef996d682825dcff700"
action.trafficTypes = [Management]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()