修改负载均衡监听器参数(ChangeLoadBalancerListener)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "changeLoadBalancerListener": {
    "connectionIdleTimeout": 300,
    "maxConnection": 5000,
    "balancerAlgorithm": "roundrobin",
    "healthCheckTarget": "default",
    "healthyThreshold": 2,
    "unhealthyThreshold": 3,
    "healthCheckInterval": 5,
    "nbprocess": 1,
    "httpMode": "http-keep-alive",
    "sessionPersistence": "insert",
    "sessionIdleTimeout": 60
  },
  "systemTags": [],
  "userTags": []
}

Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeLoadBalancerListener":{"connectionIdleTimeout":300,"maxConnection":5000,"balancerAlgorithm":"roundrobin","healthCheckTarget":"default","healthyThreshold":2,"unhealthyThreshold":3,"healthCheckInterval":5,"nbprocess":1,"httpMode":"http-keep-alive","sessionPersistence":"insert","sessionIdleTimeout":60}}'
http://localhost:8080/zstack/v1/load-balancers/listeners/ca4f7cea0c5a3a329742b127d7f80615/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
uuid	String	url	资源的UUID，唯一标示该资源		3.4.0
connectionIdleTimeout (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	空闲连接超时		4.6.0
maxConnection (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	最大连接并发数		4.6.0
balancerAlgorithm (可选)	String	body(包含在changeLoadBalancerListener结构中)	负载均衡算法	weightroundrobin roundrobin leastconn source	4.6.0
healthCheckTarget (可选)	String	body(包含在changeLoadBalancerListener结构中)	健康检查端口		4.6.0
healthyThreshold (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	健康检查阈值		4.6.0
unhealthyThreshold (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	非健康检查阈值		4.6.0
healthCheckInterval (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	健康检查间隔		4.6.0
healthCheckProtocol (可选)	String	body(包含在changeLoadBalancerListener结构中)	负载均衡健康检查协议	tcp udp http	3.9.0
healthCheckMethod (可选)	String	body(包含在changeLoadBalancerListener结构中)	健康检查方法	GET HEAD	3.9.0
healthCheckURI (可选)	String	body(包含在changeLoadBalancerListener结构中)	健康检查的URI		3.9.0
healthCheckHttpCode (可选)	String	body(包含在changeLoadBalancerListener结构中)	健康检查期望的成功返回码		3.9.0
aclStatus (可选)	String	body(包含在changeLoadBalancerListener结构中)	访问控制状态	enable disable	3.9.0
securityPolicyType (可选)	String	body(包含在changeLoadBalancerListener结构中)	TLS安全策略	tls_cipher_policy_default tls_cipher_policy_1_0 tls_cipher_policy_1_1 tls_cipher_policy_1_2 tls_cipher_policy_1_2_strict tls_cipher_policy_1_2_strict_with_1_3	4.1.0
nbprocess (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	负载均衡进程数量		4.1.0
httpMode (可选)	String	body(包含在changeLoadBalancerListener结构中)	负载均衡HTTP模式	http-keep-alive http-server-close http-tunnel httpclose forceclose	4.1.0
sessionPersistence (可选)	String	body(包含在changeLoadBalancerListener结构中)	会话保持模式	disable iphash insert rewrite	4.6.0
sessionIdleTimeout (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	会话保持超时时间		4.6.0
cookieName (可选)	String	body(包含在changeLoadBalancerListener结构中)	Cookie名称		4.6.0
systemTags (可选)	List	body			3.4.0
userTags (可选)	List	body			3.4.0
httpRedirectHttps (可选)	String	body(包含在changeLoadBalancerListener结构中)	http重定向https	disable enable	4.7.21
redirectPort (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	重定向端口		4.7.21
statusCode (可选)	Integer	body(包含在changeLoadBalancerListener结构中)	重定向状态码	301 302 303 307 308	4.7.21
httpVersions (可选)	List	body(包含在changeLoadBalancerListener结构中)	负载均衡器前端网络http协议版本	h1 h2	5.0.0
tcpProxyProtocol (可选)	String	body(包含在changeLoadBalancerListener结构中)	tcp proxy_protocol协议	v1 v2 disable	5.0.0
httpCompressAlgos (可选)	List	body(包含在changeLoadBalancerListener结构中)	http压缩算法	deflate raw-deflate gzip diasble	5.0.0

Note:

ZStack Cloud修改负载均衡监听器参数时支持设置后端server的权重，SystemTags增加balancerWeight选项。
- 选项格式为：balancerWeight::{nicUuid}::{weight}，其中weight为对应后端server的权重.范围:0~100的整数，默认为100。
- 例如：balancerWeight::{"c44007641c9040c6b2587e19b1b3e2b0"}::{100}

API返回

返回示例

{
  "inventory": {
    "uuid": "6356c8f8ae7534bab9a2175144dbc997",
    "name": "Test-Listener",
    "description": "desc info",
    "loadBalancerUuid": "4b32d1a27d8e3d77a606e5014caddd86",
    "instancePort": 80,
    "loadBalancerPort": 80,
    "protocol": "http"
  }
}

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

#error

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

#inventory

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

#vmNicRefs

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

#aclRefs

名字	类型	描述	起始版本
id	Long	资源唯一标识	3.9.0
listenerUuid	String	监听器唯一标识	3.9.0
aclUuid	String	访问策略组唯一标识	3.9.0
type	String	访问策略类型	3.9.0
createDate	Timestamp	创建时间	3.9.0
lastOpDate	Timestamp	最后一次修改时间	3.9.0

#certificateRefs

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

#serverGroupRefs

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

SDK示例

Java SDK

ChangeLoadBalancerListenerAction action = new ChangeLoadBalancerListenerAction();
action.uuid = "ca4f7cea0c5a3a329742b127d7f80615";
action.connectionIdleTimeout = 300;
action.maxConnection = 5000;
action.balancerAlgorithm = "roundrobin";
action.healthCheckTarget = "default";
action.healthyThreshold = 2;
action.unhealthyThreshold = 3;
action.healthCheckInterval = 5;
action.nbprocess = 1;
action.httpMode = "http-keep-alive";
action.sessionPersistence = "insert";
action.sessionIdleTimeout = 60;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeLoadBalancerListenerAction.Result res = action.call();

Python SDK

ChangeLoadBalancerListenerAction action = ChangeLoadBalancerListenerAction()
action.uuid = "ca4f7cea0c5a3a329742b127d7f80615"
action.connectionIdleTimeout = 300
action.maxConnection = 5000
action.balancerAlgorithm = "roundrobin"
action.healthCheckTarget = "default"
action.healthyThreshold = 2
action.unhealthyThreshold = 3
action.healthCheckInterval = 5
action.nbprocess = 1
action.httpMode = "http-keep-alive"
action.sessionPersistence = "insert"
action.sessionIdleTimeout = 60
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeLoadBalancerListenerAction.Result res = action.call()

上一篇更新负载均衡监听器(UpdateLoadBalancerListener)下一篇获取云主机网卡(GetCandidateVmNicsForLoadBalancer)