通过网络CIDR添加IP地址范围

POST/zstack/v1/l3-networks/{l3NetworkUuid}/ip-ranges/by-cidr

Request

cURL

curl --request POST \
  --url '/v1/l3-networks/{l3NetworkUuid}/ip-ranges/by-cidr' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/l3-networks/{l3NetworkUuid}/ip-ranges/by-cidr"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "Test-IPRange",
    "networkCidr": "192.168.10.0/24",
    "ipRangeType": "Normal"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"Test-IPRange","networkCidr":"192.168.10.0/24","ipRangeType":"Normal"}}' http://localhost:8080/zstack/v1/l3-networks/c186887bc5e43da7ba42bd5d66eba0cd/ip-ranges/by-cidr

参数列表

名字	类型	位置	描述	可选值	起始版本
name	String	body(包含在params结构中)	分布式端口组的名称		0.6
description (可选)	String	body(包含在params结构中)	分布式端口组的详细描述		0.6
l3NetworkUuid	String	url	分布式端口组UUID		0.6
networkCidr	String	body(包含在params结构中)	网络CIDR		0.6
gateway (可选)	String	body(包含在params结构中)	网关		3.7.0
ipRangeType (可选)	String	body(包含在params结构中)	地址类型	Normal AddressPool	3.9.0
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID。若指定，分布式端口组会使用该字段值作为UUID		0.6
systemTags (可选)	List	body	系统标签		0.6
userTags (可选)	List	body	用户标签		0.6

ZSvirt通过网络CIDR添加IP地址范围时支持添加IP地址段的时候指定DHCP server地址功能，SystemTags增加affinityGroup选项。
- 选项格式为：flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
- 例如：flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

API返回

返回示例

{
  "inventory": {
    "l3NetworkUuid": "4e0926c4fa27455f88c7d94420bf3422",
    "name": "Test-IPRange",
    "networkCidr": "192.168.10.0/24"
  }
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	IpRangeInventory	详情参考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
l3NetworkUuid	String	分布式端口组UUID	0.6
name	String	资源名称	0.6
description	String	资源的详细描述	0.6
startIp	String		0.6
endIp	String		0.6
netmask	String		0.6
prefixLen	String	掩码长度	3.1.0
gateway	String		0.6
networkCidr	String		0.6
ipVersion	Integer	ip协议号	3.1.0
addressMode	String	IPv6地址分配模式	3.1.0
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
ipRangeType	IpRangeType	详情参考ipRangeType	3.9.0

ipRangeType

名字	类型	描述	起始版本
Normal	IpRangeType		3.9.0
AddressPool	IpRangeType		3.9.0

SDK示例

Java SDK

AddIpRangeByNetworkCidrAction action = new AddIpRangeByNetworkCidrAction();
action.name = "Test-IPRange";
action.l3NetworkUuid = "c186887bc5e43da7ba42bd5d66eba0cd";
action.networkCidr = "192.168.10.0/24";
action.ipRangeType = "Normal";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddIpRangeByNetworkCidrAction.Result res = action.call();

Python SDK

AddIpRangeByNetworkCidrAction action = AddIpRangeByNetworkCidrAction()
action.name = "Test-IPRange"
action.l3NetworkUuid = "c186887bc5e43da7ba42bd5d66eba0cd"
action.networkCidr = "192.168.10.0/24"
action.ipRangeType = "Normal"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddIpRangeByNetworkCidrAction.Result res = action.call()