RefreshLoadBalancer

API Request

URLs

PUT zstack/v1/load-balancers/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
"refreshLoadBalancer": {},
"systemTags": [],
"userTags": []
}

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b1e125550d924d17a0efa1bb6dd36806" \
-X PUT -d '{"refreshLoadBalancer":{}}' \
http://localhost:8080/zstack/v1/load-balancers/9fb0a5a16d06393db160485b0b79fd49/actions

Request Parameters


Name	Type	Location	Description	Starting Version
uuid	String	url	The resource UUID.	0.6
systemTags	List	body	Optional. The system tags.	0.6
userTags	List	body	Optional. The user tags.	0.6

API Response

Sample Response

{
"inventory": {
"name": "Test-Lb",
"uuid": "ee6de94ed5bf49c8b09a7bd3e5965c60",
"vipUuid": "691e275592d84c898c1d495febf42a9a"
  }
}


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
inventory	LoadBalancerInventory	See inventory.	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

#inventory


Name	Type	Description	Starting Version
name	String	The resource name.	0.6
uuid	String	The resource UUID.	0.6
description	String	The detailed description of the resource.	0.6
state	String		0.6
vipUuid	String	The VIP UUID.	0.6
createDate	Timestamp	The creation date.	3.1.0
lastOpDate	Timestamp	The last operation date.	3.1.0
listeners	List	See listeners.	0.6

#listeners


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		0.6
loadBalancerPort	Integer		0.6
protocol	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
vmNicRefs	List	See vmNicRefs.	0.6
aclRefs	List	See aclRefs.	3.9.0
certificateRefs	List	See certificateRefs.	0.6

#vmNicRefs


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

#aclRefs


Name	Type	Description	Starting Version
id	Long	The resource UUID.	3.9.0
listenerUuid	String	The listener UUID.	3.9.0
aclUuid	String	The UUID of the access control list group.	3.9.0
type	String	The type of the access control list.	3.9.0
createDate	Timestamp	The creation date.	3.9.0
lastOpDate	Timestamp	The last operation date.	3.9.0

#certificateRefs


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

SDK Sample

Java SDK

RefreshLoadBalancerAction action = new RefreshLoadBalancerAction();
action.uuid = "cad53be6896e43cf8aef4021d165f56d";
action.sessionId = "fec73392481a4edaa2738131516ef0d7";
RefreshLoadBalancerAction.Result res = action.call();

Python SDK

RefreshLoadBalancerAction action = RefreshLoadBalancerAction()
action.uuid = "3556da2f1d3b47e48ec3068a5c3055ba"
action.sessionId = "9947fe6582f44b5a961143d08f49a2eb"
RefreshLoadBalancerAction.Result res = action.call()