GetCandidateL3NetworksForLoadBalancer

API Request

URLs

GET zstack/v1/load-balancers/listeners/{listenerUuid}/networks/candidates

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/load-balancers/listeners/6ecc19bdec0139499e3abf6c51bca683/networks/candidates?limit=1000.0&start=0.0

Request Parameters

Name	Type	Location	Description	Starting Version
listenerUuid	String	url	The listener UUID.	3.9.0
limit	Integer	query	Optional.	3.9.0
start	Integer	query	Optional.	3.9.0
systemTags	List	query	Optional. The system tags.	3.9.0
userTags	List	query	Optional. The user tags.	3.9.0

API Response

Sample Response

{
  "inventories": [
    {
      "name": "Test-L3Network",
      "l2NetworkUuid": "7631f86a65af335fb1496afe8e7ac9ee"
    }
  ]
}

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	3.9.0
inventories	List	See inventories.	3.9.0

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	3.9.0
description	String	The brief description of the error.	3.9.0
details	String	The details about the error.	3.9.0
elaboration	String	The reserved field. Default value: null.	3.9.0
opaque	LinkedHashMap	The reserved field. Default value: null.	3.9.0
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	3.9.0

#inventories

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	3.9.0
name	String	The resource name.	3.9.0
description	String	The detailed description of the resource.	3.9.0
type	String	The resource type.	3.9.0
zoneUuid	String	The zone UUID.	3.9.0
l2NetworkUuid	String	The L2 network UUID.	3.9.0
state	String	The resource state.	3.9.0
dnsDomain	String	The DNS domain.	3.9.0
system	Boolean	The system.	3.9.0
category	String	The category.	3.9.0
ipVersion	Integer	The IP version.	3.9.0
createDate	Timestamp	The creation date.	3.9.0
lastOpDate	Timestamp	The last operation date.	3.9.0
dns	List	The DNS server address.	3.9.0
ipRanges	List	See ipRanges.	3.9.0
networkServices	List	See networkServices.	3.9.0
hostRoute	List	See hostRoute.	3.9.0

#ipRanges

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	3.9.0
l3NetworkUuid	String	The L3 network UUID.	3.9.0
name	String	The resource name.	3.9.0
description	String	The detailed description of the resource.	3.9.0
startIp	String	The start IP.	3.9.0
endIp	String	The end IP.	3.9.0
netmask	String	The netmask.	3.9.0
gateway	String	The gateway IP address.	3.9.0
networkCidr	String	The network cidr.	3.9.0
ipVersion	Integer	The IP version.	3.9.0
addressMode	String	The address mode.	3.9.0
prefixLen	Integer	The prefix len.	3.9.0
createDate	Timestamp	The creation date.	3.9.0
lastOpDate	Timestamp	The last operation date.	3.9.0

#networkServices

Name	Type	Description	Starting Version
l3NetworkUuid	String	The L3 network UUID.	3.9.0
networkServiceProviderUuid	String	The UUID of the network service provider.	3.9.0
networkServiceType	String	The network service type.	3.9.0

#hostRoute

Name	Type	Description	Starting Version
id	Long	The resource ID.	3.9.0
l3NetworkUuid	String	The L3 network UUID.	3.9.0
prefix	String	The prefix.	3.9.0
nexthop	String	The next hop.	3.9.0
createDate	Timestamp	The creation date.	3.9.0
lastOpDate	Timestamp	The last operation date.	3.9.0

SDK Sample

Java SDK

GetCandidateL3NetworksForLoadBalancerAction action = new GetCandidateL3NetworksForLoadBalancerAction();
action.listenerUuid = "6ecc19bdec0139499e3abf6c51bca683";
action.limit = 1000.0;
action.start = 0.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetCandidateL3NetworksForLoadBalancerAction.Result res = action.call();

Python SDK

action = GetCandidateL3NetworksForLoadBalancerAction()
action.listenerUuid = "6ecc19bdec0139499e3abf6c51bca683"
action.limit = 1000.0
action.start = 0.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

PreviousRemoveAccessControlListFromLoadBalancer NextCreateLoadBalancerServerGroup