更新应用型负载均衡监听器属性 - UpdateListenerAttribute

简介

更新一个应用型负载均衡监听器的属性

定义

公共参数

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `UpdateListenerAttribute`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

请求参数

参数名	类型	描述信息	必填
Region	string	地域。参见地域和可用区列表	Yes
ProjectId	string	项目ID。不填写为默认项目，子帐号必须填写。请参考GetProjectList接口	Yes
LoadBalancerId	string	应用型负载均衡实例ID	Yes
ListenerId	string	应用型负载均衡监听器的ID	Yes
Name	string	监听器的名称。限定字符长度：[1-255]；限定特殊字符，仅支持：“-”，“_”，“.”；不传该参数则默认不修改	No
Remark	string	监听器的备注信息。限定字符长度：[0-255]；不传该参数则默认不修改	No
Certificates	array[string]	（应用型专用）服务器默认证书ID。仅HTTPS监听支持；暂时只支持最大长度为1；不传该参数则默认不修改	No
SecurityPolicyId	string	（应用型专用）安全策略组ID。仅HTTPS监听支持绑定；不传该参数则默认不修改（除“Default”-原生策略外，皆传Id格式）	No
IdleTimeout	int	连接空闲超时时间。单位：秒；应用型限定取值：[1-86400]；不传该参数则默认不修改	No
Scheduler	string	负载均衡算法。应用型限定取值：Roundrobin -> 轮询;Source -> 源地址； WeightRoundrobin -> 加权轮询; Leastconn -> 最小连接数；Backup ->主备模式。不传该参数则默认不修改	No
StickinessConfig	StickinessConfigInfo	会话保持相关配置。具体结构详见 StickinessConfigInfo	No
HealthCheckConfig	HealthCheckConfig	健康检查相关配置。具体结构详见 HealthCheckConfig	No
CompressionEnabled	bool	应用型专用）是否开启数据压缩功能。目前只支持使用gzip对特定文件类型进行压缩；不传该参数则默认不修改	No
HTTP2Enabled	bool	（应用型专用）是否开启HTTP/2特性。仅HTTPS监听支持开启；不传该参数则默认不修改	No
RedirectEnabled	bool	（应用型专用）是否开启HTTP重定向到HTTPS。仅HTTP监听支持开启；不传该参数则默认不修改	No
RedirectPort	int	（应用型专用）重定向端口。限定取值：[1-65535]；没传RedirectEnabled，RedirectPort不能修改	No

数据模型

StickinessConfigInfo

字段名	类型	描述信息	必填
Enabled	bool	是否开启会话保持功能。应用型负载均衡实例基于Cookie实现；默认值为：false；不传该参数则默认不修改	No
Type	string	（应用型专用）Cookie处理方式。限定枚举值： ServerInsert -> 自动生成KEY；UserDefined -> 用户自定义KEY；不传该参数则默认不修改；只有处于开启会话保持功能的listener才支持直接更改Type	No
CookieName	string	（应用型专用）自定义Cookie。当Type取值”UserDefined”时有效且需必填；限定字符长度：[1-255]；不传该参数则默认不修改	No

HealthCheckConfig

字段名	类型	描述信息	必填
Enabled	bool	是否开启健康检查功能。默认值为：true; 暂时不支持关闭。	No
Type	string	健康检查方式。应用型限定取值： Port -> 端口检查；HTTP -> HTTP检查；不传该参数则默认不修改	No
Domain	string	（应用型专用）HTTP检查域名。当Type为HTTP时，此字段有意义，代表HTTP检查域名；不传该参数则默认不修改	No
Path	string	（应用型专用）HTTP检查路径。当Type为HTTP时，此字段有意义，代表HTTP检查路径；不传该参数则默认不修改	No

响应字段

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No
ListenerId	string	监听器的ID	No

示例

请求示例


curl 'https://api.an-link.com' \
--header 'Content-Type: application/json' \
--data '{
    "Action": "UpdateListenerAttribute",
    "Region": "cn-bj2",
    "ProjectId": "org-XXXXX",
    "LoadBalancerId": "alb-XXXXX",
    "ListenerId": "als-XXXXX",
    "Name":    "ListenerName",
    "Remark": "ListenerRemark",
    "Certificates": ["ssl-XXXXX"],
    "SecurityPolicyId":"security-tls12s",
    "IdleTimeout": 60,
    "Scheduler": "Roundrobin",
    "StickinessConfig": {
        "Enabled": true,
        "Type": "ServerInsert"
    },
    "HealthCheckConfig": {
        "Enabled": true,
        "Type": "Port"
    },
    "CompressionEnabled": true,
    "HTTP2Enabled": true
}'

响应示例


{
  "Action": "UpdateListenerAttributeResponse",
  "RetCode": 0
}