更新负载均衡监听器(UpdateLoadBalancerListener)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateLoadBalancerListener": {
    "name": "Test-Listener",
    "description": "desc info"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateLoadBalancerListener":{"name":"Test-Listener","description":"desc info"}}' \
http://localhost:8080/zstack/v1/load-balancers/listeners/6566eed5ab7432d2956b1c093d25daab

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	0.6
name (可选)	String	body(包含在updateLoadBalancerListener结构中)	资源名称	0.6
description (可选)	String	body(包含在updateLoadBalancerListener结构中)	资源的详细描述	0.6
systemTags (可选)	List	body		0.6
userTags (可选)	List	body		0.6

API返回

返回示例

{
  "inventory": {
    "uuid": "84735dfea01d359196587f35314a1e17",
    "name": "Test-Listener",
    "description": "desc info",
    "loadBalancerUuid": "c8f77d0df3c83e449f0d372dbe80bd09",
    "instancePort": 80.0,
    "loadBalancerPort": 80.0,
    "protocol": "http"
  }
}

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

#inventory

名字	类型	描述	起始版本
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

UpdateLoadBalancerListenerAction action = new UpdateLoadBalancerListenerAction();
action.uuid = "6566eed5ab7432d2956b1c093d25daab";
action.name = "Test-Listener";
action.description = "desc info";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateLoadBalancerListenerAction.Result res = action.call();

Python SDK

UpdateLoadBalancerListenerAction action = UpdateLoadBalancerListenerAction()
action.uuid = "6566eed5ab7432d2956b1c093d25daab"
action.name = "Test-Listener"
action.description = "desc info"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateLoadBalancerListenerAction.Result res = action.call()

上一篇查询负载均衡监听器(QueryLoadBalancerListener)下一篇修改负载均衡监听器参数(ChangeLoadBalancerListener)