获取IP网络地址容量

GET/zstack/v1/ip-capacity

Headers

Authorization: OAuth the-session-uuid s

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/ip-capacity?ipRangeUuids=6bf57331ebe433389c6c230153ac5d8d&all=false

参数列表

名字	类型	位置	描述	起始版本
zoneUuids (可选)	List	query	数据中心UUID	0.6
l3NetworkUuids (可选)	List	query	分布式端口组UUID	0.6
ipRangeUuids (可选)	List	query	IP地址范围UUID	0.6
all (可选)	boolean	query	系统全局	0.6
systemTags (可选)	List	query	系统标签	0.6
userTags (可选)	List	query	用户标签	0.6

API返回

返回示例

{
  "totalCapacity": 20.0,
  "availableCapacity": 15.0,
  "usedIpAddressNumber": 5.0,
  "ipv4TotalCapacity": 0.0,
  "ipv4AvailableCapacity": 0.0,
  "ipv4UsedIpAddressNumber": 0.0,
  "ipv6TotalCapacity": 0.0,
  "ipv6AvailableCapacity": 0.0,
  "ipv6UsedIpAddressNumber": 0.0,
  "capacityData": [
    {
      "resourceUuid": "68b9a1c74c4c33c7b818e4c14bdea0a7",
      "totalCapacity": 20.0,
      "availableCapacity": 15.0,
      "usedIpAddressNumber": 5.0,
      "ipv4TotalCapacity": 0.0,
      "ipv4AvailableCapacity": 0.0,
      "ipv4UsedIpAddressNumber": 0.0,
      "ipv6TotalCapacity": 0.0,
      "ipv6AvailableCapacity": 0.0,
      "ipv6UsedIpAddressNumber": 0.0
    }
  ],
  "resourceType": "L3NetworkVO"
}

名字	类型	描述	起始版本
totalCapacity	long	IP地址容量	0.6
availableCapacity	long	可用IP地址容量	0.6
usedIpAddressNumber	long	已使用IP数量	3.10.0
ipv4TotalCapacity	long	IPv4地址容量	3.10.0
ipv4AvailableCapacity	long	可用IPv4地址容量	3.10.0
ipv4UsedIpAddressNumber	long	已使用IPv4数量	3.10.0
ipv6TotalCapacity	long	IPv6地址容量	3.10.0
ipv6AvailableCapacity	long	可用IPv6地址容量	3.10.0
ipv6UsedIpAddressNumber	long	已使用IPv6数量	3.10.0
resourceType	String	所查询资源的类型（地址范围、分布式端口组、数据中心）	3.9.0
success	boolean	成功	0.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
capacityData	List	详情参考capacityData	3.9.0
error	ErrorCode	详情参考error	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

capacityData

名字	类型	描述	起始版本
resourceUuid	String	资源UUID	3.9.0
totalCapacity	long	IP地址总容量	3.9.0
availableCapacity	long	可用IP地址容量	3.9.0
usedIpAddressNumber	long	已用IP地址容量	3.9.0
ipv4TotalCapacity	long	IPv4地址总容量	3.10.0
ipv4AvailableCapacity	long	可用IPv4地址容量	3.10.0
ipv4UsedIpAddressNumber	long	已用IPv4地址容量	3.10.0
ipv6TotalCapacity	long	IPv6地址总容量	3.10.0
ipv6AvailableCapacity	long	可用IPv6地址容量	3.10.0
ipv6UsedIpAddressNumber	long	已用IPv6地址容量	3.10.0

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

SDK示例

Java SDK

GetIpAddressCapacityAction action = new GetIpAddressCapacityAction();
action.ipRangeUuids = asList("6bf57331ebe433389c6c230153ac5d8d");
action.all = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetIpAddressCapacityAction.Result res = action.call();

Python SDK

GetIpAddressCapacityAction action = GetIpAddressCapacityAction()
action.ipRangeUuids = [6bf57331ebe433389c6c230153ac5d8d]
action.all = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetIpAddressCapacityAction.Result res = action.call()