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

调用 CreateNLBServerGroup 接口，创建一个服务器组。

使用说明

  • 每个NLB实例默认最多可创建200个服务器组。
  • 调用一次接口最多可添加20台后端服务器。

请求参数

下表中，Servers.N.a类型参数中的“N”表示后端服务器信息的序号。取值范围为1 ～ 20。多个后端服务器间使用&分隔。

名称类型是否必选示例值说明
ActionString是CreateNLBServerGroup要执行的操作，取值为CreateNLBServerGroup。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
ProjectNameString否default服务器组所属项目的名称。
VpcIdString是vpc-bp1b6c719dfa08ex****服务器组所属私有网络的ID。您可以调用DescribeVpcs接口获取VPC ID。

ServerGroupName

String

否

servergroup01

服务器组的名称。

  • 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。
  • 限制为1 ～ 128个字符。
  • 该参数不传入，则默认为服务器组ID。

Type

String

否

instance

服务器组的类型。

  • instance（默认值）：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。
  • ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。

Protocol

String

是

TCP

NLB转发流量到后端服务器时使用的通信协议。

  • TCP
  • UDP

Description

String

否

servergroup-test

服务器组的描述。

  • 必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）
  • 长度限制为0 ～ 255个字符。
  • 该参数不传入，则默认为空字符串。

Scheduler

String

否

wrr

NLB转发流量时遵循的规则。

  • wrr（默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。
  • wlc：加权最小连接数，在最少连接数的基础上，根据后端服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。
  • sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。

IpAddressVersion

String

否

ipv4

服务器组的IP地址类型。取值如下：

  • ipv4（默认值）：表示该服务器组仅支持添加IPv4类型的后端服务器。
  • ipv6：表示该服务器组仅支持添加IPv6类型的后端服务器。

说明

网络型负载均衡IPv6功能正在邀测中，如需使用，请联系客户经理。

AnyPortEnabled

Boolean

否

true

是否开启全端口转发。取值如下：

  • true：开启。组内后端服务器无需指定端口，NLB默认按照监听端口转发流量至后端服务器。
  • false（默认值）：关闭。

ConnectionDrainEnabled

Boolean

否

true

是否开启连接优雅中断。取值如下：

  • true：开启。
  • false（默认值）：关闭。

ConnectionDrainTimeout

Integer

否

60

连接优雅中断超时时间，取值范围为0～900秒。
参数ConnectionDrainEnabled为“true”时，该参数为必填。

PreserveClientIpEnabled

Boolean

否

true

是否开启源地址保持。

  • true：开启。NLB转发给后端服务器的数据包中会携带客户端源IP地址。
  • false：关闭。

说明

  • 参数Type为“instance”时，该参数默认值为true。
  • 参数Type为“ip”时，该参数默认值为false。

SessionPersistenceEnabled

Boolean

否

true

是否开启会话保持。

  • true：开启。NLB支持基于源IP地址的会话保持。
  • false（默认值）：关闭。
SessionPersistenceTimeoutInteger否10会话保持的超时时间，取值范围为1～3600秒，默认值为1000秒。

ProxyProtocolType

string

否

off

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

  • off（默认值）：关闭。
  • standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器，还需要在后端服务器上配置Proxy-Protocol。

Servers

Array of Struct

否

--

服务器组中待添加后端服务器的信息，具体请参见下方“ Servers ”。

说明

您可以在创建服务器组的同时添加后端服务器，也可以在创建服务器组后，调用AddNLBBackendServers接口添加后端服务器。

HealthCheckStruct否--健康检查相关参数，具体请参见下表“ HealthCheck ”。

Tags.N.Key

String

否

Tags.1.Key=k1&Tags.2.Key=k2

用户标签的标签键。
N：表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签键之间使用&分隔。

  • 长度限制为1～128个字符。
  • 大小写敏感，不能以volc:或sys:的任意大小写组合开头。
  • 不能以空格开头或结尾。
  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

同一资源的标签键不允许重复。

Tags.N.Value

String

否

Tags.1.Value=v1&Tags.2.Value=v2

用户标签的标签值。
N：表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签值之间使用&分隔。每个标签键对应一个标签值。

  • 长度限制为0～255个字符。
  • 大小写敏感，不能以空格开头或结尾。
  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

如果传入该参数，则必须先传入Tags.N.Key。

Servers
下表中，

  • 必选参数表示添加后端服务器时必须传入的参数，若创建服务器组时不添加后端服务器，则下表所有参数均可不传入。
  • Servers.N.a类型参数中的“N”表示后端服务器信息的序号。取值范围为1 ～ 20。多个后端服务器间使用“&”分隔。
名称类型是否必选示例值说明

Servers.N.Type

String

是

Servers.1.Type=ecs&Servers.2.Type=eni

后端服务器的类型。

  • ecs：云服务器实例。
  • eni：已挂载至云后端服务器的辅助网卡。
  • ip：IP地址。

说明

服务器组类型为“instance”时，该参数可传入“ecs”或“eni”；服务器组类型为“ip”时，该参数可传入“ip”。

Servers.N.InstanceId

string

是

Servers.1.InstanceId=eni-erfcdhsky67jkll****&Servers.2.InstanceId=eni-wyshklniehsn3****

待添加的后端服务器。

  • 参数Servers.N.Type为“ecs”时，传入云服务器实例的ID。您可以调用DescribeInstances接口获取云服务器实例ID。
  • 参数Servers.N.Type为“eni”时，传入辅助网卡的ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。
  • 参数Servers.N.Type为“ip”时，传入后端服务器的 IP 地址。支持的IP地址段为10.0.0.0/8、172.16.0.0/12、192.168.0.0/16。

Servers.N.Ip

String

是

Servers.1.Ip=192.XX.XX.2&Servers.2.Ip=192.XX.XX.3

后端服务器的私网IP地址。

Servers.N.Port

Integer

否

Servers.1.Port=22&Servers.2.Port=80

后端服务器处理请求的端口，取值范围为 1～65535。

  • 参数AnyPortEnabled为“false”，即服务器组未开启全端口转发时，该参数为必填。
  • 参数AnyPortEnabled为“true”，即服务器组开启全端口转发时，该参数默认为0。

Servers.N.Weight

Integer

否

Servers.1.Weight=100&Servers.2.Weight=100

后端服务器的权重，取值范围为 0 ～ 100。

  • 权重为0，表示NLB不会将请求转发给该后端服务器。
  • 该参数不传入，则默认为0。

Servers.N.ZoneId

String

否

Servers.1.ZoneId=cn-guangzhou-a&Servers.2.ZoneId=cn-guangzhou-b

后端服务器接收来自哪些可用区的访问流量。
指定多个可用区时，无论NLB是否开启跨可用区转发，该后端服务器均可以接收来自所有指定可用区的访问流量。

Servers.N.Description

String

否

Servers.1.Description=ecs1&Servers.2.Description=eni1

后端服务器的描述。

  • 必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为1 ～ 255个字符。
  • 该参数不传入，则默认为空字符串。

HealthCheck

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

HealthCheck.Enabled

Boolean

否

true

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

  • true（默认值）：开启。
  • false：关闭。

说明

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

HealthCheck.Type

String

否

TCP

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

  • TCP（默认值）
  • 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秒，默认值为3秒。

HealthCheck.Timeout

Integer

否

2

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

HealthCheck.HealthyThreshold

Integer

否

3

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

HealthCheck.UnhealthyThreshold

Integer

否

3

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

返回参数

名称类型示例值描述
RequestIdString2024092952539010225146063030****请求ID。
ServerGroupIdStringrsp-bp1o94dp5i6ea****服务器组ID。

请求示例

GET /?Action=CreateNLBServerGroup&Version=2020-04-01&VpcId=vpc-bp1b6c719dfa08ex****&ServerGroupName=test&Protocol=TCP HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

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

错误码

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