查询负载均衡器(QueryLoadBalancer)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Curl示例

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

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

可查询字段

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

API返回

返回示例

{
"inventories": [
    {
"name": "Test-Lb",
"uuid": "36c2ba1d4a86409693a2de40fa0473ca",
"vipUuid": "8807c418b3b74ee5991006bcc4c670e4"
    }
  ]
}

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

#error

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

#inventories

名字	类型	描述	起始版本
name	String	资源名称	0.6
uuid	String	资源的UUID，唯一标示该资源	0.6
description	String	资源的详细描述	0.6
state	String		0.6
vipUuid	String	VIP UUID	0.6
createDate	Timestamp	创建时间	3.1.0
lastOpDate	Timestamp	最后一次修改时间	3.1.0
listeners	List	详情参考listeners	0.6

#listeners

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

#vmNicRefs

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

#certificateRefs

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

SDK示例

Java SDK

QueryLoadBalancerAction action = new QueryLoadBalancerAction();
action.conditions = asList();
action.sessionId = "d649f3ea966e437db93b2049bef206ca";
QueryLoadBalancerAction.Result res = action.call();

Python SDK

QueryLoadBalancerAction action = QueryLoadBalancerAction()
action.conditions = []
action.sessionId = "244697b709b0490ab8d8d37e6f94592f"
QueryLoadBalancerAction.Result res = action.call()

上一篇删除负载均衡器(DeleteLoadBalancer)下一篇刷新负载均衡器(RefreshLoadBalancer)