AI 助理
备案控制台
文档
输入文档关键字查找
首页 边缘节点服务 ENS 开发参考 API参考 API目录 边缘负载均衡（ELB） DescribeLoadBalancerHTTPSListenerAttribute - 查询HTTPS监听属性

DescribeLoadBalancerHTTPSListenerAttribute - 查询HTTPS监听属性

更新时间：
产品详情
我的收藏

调用DescribeLoadBalancerHTTPSListenerAttribute查询HTTPS监听配置。

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ListenerPortinteger是

需要查询的监听端口。取值：1~65535。

443
LoadBalancerIdstring是

负载均衡实例的 ID。

lb-5qoxu2rsr0ytanpn4r3i****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ListenerPortinteger

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

8080
Statusstring

当前监听的状态。取值：

  • Running：正常运行。
  • Stopped：运行停止。
  • Starting：启动中。
  • Configuring：配置中。
  • Stopping：运行停止中。
Running
Bandwidthinteger

负载均衡带宽峰值，默认值为-1（表示不限速）。

50
Schedulerstring

调度算法。取值：

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

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

  • on：开启。
  • off：关闭。
on
HealthyThresholdinteger

健康检查连续成功多少次后，将后端服务器的健康检查状态由 fail（后台服务器不可达）判定为 success（后台服务器可达）。取值：2~10。

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

健康检查连续失败多少次后，将后端服务器的健康检查状态由 success（后台服务器可达）判定为 fail（后台服务器不可达）。取值：2~10。

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

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

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

    健康检查使用的端口，取值：1~65535。不设置此参数时，表示使用后端服务端口（BackendServerPort）。

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

    健康检查的时间间隔。取值：1~50，单位：秒。

    说明 在 HealthCheck 值为 on 时才会有效。
    		5
    Descriptionstring

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

    		abc
    ListenerForwardstring

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

    • on：开启。
    • off：关闭。
    		off
    ForwardPortinteger

    HTTP 至 HTTPS 的监听转发端口。

    		0
    RequestTimeoutinteger

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

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

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

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

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

    • http_2xx（默认值）。
    • http_3xx。
    • http_4xx。
    • http_5xx。
    说明 HealthCheck 值为 on 时才会有效。
    		http_2xx
    HealthCheckDomainstring

    用于健康检查的域名。

    说明 在 HealthCheck 值为 on 时才会有效。
    		www.test.com
    HealthCheckURIstring

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

    • URL 不能只有/，但必须以/开头。
    • HealthCheck 值为 on 时才会有效。
    		/checkpreload.htm
    ServerCertificateIdstring

    服务器证书的 ID。

    		60276**
    HealthCheckMethodstring

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

    • head：只请求页面的首部。
    • get：请求指定的页面信息，并返回实体主体。
    说明 HealthCheck 值为 on 时才会有效。
    		head
    BackendServerPortinteger

    负载均衡实例后端服务器使用的端口，取值：1~65535。

    		8080

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 8080,
  "Status": "Running",
  "Bandwidth": 50,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 3,
  "UnhealthyThreshold": 3,
  "HealthCheckTimeout": 5,
  "HealthCheckConnectPort": 9902,
  "HealthCheckInterval": 5,
  "Description": "abc",
  "ListenerForward": "off",
  "ForwardPort": 0,
  "RequestTimeout": 60,
  "IdleTimeout": 15,
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "www.test.com",
  "HealthCheckURI": "/checkpreload.htm",
  "ServerCertificateId": "60276**",
  "HealthCheckMethod": "head",
  "BackendServerPort": 8080
}

    错误码

    HTTP status code错误码错误信息描述
    400LoadBalancerNotFoundThe input parameter loadBalancerId that is not found.负载均衡实例不存在
    400ens.interface.errorAn error occurred while call the API.-
    400NoPermissionPermission denied.没有足够的权限，请联系云账号管理员授予您相应权限。
    400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

    变更历史

    变更时间变更内容概要操作
    2024-08-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    上一篇：SetLoadBalancerHTTPSListenerAttribute - 修改HTTPS监听属性下一篇：StartLoadBalancerListener - 启动监听
    文档推荐