You need to enable JavaScript to run this app.
导航
负载均衡
  • 文档首页
    • /负载均衡/网络型负载均衡NLB/API参考/服务器组/ModifyNLBServerGroupAttributes
ModifyNLBServerGroupAttributes
最近更新时间：2024.12.04 17:10:14首次发布时间：2024.12.04 17:10:14
我的收藏

调用 ModifyNLBServerGroupAttributes 接口，修改服务器组的名称、描述或健康检查信息。

使用说明

调用一次接口最多可修改20台后端服务器。

请求参数

下表中非必选参数不传入则表示保持原有配置不变。

名称类型是否必选示例值说明
ActionString是ModifyNLBServerGroupAttributes要执行的操作，取值为ModifyNLBServerGroupAttributes。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
ServerGroupIdString是rsp-bp1o94dp5i6ea****服务器组ID。您可以调用DescribeNLBServerGroups接口获取服务器组ID。

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：关闭。
SessionPersistenceTimeoutInteger否10会话保持的超时时间，取值范围为1～3600秒。

ProxyProtocolType

String

否

off

是否启用Proxy-Protocol协议。取值如下：

  • off：关闭。
  • standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至服务器，还需要在服务器上配置Proxy-Protocol。
HealthCheckArray of Struct否--健康检查相关参数，具体请参见下表“ HealthCheck ”。

HealthCheck

名称类型是否必选示例值说明

HealthCheck.Enabled

Boolean

否

true

监听器是否开启健康检查功能。取值如下：

  • true ：开启。
  • false：关闭。

说明

以下参数仅当本参数的值为“true”时有效。

HealthCheck.Type

String

否

TCP

健康检查的类型。取值如下：

  • TCP：通过发送SYN握手报文来检测服务器端口是否可达。
  • HTTP：通过发送请求模拟浏览器访问行为，来检测服务器应用是否健康。

HealthCheck.Port

Integer

否

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.IntervalInteger否2健康检查的时间间隔，取值范围为1 ～ 300秒。

HealthCheck.Timeout

Integer

否

2

健康检查的响应超时时间，取值范围为1 ～ 60秒。
如果后端服务器在指定时间内没有正确响应，则判定为健康检查“异常”。

HealthCheck.HealthyThreshold

Integer

否

3

健康检查的健康阈值，取值范围为2 ～ 10次。
连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。

HealthCheck.UnhealthyThreshold

Integer

否

3

健康检查的不健康阈值，取值范围为2 ～ 10次。
连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。

返回参数

名称类型示例值描述
RequestIdString2024092952539010225146063030****请求ID。

请求示例

GET /?Action=ModifyNLBServerGroupAttributes&Version=2020-04-01&ServerGroupId=rsp-bp1o94dp5i6ea****&ServerGroupName=test HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024092952539010225146063030****",
        "Action": "ModifyNLBServerGroupAttributes",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "2024092952539010225146063030****",
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。