调用CreateLoadBalancerHTTPSListener创建HTTPS监听。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateLoadBalancerHTTPSListener |
要执行的操作。 取值:CreateLoadBalancerHTTPSListener。 |
Bandwidth | Integer | 是 | -1 |
监听的带宽峰值。 取值:-1或1~5120。
|
HealthCheck | String | 是 | on |
是否开启健康检查。 取值:on或off。 |
ListenerPort | Integer | 是 | 80 |
负载均衡实例前端使用的端口。 取值:1~65535。 |
LoadBalancerId | String | 是 | lb-bp1o94dp5i6earr**** |
负载均衡实例的ID。 |
ServerCertificateId | String | 是 | idkp-123-cn-test-**** |
服务器证书的ID。 |
StickySession | String | 是 | on |
是否开启会话保持。 取值:on或off。 |
RegionId | String | 是 | cn-hangzhou |
负载均衡实例的地域ID。 您可以从地域和可用区列表或通过调用DescribeRegions接口查询地域ID。 |
BackendServerPort | Integer | 否 | 80 |
负载均衡实例后端使用的端口,取值:1~65535。 如果不使用服务器组(不指定VServerGroupId),则该参数必选。 |
XForwardedFor | String | 否 | on |
是否通过 取值为on。 |
Scheduler | String | 否 | wrr |
调度算法。取值:
|
StickySessionType | String | 否 | insert |
Cookie的处理方式。当StickySession的值为on时,必须指定该参数。 取值:insert或server。
|
CookieTimeout | Integer | 否 | 500 |
Cookie超时时间。 取值:1~86400秒。 说明 当StickySession为on且StickySessionType为insert时,该参数必选。
|
Cookie | String | 否 | B490B5EBF6F3CD402E515D22BCDA**** |
服务器上配置的Cookie。 长度为1~200,只能包含ASCII英文字母和数字字符,不能包含逗号、分号或空格,也不能以$开头。 说明 当StickySession为on且StickySessionType为server时,该参数必选。
|
HealthCheckDomain | String | 否 | 172.XX.XX.16 |
用于健康检查的域名。取值:
说明 在HealthCheck值为on时才会有效。
|
HealthCheckURI | String | 否 | /test/index.html |
用于健康检查的URI。 长度限制为1~80,只能使用字母、数字和-/.%?#&这些字符。 URL不能只为/,但必须以/开头。 说明 在HealthCheck值为on时才会有效。
|
HealthyThreshold | Integer | 否 | 4 |
健康检查连续成功多少次后,将后端服务器的健康检查状态由fail判定为success。 取值:2或10。 说明 在HealthCheck值为on时才会有效。
|
UnhealthyThreshold | Integer | 否 | 4 |
健康检查连续失败多少次后,将后端服务器的健康检查状态由success判定为fail。 取值:2或10。 说明 在HealthCheck值为on时才会有效。
|
HealthCheckTimeout | Integer | 否 | 3 |
接收来自运行状况检查的响应需要等待的时间。如果后端ECS在指定的时间内没有正确响应,则判定为健康检查失败。在HealthCheck值为on时才会有效。 取值:1或300秒。 说明
|
HealthCheckConnectPort | Integer | 否 | 8080 |
健康检查使用的端口。 取值:1~65535。 说明 当HealthCheck值为on时才会有效。
|
HealthCheckInterval | Integer | 否 | 5 |
健康检查的时间间隔。 取值:1~50秒。 说明 在HealthCheck值为on时才会有效。
|
HealthCheckHttpCode | String | 否 | http_2xx,http_3xx |
健康检查正常的HTTP状态码,多个状态码用半角逗号(,)分割。默认值为http_2xx。 取值:http_2xx、http_3xx、http_4xx或http_5xx。 说明 在HealthCheck值为on时才会有效。
|
VServerGroupId | String | 否 | rsp-cige6j5e7p**** |
服务器组ID。 |
CACertificateId | String | 否 | 139a00604ad-cn-east-hangzh**** |
CA证书ID。 若既上传CA证书又上传服务器证书,即采用双向认证。 若用户只上传服务器证书,即为单向认证。 |
XForwardedFor_SLBIP | String | 否 | on |
是否通过SLB-IP头字段获取来访者真实IP。 取值:on或off (默认值)。 |
XForwardedFor_SLBID | String | 否 | on |
是否通过SLB-ID头字段获取SLB实例ID。 取值:on或off (默认值)。 |
XForwardedFor_proto | String | 否 | on |
是否通过X-Forwarded-Proto头字段获取SLB的监听协议。 取值:on或off (默认值)。 |
Gzip | String | 否 | on |
是否开启Gzip压缩,对特定文件类型进行压缩。 取值:on(默认值)或off 。 |
AclId | String | 否 | nacl-a2do9e413e0spzasx**** |
监听绑定的访问策略组ID。 说明 当AclStatus参数的值为on时,该参数必选。
|
AclType | String | 否 | white |
访问控制类型:
如果开启了黑名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。 说明 当AclStatus参数的值为on时,该参数有效。
|
AclStatus | String | 否 | off |
是否开启访问控制功能。 取值:on或off(默认值)。 |
Description | String | 否 | 创建监听 |
设置监听的描述信息。 长度限制为1~80个字符,允许包含字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)等字符。支持中文描述。 |
IdleTimeout | Integer | 否 | 12 |
指定连接空闲超时时间,取值范围为1~60秒,默认值为15秒。 在超时时间内一直没有访问请求,负载均衡会暂时中断当前连接,直到一下次请求来临时重新建立新的连接。 |
RequestTimeout | Integer | 否 | 23 |
指定请求超时时间,取值范围为1~180秒,默认值为60秒。 在超时时间内后端服务器一直没有响应,负载均衡将放弃等待,给客户端返回HTTP 504错误码。 |
EnableHttp2 | String | 否 | off |
是否开启HTTP/2特性。 取值:on(默认值)或off。 |
TLSCipherPolicy | String | 否 | tls_cipher_policy_1_1 |
只有性能保障型实例才可以指定TLSCipherPolicy参数,每种policy定义了一种安全策略,安全策略包含HTTPS可选的TLS协议版本和配套的加密算法套件。 目前支持以下四种安全策略,详细区别请参见TLS安全策略差异说明,请根据实际情况选择对应的policy。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateLoadBalancerHTTPSListener
&Bandwidth=-1
&HealthCheck=on
&ListenerPort=80
&LoadBalancerId=lb-bp1o94dp5i6earr*****
&ServerCertificateId=idkp-123-cn-test-01**
&StickySession=on
&<公共请求参数>
正常返回示例
XML
格式
<CreateLoadBalancerHTTPSListenerResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</CreateLoadBalancerHTTPSListenerResponse>
JSON
格式
{"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | LbNotSupportTcpssl | You cannot create a TCP SSL type listener for the specified load balancer. | 指定的实例不支持创建tcpssl类型的监听。 |
400 | LbSupportTcpsslOnly | The specified load balancer supports TCP SSL type listener only. | 指定的实例只支持创建tcpssl类型的监听。 |
400 | ListenerNotSupportRule | You cannot create a rule for the specified listener. | 指定的监听不支持创建转发规则。 |
访问错误中心查看更多错误码。