接口说明
注意事项
新建的监听的状态为 stopped。创建完成后,调用 StartLoadBalancerListener 接口启动监听来转发流量。
前提条件
您已经创建传统型负载均衡,具体操作,请参见 CreateLoadBalancer 。
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
RegionIdstring | 传统型负载均衡实例的地域 ID。展开详情 示例值:cn-hangzhou参考取值来源: DescribeRegions |
LoadBalancerIdstring | 传统型负载均衡实例的 ID。 示例值:lb-bp1o94dp5i6earr****参考取值来源: CreateLoadBalancer DescribeLoadBalancers |
Bandwidthinteger<int32> | 监听的带宽峰值。单位:Mbps。展开详情 示例值:-1取值 <= 5120 |
ListenerPortinteger<int32> | 实例前端使用的端口。展开详情 示例值:80取值 <= 65535 |
BackendServerPortinteger<int32> | 实例后端使用的端口,取值范围:1~65535。展开详情 示例值:80取值 <= 65535 |
Tagarray<object> | 标签列表。 子级条数 <= 20 |
XForwardedForstring | 是否通过 示例值:on |
Schedulerstring | 调度算法。取值:展开详情 示例值:wrr |
StickySessionstring | 是否开启会话保持。取值:展开详情 示例值:on |
StickySessionTypestring | Cookie 的处理方式。取值:insert 或 server。展开详情 示例值:insert |
CookieTimeoutinteger<int32> | Cookie 超时时间。单位:秒。展开详情 示例值:500取值 <= 86400 |
Cookiestring | 服务器上配置的 Cookie。展开详情 示例值:testCookie |
HealthCheckstring | 是否开启健康检查。取值:展开详情 示例值:on |
HealthCheckMethodstring | 监听 HTTP 类型健康检查的健康检查方法。取值:head 或 get。展开详情 示例值:get |
HealthCheckDomainstring | 用于健康检查的域名。取值:展开详情 示例值:172.XX.XX.16 |
HealthCheckURIstring | 用于健康检查的 URI。展开详情 示例值:/test/index.html |
HealthyThresholdinteger<int32> | 健康检查连续成功多少次后,将后端服务器的健康检查状态由 fail 判定为 success。展开详情 示例值:4取值 <= 10 |
UnhealthyThresholdinteger<int32> | 健康检查连续失败多少次后,将后端服务器的健康检查状态由 success 判定为 fail。展开详情 示例值:4取值 <= 10 |
HealthCheckTimeoutinteger<int32> | 接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有正确响应,则判定为健康检查失败。单位:秒。取值:1~300。展开详情 示例值:3取值 <= 300 |
HealthCheckConnectPortinteger<int32> | 健康检查使用的端口。展开详情 示例值:8080取值 <= 65535 |
HealthCheckIntervalinteger<int32> | 健康检查的时间间隔。单位:秒。展开详情 示例值:5取值 <= 50 |
HealthCheckHttpCodestring | 健康检查正常的 HTTP 状态码,多个状态码用半角逗号(,)分割。展开详情 示例值:http_2xx,http_3xx |
ServerCertificateIdstring | 服务器证书的 ID。 示例值:idkp-123-cn-test-****参考取值来源: UploadServerCertificate DescribeServerCertificates |
VServerGroupIdstring | 服务器组 ID。 示例值:rsp-cige6j5e7p****参考取值来源: CreateVServerGroup DescribeVServerGroups SetVServerGroupAttribute AddVServerGroupBackendServers RemoveVServerGroupBackendServers ModifyVServerGroupBackendServers |
CACertificateIdstring | CA 证书 ID。展开详情 示例值:139a00604ad-cn-east-hangzh****参考取值来源: UploadCACertificate DescribeCACertificates |
XForwardedFor_SLBIPstring | 是否通过 示例值:on |
XForwardedFor_SLBIDstring | 是否通过 示例值:on参考取值来源: DescribeLoadBalancerListeners |
XForwardedFor_protostring | 是否通过 示例值:on |
Gzipstring | 是否开启 示例值:on |
AclIdstring | 监听绑定的访问策略组 ID。展开详情 示例值:acl-a2do9e413e0spzasx**** |
AclTypestring | 访问控制类型。取值:展开详情 示例值:white |
AclStatusstring | 是否开启访问控制功能。取值:展开详情 示例值:off |
Descriptionstring | 自定义监听名称。展开详情 示例值:HTTPS_443 |
IdleTimeoutinteger<int32> | 指定连接空闲超时时间,取值范围为1~60,默认值为 15。单位:秒。展开详情 示例值:12取值 <= 9999 |
RequestTimeoutinteger<int32> | 指定请求超时时间,取值范围为1~180,默认值为 60。单位:秒。展开详情 示例值:23取值 <= 9999 |
EnableHttp2string | 是否开启 HTTP2 特性。取值:展开详情 示例值:off |
TLSCipherPolicystring | 安全策略包含 HTTPS 可选的 TLS 协议版本和配套的加密算法套件。展开详情 示例值:tls_cipher_policy_1_1参考取值来源: CreateTLSCipherPolicy |
XForwardedFor_SLBPORTstring | 是否通过 示例值:off |
XForwardedFor_ClientSrcPortstring | 是否通过 示例值:off |
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | 请求 ID。 示例值:CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |