API Reference | 5.5.38 | ZStack Cloud · ZCF

API Request

URLs

GET zstack/v1/load-balancers/listeners/{listenerUuid}/servergroups/{serverGroupUuid}/backendservers

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/eff3eff582263d3c86a13819cd2b5d18/servergroups/9aaca80649283a739a83d41ecc8a38fb/backendservers

Request Parameters

Name	Type	Location	Description	Starting Version
listenerUuid	String	url	The SLB listener UUID.	5.5.38
serverGroupUuid	String	url	The backend server group UUID.	5.5.38
systemTags	List	query	Optional. The system tags.	5.5.38
userTags	List	query	Optional. The user tags.	5.5.38

API Response

Sample Response

{
  "inventories": [
    {
      "listenerUuid": "40e47fa21a763ced90e7926e2a67ec9f",
      "serverGroupUuid": "a20be0947e533b638549364fdd67c2af",
      "backendType": "VmNic",
      "vmNicUuid": "00278a9dd20139e798165db238bcaa82",
      "ipAddress": "192.168.0.10",
      "weight": 100,
      "state": "Enabled",
      "runtimeStatus": "Active",
      "healthStatus": "Unknown",
      "instancePort": 8080
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean	Whether the operation succeeds.	5.5.38
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. See error.	5.5.38
inventories	List	See inventories.	5.5.38

#inventories

Name	Type	Description	Starting Version
listenerUuid	String	The SLB listener UUID.	5.5.38
serverGroupUuid	String	The backend server group UUID.	5.5.38
backendType	String	The backend server type. Valid values: VmNic and ServerIp.	5.5.38
vmNicUuid	String	The VM NIC UUID.	5.5.38
serverIp	String	The configured address of the IP-type backend server.	5.5.38
ipAddress	String	The actual IP address of the backend server.	5.5.38
weight	Long	The weight of the backend server.	5.5.38
state	String	The administrative state of the backend server.	5.5.38
runtimeStatus	String	The running state of the backend server.	5.5.38
healthStatus	String	The health status of the backend server.	5.5.38
instancePort	Integer	The backend server port.	5.5.38

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a globally unique identifier of the error, for example, SYS.1000 or HOST.1001.	5.3.20
description	String	The brief description of the error.	5.3.20
details	String	The details about the error.	5.3.20
elaboration	String	The reserved field. Default: null.	5.3.20
opaque	LinkedHashMap	The reserved field. Default: null.	5.3.20
cause	ErrorCode	The root error, which is the source error that causes the current error. If there is no source error, this field is null.	5.3.20

SDK Sample

Java SDK

GetLoadBalancerListenerBackendServersAction action = new GetLoadBalancerListenerBackendServersAction();
action.listenerUuid = "eff3eff582263d3c86a13819cd2b5d18";
action.serverGroupUuid = "9aaca80649283a739a83d41ecc8a38fb";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetLoadBalancerListenerBackendServersAction.Result res = action.call();

Python SDK

action = GetLoadBalancerListenerBackendServersAction()
action.listenerUuid = "eff3eff582263d3c86a13819cd2b5d18"
action.serverGroupUuid = "9aaca80649283a739a83d41ecc8a38fb"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()