获取部署网络IP地址可用量(GetBareMetal2ProvisionNetworkIpAddressCapacity)

API请求

URLs

GET zstack/v1/baremetal2/provision-networks/ip-capacity

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/baremetal2/provision-networks/ip-capacity?networkUuids=f9c4c95cf7f43f6eaf7af5e7b3715c60

参数列表

名字	类型	位置	描述	起始版本
networkUuids	List	query	裸金属部署网络UUID列表	4.0.0
systemTags (可选)	List	query	系统标签	4.0.0
userTags (可选)	List	query	用户标签	4.0.0

API返回

返回示例

{
  "capacityData": [
    {
      "networkUuid": "da4ac0c888fc34b399a343140780a627",
      "totalCapacity": 100.0,
      "availableCapacity": 50.0,
      "gatewayUsedIpNumber": 10.0,
      "instanceUsedIpNumber": 40.0
    }
  ]
}

名字	类型	描述	起始版本
success	boolean	获取成功	4.0.0
capacityData	List	详情参考capacityData	4.0.0
error	ErrorCode	详情参考error	4.0.0

#capacityData

名字	类型	描述	起始版本
networkUuid	String	裸金属部署网络UUID	4.0.0
totalCapacity	long	IP总量	4.0.0
availableCapacity	long	IP可用量	4.0.0
gatewayUsedIpNumber	long	裸金属网关节点占用IP数量	4.0.0
instanceUsedIpNumber	long	裸金属实例占用IP数量	4.0.0

#error

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

SDK示例

Java SDK

GetBareMetal2ProvisionNetworkIpAddressCapacityAction action = new GetBareMetal2ProvisionNetworkIpAddressCapacityAction();
action.networkUuids = asList("f9c4c95cf7f43f6eaf7af5e7b3715c60");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetBareMetal2ProvisionNetworkIpAddressCapacityAction.Result res = action.call();

Python SDK

GetBareMetal2ProvisionNetworkIpAddressCapacityAction action = GetBareMetal2ProvisionNetworkIpAddressCapacityAction()
action.networkUuids = [f9c4c95cf7f43f6eaf7af5e7b3715c60]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetBareMetal2ProvisionNetworkIpAddressCapacityAction.Result res = action.call()

上一篇将部署网络从弹性裸金属集群卸载(DetachBareMetal2ProvisionNetworkFromCluster)下一篇VMware管理(Plus)