Skip to Content
负载均衡 ULB ALB创建应用型负载均衡监听器 - CreateListener

创建应用型负载均衡监听器 - CreateListener

简介

创建一个应用型负载均衡的监听器

定义

公共参数

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

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口Yes
LoadBalancerIdstring负载均衡实例的IDYes
Namestring监听器的名称。限定字符长度：[1-255]；限定特殊字符，仅支持：“-”，“_”，“.”；默认值：listenerNo
Remarkstring监听器的备注信息。限定字符长度：[0-255]No
ListenerPortint监听器的监听端口。应用型限定取值：[1-65535]，默认值80No
ListenerProtocolstring监听协议。应用型限定取值：“HTTP”/“HTTPS”，默认值“HTTP”No
Certificates.Nstring（应用型专用）服务器默认证书ID。仅HTTPS监听支持，且必填；暂时只支持最大长度为1No
SecurityPolicyIdstring（应用型专用）安全策略组ID。仅HTTPS监听支持绑定；默认值“Default”，表示绑定原生策略No
IdleTimeoutint连接空闲超时时间。单位：秒。应用型限定取值：[1-86400]；默认值60No
Schedulerstring负载均衡算法。应用型限定取值：“Roundrobin”/“Source”/“WeightRoundrobin”/” Leastconn”/“Backup”，默认值”Roundrobin”No
StickinessConfig.Enabledboolean是否开启会话保持功能。应用型负载均衡实例基于Cookie实现；默认值为：falseNo
StickinessConfig.Typestring（应用型专用）Cookie处理方式。限定枚举值：“ServerInsert” / “UserDefined”；默认值为：“ServerInsert”No
StickinessConfig.CookieNamestring（应用型专用）自定义Cookie。当StickinessType取值”UserDefined”时有效；限定字符长度：[0-255]No
HealthCheckConfig.Enabledboolean是否开启健康检查功能。暂时不支持关闭。默认值为：trueNo
HealthCheckConfig.Typestring健康检查方式。应用型限定取值：“Port”/“HTTP”，默认值：“Port”No
HealthCheckConfig.Domainstring（应用型专用）HTTP检查域名No
HealthCheckConfig.Pathstring（应用型专用）HTTP检查路径No
CompressionEnabledboolean（应用型专用）是否开启数据压缩功能。目前只支持使用gzip对特定文件类型进行压缩。默认值为：falseNo
HTTP2Enabledboolean（应用型专用）是否开启HTTP/2特性。仅HTTPS监听支持开启；默认值为：falseNo
RedirectEnabledboolean（应用型专用）是否开启HTTP重定向到HTTPS。仅HTTP监听支持开启；默认值为：falseNo
RedirectPortint（应用型专用）重定向端口。限定取值：[1-65535]，默认值443No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
ListenerIdstring监听器的IDYes

示例

请求示例

https://api.an-link.com/?Action=CreateListener
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=uvNplLqt
&LoadBalancerId=TrMQMxgz
&Name=kHEiMUtI
&Remark=VHkpyFlw
&ListenPort=3
&ListenProtocol=OjJEdAaO
&Certificates.n=WuscVHDW
&SecurityPolicyId=zwsYdamE
&IdleTimeout=3
&Scheduler=lHorTbNl
&StickinessConfig.Enabled=false
&StickinessConfig.Type=fuuciPzx
&StickinessConfig.CookieName=TnXwVeSq
&HealthCheckConfig.Enabled=true
&HealthCheckConfig.Type=pDlMtNon
&HealthCheckConfig.Domain=TWoxQhFA
&HealthCheckConfig.Path=KnPWkCVd
&CompressionEnabled=false
&HTTP2Enabled=false
&RedirectEnabled=false
&RedirectPort=1

响应示例

{
  "Action": "CreateListenerResponse",
  "ListenerId": "pCtZUlZc",
  "RetCode": 0
}
创建应用型负载均衡实例 - CreateLoadBalancer添加应用型负载均衡的后端服务节点 - AddTargets