查询负载均衡器服务器组(QueryLoadBalancerServerGroup)

API请求

URLs

GET zstack/v1/load-balancers/servergroups

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

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/load-balancers/servergroups

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/load-balancers/servergroups/3d12c68915bd391ca7cea7a95249b47b

可查询字段

运行CLI命令行工具，输入QueryLoadBalancerServerGroup并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "f523d90c41b136279b523052149c9690",
      "name": "Test-LbServerGroup"
    }
  ]
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.0.0
inventories	List	详情参考inventories	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

#inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.0.0
name	String	资源名称	4.0.0
description	String	资源的详细描述	4.0.0
loadBalancerUuid	String	负载均衡器UUID	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0
listenerServerGroupRefs	List	详情参考listenerServerGroupRefs	4.0.0
serverIps	List	详情参考serverIps	4.0.0
vmNicRefs	List	详情参考vmNicRefs	4.0.0

#listenerServerGroupRefs

名字	类型	描述	起始版本
id	long		4.0.0
listenerUuid	String		4.0.0
serverGroupUuid	String		4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0

#serverIps

名字	类型	描述	起始版本
id	long		4.0.0
description	String	资源的详细描述	4.0.0
serverGroupUuid	String		4.0.0
ipAddress	String		4.0.0
weight	Long		4.0.0
status	String		4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0

#vmNicRefs

名字	类型	描述	起始版本
id	Long		4.0.0
serverGroupUuid	String		4.0.0
vmNicUuid	String	云主机网卡UUID	4.0.0
weight	Long		4.0.0
status	String		4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0

SDK示例

Java SDK

QueryLoadBalancerServerGroupAction action = new QueryLoadBalancerServerGroupAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryLoadBalancerServerGroupAction.Result res = action.call();

Python SDK

QueryLoadBalancerServerGroupAction action = QueryLoadBalancerServerGroupAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryLoadBalancerServerGroupAction.Result res = action.call()

上一篇更新负载均衡器服务器组(UpdateLoadBalancerServerGroup)下一篇添加后端服务器到服务器组(AddBackendServerToServerGroup)