调用CreateServerGroup接口为网络型负载均衡创建服务器组。

  • protocol字段是指转发到后端服务器使用的通信协议。
  • 对于网络型负载均衡实例，只支持挂载后端协议为TCP、UDP、TCPSSL类型的后端服务器组。
  • CreateServerGroup接口属于异步接口，即系统返回一个请求ID，但该网络型负载均衡的服务器组尚未创建成功，系统后台的创建任务仍在进行。您可以调用GetJobStatus查询服务器组的创建状态：
    • 当任务状态处于Succeeded时，表示服务器组创建成功。
    • 当任务状态处于Processing时，表示服务器组正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateServerGroup

系统规定参数。取值：CreateServerGroup。

ServerGroupType String 否 Instance

服务器组类型。取值：

  • Instance（默认值）：服务器类型，该类型服务器组支持添加Ecs、Ens、Eci类型实例。
  • Ip：IP地址类型，该类型服务器组支持直接添加IP地址类型的后端服务器。
ServerGroupName String 是 NLB_ServerGroup

服务器组名称。

长度为2~128个字符，必须以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。
AddressIPVersion String 否 ipv4

协议版本。取值：

  • ipv4（默认值）：IPv4类型。
  • DualStack：双栈类型。
Protocol String 否 TCP

后端转发协议，取值：

  • TCP（默认值）
  • UDP
  • TCPSSL
VpcId String 是 vpc-bp15zckdt37pq72zv****

服务器组所在VPC的ID。

说明 如果ServerGroupType取值为Instance时，只有该VPC下的服务器可以加入到该服务器组。
AnyPortEnabled Boolean 否 false

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

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

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

  • true：开启。
  • false（默认值）：关闭。
ConnectionDrainTimeout Integer 否 10

设置连接优雅中断超时时间。单位：秒。

取值范围：10~900。

Scheduler String 否 Wrr

调度算法。取值：

  • Wrr（默认值）：加权轮询，权重值越高的后端服务器，被轮询到的概率也越高。
  • rr：轮询，按照访问顺序依次将外部请求分发到后端服务器。
  • sch：源IP哈希：相同的源地址会调度到相同的后端服务器。
  • tch：四元组哈希，基于四元组（源IP、目的IP、源端口和目的端口）的一致性哈希，相同的流会调度到相同的后端服务器。
  • qch：QUIC ID哈希，支持将同一个QUIC ID的请求哈希到同一台后端服务器上。
PreserveClientIpEnabled Boolean 否 false

是否开启客户端地址保持功能。取值：

  • true：开启。
  • false（默认值）：关闭。
HealthCheckConfig.HealthCheckEnabled Boolean 否 true

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

  • true（默认值）：开启。
  • false：关闭。
HealthCheckConfig.HealthCheckType String 否 TCP

健康检查协议。取值：TCP（默认值）或HTTP。

HealthCheckConfig.HealthCheckConnectPort Integer 否 0

健康检查的后端服务器的端口。

取值范围： 0~65535。

默认值：0，表示使用后端服务器的端口进行健康检查。

HealthCheckConfig.HealthyThreshold Integer 否 2

健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。

取值范围：2~10。

默认值：2。

HealthCheckConfig.UnhealthyThreshold Integer 否 2

健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。

取值范围：2~10。

默认值：2。

HealthCheckConfig.HealthCheckConnectTimeout Integer 否 5

健康检查响应的最大超时时间。单位：秒。

取值范围：1~300。

默认值：5。

HealthCheckConfig.HealthCheckInterval Integer 否 10

健康检查的时间间隔。单位：秒。

取值范围：5~50。

默认值：10。

HealthCheckConfig.HealthCheckDomain String 否 $SERVER_IP

用于健康检查的域名。取值：

  • $SERVER_IP：使用后端服务器内网IP。
  • domain：指定特定域名。长度限制1~80个字符，只能使用小写字母、数字、短划线（-）、半角句号（.）。
说明 仅HealthCheckType为HTTP时，该参数生效。
HealthCheckConfig.HealthCheckUrl String 否 /test/index.html

健康检查路径。

长度为1~80个字符，只能使用字母、数字、字符-/.%?#&=以及扩展字符_;~!（)*[]@$^:',+。 必须以正斜线（/）开头。

说明 仅HealthCheckType为HTTP时，该参数生效。
HealthCheckConfig.HealthCheckHttpCode.N String 否 http_2xx

健康状态返回码，多个状态码用半角逗号（,）分隔。

取值：http_2xx（默认值）、http_3xx、http_4xx和http_5xx。

说明 仅HealthCheckType为HTTP时，该参数生效。
HealthCheckConfig.HttpCheckMethod String 否 GET

健康检查方法，取值：GET（默认值）或HEAD。

说明 仅HealthCheckType为HTTP时，该参数生效。
ResourceGroupId String 否 rg-atstuj3rtop****

服务器组所属的资源组ID。
DryRun Boolean 否 true

是否只预检此次请求。取值：

  • true：发送检查请求，不会创建服务器组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
ClientToken String 否 123e4567-e89b-12d3-a456-426655440000

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId String 否 cn-hangzhou

网络型负载均衡实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

请求ID。
ServerGroupId String sgp-atstuj3rtoptyui****

服务器组ID。
JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

异步任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateServerGroup
&ServerGroupType=Instance
&ServerGroupName=NLB_ServerGroup
&AddressIPVersion=ipv4
&Protocol=TCP
&VpcId=vpc-bp15zckdt37pq72zv****
&AnyPortEnabled=false
&ConnectionDrainEnabled=false
&ConnectionDrainTimeout=10
&Scheduler=Wrr
&PreserveClientIpEnabled=false
&HealthCheckConfig={"HealthCheckEnabled":true,"HealthCheckType":"TCP","HealthCheckConnectPort":0,"HealthyThreshold":2,"UnhealthyThreshold":2,"HealthCheckConnectTimeout":5,"HealthCheckInterval":10,"HealthCheckDomain":"$SERVER_IP","HealthCheckUrl":"/test/index.html","HealthCheckHttpCode":["http_2xx"],"HttpCheckMethod":"GET"}
&ResourceGroupId=rg-atstuj3rtop****
&DryRun=true
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateServerGroupResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <ServerGroupId>sgp-atstuj3rtoptyui****</ServerGroupId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</CreateServerGroupResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId" : "sgp-atstuj3rtoptyui****",
  "JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

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