查询IP地址池

GET/zstack/v1/l3-networks/address-pools

GET zstack/v1/l3-networks/address-pools/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/l3-networks/address-pools?q=uuid=a73cf6bc10a0390bb5e461d9f5e3fd6d

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/l3-networks/address-pools/f45cb0f9098336a39662b7553f42deb5

可查询字段

运行CLI命令行工具，输入QueryAddressPool并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "l3NetworkUuid": "81ce7828f3f63c0ea8a69dd9139bdaa0",
      "name": "Test-IPRange",
      "networkCidr": "192.168.10.0/24",
      "ipRangeType": "AddressPool"
    }
  ]
}

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

error

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

inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.9.0
l3NetworkUuid	String	分布式端口组UUID	3.9.0
name	String	资源名称	3.9.0
description	String	资源的详细描述	3.9.0
startIp	String	起始IP	3.9.0
endIp	String	结束IP	3.9.0
netmask	String	掩码	3.9.0
gateway	String	网关	3.9.0
networkCidr	String	网络CIDR	3.9.0
ipVersion	Integer	ip协议号	3.9.0
addressMode	String	IPv6地址分配模式	3.9.0
prefixLen	Integer	掩码长度	3.9.0
createDate	Timestamp	创建时间	3.9.0
lastOpDate	Timestamp	最后一次修改时间	3.9.0
ipRangeType	IpRangeType	详情参考ipRangeType	3.9.0

ipRangeType

名字	类型	描述	起始版本
Normal	IpRangeType	普通地址段	3.9.0
AddressPool	IpRangeType	地址池段	3.9.0

SDK示例

Java SDK

QueryAddressPoolAction action = new QueryAddressPoolAction();
action.conditions = asList("uuid=4cbab87c862032f1a161bebe7e1f55a1");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryAddressPoolAction.Result res = action.call();

Python SDK

QueryAddressPoolAction action = QueryAddressPoolAction()
action.conditions = ["uuid=455d45fad9893eba9565de38588c7416"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryAddressPoolAction.Result res = action.call()