CreateServerGroup - 创建服务器组

创建负载均衡服务器组。

接口说明

CreateServerGroup 接口属于异步接口,即系统返回一个请求 ID,但该服务器组尚未创建成功,系统后台的创建任务仍在进行。您可以调用 ListServerGroups 查询服务器组的创建状态:

  • 当服务器组处于 Creating 状态时,表示服务器组正在创建中。
  • 当服务器组处于 Available 状态时,表示服务器组创建成功。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gwlb:CreateServerGroupcreate
  • ServerGroup
    acs:gwlb:{#regionId}:{#accountId}:servergroup/*
  • VPC
    acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

请求参数

名称类型必填描述示例值
ServerGroupTypestring

服务器组类型。取值:

  • Instance(默认值):服务器类型,该类型服务器组支持添加 EcsEniEci 类型实例。

  • Ip:IP 地址类型,该类型服务器组支持直接添加 IP 地址类型的后端服务器。

Instance
ServerGroupNamestring

服务器组名称。

长度为 2~128 个字符,必须以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

testServerGroupName
Protocolstring

后端转发协议。取值:

  • GENEVE(默认值)。
GENEVE
Schedulerstring

调度算法。取值:

  • 5TCH(默认值):五元组哈希,基于五元组(源 IP、目的 IP、源端口、目的端口和协议)的一致性哈希,相同的流会调度到相同的后端服务器。

  • 3TCH:三元组哈希,基于三元组(源 IP、目的 IP 和协议)的一致性哈希,相同的流会调度到相同的后端服务器。

  • 2TCH:二元组哈希,基于二元组(源 IP 和目的 IP)的一致性哈希,相同的流会调度到相同的后端服务器。

5TCH
VpcIdstring

VPC 实例 ID。

说明 如果 ServerGroupType 取值为 Instance 时,只有该 VPC 下的服务器可以加入到该服务器组。
vpc-bp15zckdt37pq72zv****
ResourceGroupIdstring

资源组 ID。

rg-atstuj3rtop****
ConnectionDrainConfigobject

连接优雅中断相关配置。

ConnectionDrainEnabledboolean

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

  • true:开启。

  • false(默认值):关闭。

false
ConnectionDrainTimeoutinteger

连接优雅中断超时时间。

单位:秒。

取值范围:1~3600

默认值:300

300
HealthCheckConfigobject

健康检查相关配置。

HealthCheckConnectPortinteger

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

取值范围: 1~65535

默认值:80

80
HealthCheckConnectTimeoutinteger

健康检查响应的最大超时时间。

单位:秒。

取值范围:1~300

默认值:5

5
HealthCheckDomainstring

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

  • $SERVER_IP(默认值):使用后端服务器内网 IP。

  • domain:指定特定域名。长度限制 1~80 个字符,只能使用大小写字母、数字、短划线(-)、半角句号(.)。

说明 HealthCheckProtocolHTTP 时,该参数生效。
$SERVER_IP
HealthCheckEnabledboolean

是否开启健康检查,取值:

  • true(默认值):开启。

  • false:关闭。

true
HealthCheckHttpCodearray

健康状态返回码列表。

HealthCheckHttpCodestring

健康状态返回码,多个状态码用半角逗号(,)分隔。 取值:

  • http_2xx
  • http_3xx
  • http_4xx
  • http_5xx

默认值:http_2xx

说明 HealthCheckProtocolHTTP 时,该参数生效。
http_2xx
HealthCheckIntervalinteger

健康检查的时间间隔。

单位:秒。

取值范围:1~50

默认值:10

10
HealthCheckPathstring

健康检查路径。

长度为 1~80 个字符,只能使用大小写英文字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、半角问号(?)、井号(#)和 and(&)以及扩展字符集_;~!()*[]@$^:',+=

必须以正斜线(/)开头。

说明 HealthCheckProtocolHTTP 时,该参数生效。
/test/index.html
HealthCheckProtocolstring

健康检查协议,取值:

  • TCP(默认值):通过发送 SYN 握手报文来检测服务器端口是否存活。

  • HTTP:通过发送 GET 请求模拟浏览器的访问行为来检查服务器应用是否健康。

TCP
HealthyThresholdinteger

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

取值范围:2~10

默认值:2

2
UnhealthyThresholdinteger

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

取值范围:2~10

默认值:2

2
Tagarray<object>

标签列表。

一次调用最多支持 20 个标签。

TagModelobject

标签。

Keystring

标签键。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

testTagKey
Valuestring

标签值。最多支持 256 个字符,不能包含http://https://

testTagValue
DryRunboolean

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

  • true:发送检查请求,不会创建服务器组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
False
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-42665544****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupIdstring

服务器组 ID。

sgp-atstuj3rtoptyui****

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.HealthCheckProtocolThe param of %s is illegal.健康检查协议非法,请检查输入参数。
400QuotaExceeded.ServerGroupsNumThe quota of %s is exceeded for resource %s, usage %s/%s.配额gwlb_quota_servergroups_num已超额度限制。
400DuplicatedParam.TagKeyThe param of %s is duplicated.标签键参数重复
400IllegalParam.TagKeyThe param of %s is illegal.标签键参数值不合法
404ResourceNotFound.VpcThe specified resource of %s is not found.指定的专有网络资源不存在。

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