当前位置：首页 > 行业动态 > 正文

如何理解和应用负载均衡设备的接口文档？

admin
行业动态
2024-12-02
4071

负载均衡设备接口文档

如何理解和应用负载均衡设备的接口文档？第1张

一、

负载均衡（Load Balancing）是一种通过将工作负载分布到多个计算资源上来提高系统性能和可靠性的技术，在网络环境中，负载均衡器通过分配客户端请求到多个服务器来优化资源使用，确保没有单一服务器过载，同时提供高可用性和容错能力。

本文档旨在详细介绍负载均衡设备的接口，包括接口描述、输入参数、返回结果等，帮助用户了解和使用负载均衡设备的各项功能。

二、接口描述

1. 创建监听器（CreateListener）

1.1 接口描述

在一个负载均衡实例下创建一个监听器，本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用DescribeTaskStatus 接口查询本次任务是否成功，默认接口请求频率限制：20次/秒。

1.2 输入参数

参数名	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateListener。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表。
LoadBalancerId	是	String	负载均衡实例 ID。
Ports	是	Array of Integer	要将监听器创建到哪些端口，每个端口对应一个新的监听器。
Protocol	是	String	监听器协议：TCP	UDP	HTTP	HTTPS	TCP_SSL	QUIC。
ListenerNames.N	否	Array of String	要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数。
HealthCheck	否	HealthCheck	健康检查相关参数，此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
Certificate	否	CertificateInput	证书相关信息，此参数仅适用于TCP_SSL监听器和未开启SNI特性的HTTPS监听器，此参数和MultiCertInfo不能同时传入。
SessionExpireTime	否	Integer	会话保持时间，单位：秒，可选值：30~3600，默认 0，表示不开启，此参数仅适用于TCP/UDP监听器。
Scheduler	否	String	监听器转发的方式，可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数，默认为 WRR，此参数仅适用于TCP/UDP/TCP_SSL/QUIC监听器。
SniSwitch	否	Integer	是否开启SNI特性，此参数仅适用于HTTPS监听器，0表示未开启，1表示开启。
TargetType	否	String	后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组，此参数仅适用于TCP/UDP监听器，七层监听器应在转发规则中设置。
SessionType	否	String	会话保持类型，不传或传NORMAL表示默认会话保持类型，QUIC_CID 表示根据Quic Connection ID做会话保持，QUIC_CID只支持UDP协议，此参数仅适用于TCP/UDP监听器，七层监听器应在转发规则中设置。（若选择QUIC_CID，则Protocol必须为UDP，Scheduler必须为WRR，同时只支持ipv4）
KeepaliveEnable	否	Integer	是否开启长连接，此参数仅适用于HTTP/HTTPS监听器，0:关闭；1:开启，默认关闭。
EndPort	否	Integer	创建端口段监听器时必须传入此参数，用以标识结束端口，入参Ports只允许传入一个成员，用以标识开始端口。【如果您需要体验端口段功能，请通过工单申请】。
DeregisterTargetRst	否	Boolean	解绑后端目标时，是否发RST给客户端，此参数仅适用于TCP监听器。
MultiCertInfo	否	MultiCertInfo	证书信息，支持同时传入不同算法类型的多本服务端证书；此参数仅适用于未开启SNI特性的HTTPS监听器，此参数和Certificate不能同时传入。
MaxConn	否	Integer	监听器最大连接数，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持，不传或者传-1表示监听器维度不限速，基础网络实例不支持该参数。
MaxCps	否	Integer	监听器最大新增连接数，当前仅性能容量型实例且仅TCP/UDP/TCP_SSL/QUIC监听器支持，不传或者传-1表示监听器维度不限速，基础网络实例不支持该参数。
IdleConnectTimeout	否	Integer	空闲连接超时时间，此参数仅适用于TCP监听器，单位：秒，取值范围：共享型实例和独占型实例支持：300-900，性能容量型实例支持：300-2000，如需设置请通过工单申请。
SnatEn	否	Integer	Snat场景下源地址转换开关，此参数仅适用于四层监听器，0表示关闭；1表示开启，默认为1。