QueryLoadBalancerListener

API Request

URLs

GET zstack/v1/load-balancers/listeners
GET zstack/v1/load-balancers/listeners/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 6d7ca1c2f39440d5a4110962854c3234" \
-X GET http://localhost:8080/zstack/v1/load-balancers/listeners

curl \
-H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 057112ec0d5e4bcd9193b1f9499169eb" \
-X GET http://localhost:8080/zstack/v1/load-balancers/listeners/cdf776df1cb04ae6a3cf1fb1330dab2d

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryLoadBalancerListener, and pressing the Tab key.

API Response

Sample Response

{
"inventories": [
    {
"uuid": "be2f6e299e364f5cb71e52f11eeee34e",
"name": "Test-Listener",
"loadBalancerUuid": "90a89f6ec62b4acf9ccb770b453fddc5",
"instancePort": 80.0,
"loadBalancerPort": 80.0,
"protocol": "http"
    }
  ]
}

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

#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.	0.6
description	String	The brief description of the error.	0.6
details	String	The details about the error.	0.6
elaboration	String	The reserved field. Default value: null.	0.6
opaque	LinkedHashMap	The reserved field. Default value: null.	0.6
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	0.6

#inventories

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
loadBalancerUuid	String	The load balancer UUID.	0.6
instancePort	Integer	The instance port.	0.6
loadBalancerPort	Integer	The load balancer port.	0.6
protocol	String	The protocol.	0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
vmNicRefs	List	See vmNicRefs.	0.6
certificateRefs	List	See certificateRefs.	0.6

#vmNicRefs

Name	Type	Description	Starting Version
id	Long	The resource ID.	0.6
listenerUuid	String	The listener UUID.	0.6
vmNicUuid	String	The VM NIC UUID.	0.6
status	String	The resource status.	0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6

#certificateRefs

Name	Type	Description	Starting Version
id	Long	The resource ID.	2.3
listenerUuid	String	The listener UUID.	2.3
certificateUuid	String	The certificate UUID.	2.3
createDate	Timestamp	The creation date.	2.3
lastOpDate	Timestamp	The last operation date.	2.3

SDK Sample

Java SDK

QueryLoadBalancerListenerAction action = new QueryLoadBalancerListenerAction();
action.conditions = asList();
action.sessionId = "c616bc4ee56648b6a921b2da70fe7798";
QueryLoadBalancerListenerAction.Result res = action.call();

Python SDK

action = QueryLoadBalancerListenerAction()
action.conditions = []
action.sessionId = "529b237f77cd4130b861ebe99a30c983"
res = action.call()

PreviousDeleteLoadBalancerListener NextUpdateLoadBalancerListener