负载均衡
负载均衡
网络型负载均衡NLB
请输入
- 文档首页
负载均衡API参考后端服务器组ModifyNLBServerGroupAttributes - 修改服务器组
复制全文
下载 pdfModifyNLBServerGroupAttributes - 修改服务器组
文档反馈
问问助手调用 ModifyNLBServerGroupAttributes 接口，修改服务器组的名称、描述或健康检查信息。
使用说明
调用一次接口最多可修改20台后端服务器。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
下表中非必选参数不传入则表示保持原有配置不变。
Action String 必选 示例值：ModifyNLBServerGroupAttributes
要执行的操作，取值为 ModifyNLBServerGroupAttributes。
Version String 必选 示例值：2020-04-01
API版本信息，当前版本为 2020-04-01。
ServerGroupName String 可选 示例值：myservergroup
服务器组的名称。
- 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。
- 长度限制为1 ～ 128个字符。
Description String 可选 示例值：This is a servergroup.
服务器组的描述。
- 必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
- 长度限制为0～ 255个字符。
Scheduler String 可选 示例值：wrr
NLB转发流量时遵循的规则。
- wrr：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。
- wlc：加权最小连接数，在最少连接数的基础上，根据后端服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。
- sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
ConnectionDrainEnabled Boolean 可选 示例值：true
是否开启连接优雅中断。
请严格按照以下枚举值的大小写输入，不要传入其他取值。
- true：开启。
- false：关闭。
ConnectionDrainTimeout Integer 可选 示例值：60
连接优雅中断超时时间，取值范围为0～900秒。
参数ConnectionDrainEnabled由“false”改为“true”时，该参数为必填。
PreserveClientIpEnabled Boolean 可选 示例值：true
是否开启源地址保持。
请严格按照以下枚举值的大小写输入，不要传入其他取值。
- true：开启。NLB转发给后端服务器的数据包中会携带客户端源IP地址。
- false：关闭。
SessionPersistenceEnabled Boolean 可选 示例值：true
是否开启会话保持。
请严格按照以下枚举值的大小写输入，不要传入其他取值。
- true：开启，支持基于源IP地址的会话保持。
- false：关闭。
SessionPersistenceTimeout Integer 可选 示例值：10
会话保持的超时时间，取值范围为1～3600秒。
ProxyProtocolType String 可选 示例值：off
是否启用Proxy-Protocol协议。取值如下：
- off：关闭。
- standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至服务器，还需要在服务器上配置Proxy-Protocol。
BypassSecurityGroupEnabled Boolean 可选 示例值：true
是否开启放通后端安全组功能。仅服务器类型服务器组，可以配置此参数。
- true：开启。服务器组中的后端服务器的安全组不再校验NLB的流量，默认放通。
- false：未开启。
TimestampRemoveEnabled Boolean 可选 示例值：true
是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。
请严格按照以下枚举值的大小写输入，不要传入其他取值。
- true：开启。
- false：不开启。
说明
本功能正在邀测中，如需试用，请联系客户经理。
HealthCheck.Enabled Boolean 可选 示例值：true
监听器是否开启健康检查功能。
请严格按照以下枚举值的大小写输入，不要传入其他取值。
- true ：开启。
- false：关闭。
说明
以下参数仅当本参数的值为“true”时有效。
HealthCheck.Type String 可选 示例值：TCP
健康检查的类型。取值如下：
- TCP：发送SYN握手报文，以此检测后端服务器端口的状态是否正常。
- HTTP：发送HEAD或GET请求模拟浏览访问行为，以此检测后端服务器应用是否正常。
- UDP：发送ICMP或UDP探测报文，以此检测后端服务器是否正常。
HealthCheck.Port String 可选 示例值：10
健康检查的端口，取值范围 1～65535
- 服务器组未开启全端口转发时，该参数默认为0，表示使用后端服务器的端口进行健康检查。
- 服务器组开启全端口转发时，必须指定该参数。
HealthCheck.Method String 可选 示例值：GET
健康检查的方法。取值如下：
- GET：服务器需支持GET方法。
- HEAD：服务器仅返回HEAD头部信息，可以降低后端开销，但要求服务器支持HEAD方法。
说明
当HealthCheck.Type取值为“HTTP”时，该参数生效。
HealthCheck.URI String 可选 示例值：/
健康检查的路径。
- 必须以字符“/”开头。
- 可包含字母、数字、中划线（-）、下划线（_）、斜划线（/）、点号（.）、百分号（%）、问号（?）、#号（#）、连接符（&）和等号（＝）。
- 长度限制在1~128字符之间。
说明
当HealthCheck.Type取值为“HTTP”时，该参数生效。
HealthCheck.Domain String 可选 示例值：www.test
健康检查的域名，需配置为服务器上真实对外提供服务的地址。
- 需至少包含一个点号（.），且不允许以点号（.）开头或结尾。
- 仅支持大小写字母、数字、短划线（-）、半角句号（.），‘-’不得出现在字符串的头部或尾部。
- 长度限制为1-80字符。
- 该参数不传入，则默认使用后端服务器的私网IP地址进行健康检查。
HealthCheck.HttpCode String 可选 示例值：http_2xx,http_3xx
健康检查正常的HTTP状态码。取值如下：
- http_2xx
- http_3xx
- http_4xx
- http_5xx
说明
当HealthCheck.Type取值为“HTTP”时，该参数生效。多个状态码使用,分隔。
HealthCheck.UdpRequest String 可选 示例值：Request123
UDP健康检查的请求字符串。
- 只允许包含字母和数字，最大长度限制为64个字符。
- 当参数Protocol配置为UDP，且参数HealthCheck.Enabled配置为on时，该参数生效。
- 参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
HealthCheck.UdpExpect String 可选 示例值：Expect123
UDP健康检查的预期响应字符串。
- 只允许包含字母和数字，最大长度限制为64个字符。
- 当参数Protocol配置为UDP，且参数HealthCheck.Enabled配置为on时，该参数生效。
- 参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
HealthCheck.Interval Integer 可选 示例值：2
健康检查的时间间隔，取值范围为1 ～ 300秒。
HealthCheck.Timeout Integer 可选 示例值：2
健康检查的响应超时时间，取值范围为1 ～ 60秒。
如果后端服务器在指定时间内没有正确响应，则判定为健康检查“异常”。
HealthCheck.HealthyThreshold Integer 可选 示例值：3
健康检查的健康阈值，取值范围为2 ～ 10次。
连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
HealthCheck.UnhealthyThreshold Integer 可选 示例值：3
健康检查的不健康阈值，取值范围为2 ～ 10次。
连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
返回参数
RequestId String 示例值：2024092952539010225146063030****
请求ID。
请求示例
返回示例
错误码
最近更新时间：2026.03.11 14:59:12
这个页面对您有帮助吗？
有用
有用
无用
无用