CreateServerGroup - 创建服务器组

更新时间: 2023-10-08 19:16:44

在指定地域创建服务器组。

接口说明

  • protocol字段是指转发到后端服务器使用的通信协议。

  • 对于网络型负载均衡实例,只支持挂载后端协议为TCP、UDP、TCPSSL类型的后端服务器组。

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

    • 当任务状态处于Succeeded时,表示服务器组创建成功。
    • 当任务状态处于Processing时,表示服务器组正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。

调试

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

调试

授权信息

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

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

请求参数

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

服务器组类型。取值:

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

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

Instance
ServerGroupNamestring

服务器组名称。

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

NLB_ServerGroup
AddressIPVersionstring

协议版本。取值:

  • ipv4(默认值):IPv4类型。

  • DualStack:双栈类型。

ipv4
Protocolstring

后端转发协议,取值:

  • TCP(默认值)
  • UDP
  • TCPSSL
TCP
VpcIdstring

服务器组所在VPC的ID。

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

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

  • true:开启。

  • false(默认值):关闭。

false
ConnectionDrainEnabledboolean

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

  • true:开启。

  • false(默认值):关闭。

false
ConnectionDrainTimeoutinteger

设置连接优雅中断超时时间。单位:秒。 取值范围:0~900

10
Schedulerstring

调度算法。取值:

  • Wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的概率也越高。

  • rr:轮询,按照访问顺序依次将外部请求分发到后端服务器。

  • sch:源IP哈希:相同的源地址会调度到相同的后端服务器。

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

  • qch:QUIC ID哈希,支持将同一个QUIC ID的请求哈希到同一台后端服务器上。

Wrr
PreserveClientIpEnabledboolean

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

  • true:开启。
  • false(默认值):关闭。
false
HealthCheckConfigobject

健康检查相关配置。

HealthCheckEnabledboolean

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

  • true(默认值):开启。

  • false:关闭。

true
HealthCheckTypestring

健康检查协议。取值:TCP(默认值)或HTTP

TCP
HealthCheckConnectPortinteger

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

取值范围: 0~65535

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

0
HealthyThresholdinteger

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

取值范围:2~10

默认值:2

2
UnhealthyThresholdinteger

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

取值范围:2~10

默认值:2

2
HealthCheckConnectTimeoutinteger

健康检查响应的最大超时时间。单位:秒。 取值范围:1~300。 默认值:5

5
HealthCheckIntervalinteger

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

取值范围:5~50

默认值:10

10
HealthCheckDomainstring

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

  • $SERVER_IP:使用后端服务器内网IP。

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

说明 HealthCheckTypeHTTP时,该参数生效。
$SERVER_IP
HealthCheckUrlstring

健康检查路径。

长度为1~80个字符,只能使用大小写英文字母、数字、字符-/.%?#&。 必须以正斜线(/)开头。

说明 HealthCheckTypeHTTP时,该参数生效。
/test/index.html
HealthCheckHttpCodearray

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

说明 HealthCheckTypeHTTP时,该参数生效。
string

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

说明 HealthCheckTypeHTTP时,该参数生效。
http_2xx
HttpCheckMethodstring

健康检查方法,取值:GET(默认值)或HEAD

说明 HealthCheckTypeHTTP时,该参数生效。
GET
ResourceGroupIdstring

服务器组所属的资源组ID。

rg-atstuj3rtop****
DryRunboolean

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

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

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

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

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

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

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

cn-hangzhou
Tagobject []

标签列表。

Keystring

标签键。最多支持128个字符,不能以aliyunacs:开头,不能包含http://https://

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

env
Valuestring

标签值。最多支持128个字符,不能以aliyunacs:开头,不能包含http://https://

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

product

返回参数

名称类型描述示例值
object

创建服务器组。

RequestIdstring

请求ID。

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

服务器组ID。

sgp-atstuj3rtoptyui****
JobIdstring

异步任务ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfigThe param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal.服务器组的配置与健康检查设置冲突。请检查配置参数。
400IllegalParamFormat.ParseCreateRsPoolRequestFailedThe param format of CreateRsPoolRequest is illegal.CreateRsPoolRequestFailed的参数格式不合法,请参考OpenAPI文档检查请求参数。
400IllegalParam.PreserveClientIpSwitchThe param of PreserveClientIpSwitch is illegal.参数PreserveClientIpSwitch非法。请检查参数PreserveClientIpSwitch的输入值。
400OperationDenied.VpcNotSupportIpv6The operation is not allowed because of VpcNotSupportIpv6.使用的VPC不支持Ipv6。
400IlleagalParam.healthCheckUrlThe param of healthCheckUrl in healthCheckConfig is illegal.健康检查设置中使用的健康检查的url不合法。
400IllegalParam.healthCheckDomainThe parameter of healthCheckConfig.healthCheckDomain is illegal.健康检查配置中的healthCheckDomain非法,请检查输入参数。
400OperationDenied.UidNotAllowQuic29The operation is not allowed because of uid not allow quic29 version.用户ID不支持Quic29,请联系客户经理加白。
400IlleagalParam.healthCheckUrlThe parameter of healthCheckUrl in healthCheckConfig is illegal.健康检查设置中使用的健康检查的URL不合法。
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限,所以鉴权失败。
404ResourceNotFound.VpcThe specified resource of Vpc is not found.找不到指定的VPC资源,请检查输入参数。
404ResourceNotFound.ResourceGroupThe param of resourceGroup not existed.资源组不存在。

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

变更历史

变更时间变更内容概要操作
2023-10-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-09-27OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    删除入参:QuicVersion
2023-09-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 404 变更
    删除错误码:403
2023-09-18OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:QuicVersion
2023-09-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    错误码 404 变更
2023-08-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:403
    新增错误码:404
2023-06-30API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-06-29OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
阿里云首页 负载均衡 相关技术圈