首页 边缘节点服务 ENS 开发参考 API参考 API目录 边缘负载均衡(ELB) CreateLoadBalancerHTTPSListener - 创建HTTPS监听

CreateLoadBalancerHTTPSListener - 创建HTTPS监听

更新时间: 2024-01-29 18:19:15

调用CreateLoadBalancerHTTPSListener创建HTTPS监听。

接口说明

  • API 调用频率:100 次/秒。
  • 单用户调用频率:10 次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:CreateLoadBalancerHTTPSListenerWrite
  • acs:ens::{#accountId}:*

请求参数

名称类型必填描述示例值
LoadBalancerIdstring

负载均衡实例的 ID。

lb-5s8w63yydi59w7klaikam****
ListenerPortinteger

负载均衡实例前端使用的端口。取值:1~65535

8080
ListenerForwardstring

是否开启 HTTP 至 HTTPS 的转发。取值:

  • on:开启。
  • off(默认值):关闭。
off
ForwardPortinteger

HTTP 至 HTTPS 的监听转发端口。

0
Descriptionstring

设置监听的描述信息。长度限制为 1~80 个字符。

说明 不能以http://https://开头。
监听说明
Schedulerstring

调度算法。取值:

  • wrr(默认值):权重值越高的后端服务器,被轮询到的次数(概率)也越高。
  • wlc:除了根据每台后端服务器设定的权重值来进行轮询,同时还考虑后端服务器的实际负载(即连接数)。当权重值相同时,当前连接数越小的后端服务器被轮询到的次数(概率)也越高。
  • rr:按照访问顺序依次将外部请求依序分发到后端服务器。
  • sch:基于源 IP 地址的一致性 Hash,相同的源地址会调度到相同的后端服务器。
  • qch:基于 QUIC Connection ID 一致性 Hash,相同的 QUIC Connection ID 会调度到相同的后端服务器。
  • iqch:针对 iQUIC CID 的特定三个字节进行一致 Hash,第 2~第 4 三个字节相同的会调度到相同的后端服务器。
wrr
StickySessionTypestring

Cookie 的处理方式。取值:

  • insert:植入 Cookie。客户端第一次访问时,负载均衡会在返回请求中植入 Cookie(即在 HTTP 或者 HTTPS 响应报文中插入 SERVERID),下次客户端携带此 Cookie 访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器上。
  • server:重写 Cookie。负载均衡发现用户自定义了 Cookie,将会对原来的 Cookie 进行重写,下次客户端携带新的 Cookie 访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器。
说明 当 StickySession 的值为 on 时,必须指定该参数
insert
CookieTimeoutinteger

Cookie 超时时间。取值:1~86400,单位:秒。

说明 当 StickySession 为 on 且 StickySessionType 为 insert 时,该参数必选。
100
Cookiestring

服务器上配置的 Cookie。长度为 1~200,只能包含 ASCII 英文字母和数字字符。

说明 当 StickySession 为 on 且 StickySessionType 为 server 时,该参数必选。
example
HealthCheckstring

是否开启健康检查。取值:

  • on:开启。
  • off:关闭。
on
HealthCheckDomainstring

用于健康检查的域名。

说明 HealthCheck 值为 on 时才会有效。
example.com
HealthCheckURIstring

用于健康检查的 URI。长度限制为 1~80

说明
  • URL 不能只有/,但必须以/开头。
  • /checkpreload.htm
    HealthyThresholdinteger

    健康检查连续成功多少次后,将后端服务器的健康检查状态由 fail(后台服务器不可达)判定为 success(后台服务器可达)。取值:2~10,默认值为 3

    说明 HealthCheck 值为 on 时才会有效。
    3
    UnhealthyThresholdinteger

    健康检查连续失败多少次后,将后端服务器的健康检查状态由 success(后台服务器可达)判定为 fail(后台服务器不可达)。取值:2~10,默认值为 3

    说明 HealthCheck 值为 on 时才会有效。
    3
    HealthCheckTimeoutinteger

    接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有响应,则判定为健康检查失败。

    • 默认值:5 秒。
    • 取值:1~300
    • 单位:秒。
    说明
  • HealthCheck 值为 on 时才会有效。
    • 如果 HealthCHeckTimeout 的值小于 HealthCheckInterval 的值,则 HealthCHeckTimeout 无效,超时时间为 HealthCheckInterval 的值。
    5
    HealthCheckConnectPortinteger

    健康检查使用的端口,取值:1~65535。不设置此参数时,表示使用后端服务端口(BackendServerPort)。

    说明 HealthCheck 值为 on 时才会有效。
    11
    HealthCheckIntervalinteger

    健康检查的时间间隔。取值:1~50,默认值为 2,单位:秒。

    说明 HealthCheck 值为 on 时才会有效。
    2
    HealthCheckHttpCodestring

    健康检查正常时的 HTTP 状态码。取值:

    • http_2xx(默认值)。
    • http_3xx
    • http_4xx
    • http_5xx
    说明 HealthCheck 值为 on 时才会有效。
    http_2xx
    IdleTimeoutinteger

    指定连接空闲超时时间,默认值:15 秒,取值:1~60,单位:秒。

    说明 在超时时间内一直没有访问请求,负载均衡会暂时中断当前连接,直到一下次请求来临时重新建立新的连接。
    15
    RequestTimeoutinteger

    指定请求超时时间,默认值:60 秒,取值:1~180,单位:秒。

    说明 在超时时间内后端服务器一直没有响应,负载均衡将放弃等待,给客户端返回 HTTP 的 504 错误码。
    60
    ServerCertificateIdstring

    服务器证书的 ID。

    6027667
    HealthCheckMethodstring

    监听 HTTP 类型健康检查的健康检查方法。取值:

    • head(默认值):只请求页面的首部。
    • get:请求指定的页面信息,并返回实体主体。
    说明 HealthCheck 值为 on 时才会有效。
    head

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
    }

    错误码

    HTTP status code错误码错误信息描述
    400ens.interface.errorAn error occurred while call the API.-
    400Invalid%sThe specified parameter %s is invalid.参数不正确
    400Missing%sYou must specify the parameter %s.参数为必填
    400LoadBalancerNotFoundThe input parameter loadBalancerId that is not found. -
    400IncorrectInstanceStatusThe current status of the resource does not support this operation.当前操作不被支持,磁盘正在重置中。
    400ServerCertificateNotFoundThe input parameter serverCertificateId that is not found.-
    400ListenerAlreadyExistsThe listenerPort already exists.-
    400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
    400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    阿里云首页 边缘节点服务 ENS 相关技术圈