在指定地域创建服务器组。
接口说明
-
protocol字段是指转发到后端服务器使用的通信协议。
-
对于网络型负载均衡实例，只支持挂载后端协议为TCP、UDP、TCPSSL类型的后端服务器组。
-
CreateServerGroup接口属于异步接口，即系统返回一个请求ID，但该网络型负载均衡的服务器组尚未创建成功，系统后台的创建任务仍在进行。您可以调用GetJobStatus查询服务器组的创建状态：
- 当任务状态处于Succeeded时，表示服务器组创建成功。
- 当任务状态处于Processing时，表示服务器组正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nlb:CreateServerGroup | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ServerGroupType | string | 否 | 服务器组类型。取值：
| Instance |
| ServerGroupName | string | 是 | 服务器组名称。 长度为2~128个字符，必须以大小写字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。 | NLB_ServerGroup |
| AddressIPVersion | string | 否 | 协议版本。取值：
| ipv4 |
| Protocol | string | 否 | 后端转发协议，取值：
| TCP |
| VpcId | string | 是 | 服务器组所在VPC的ID。 说明
如果ServerGroupType取值为Instance时，只有该VPC下的服务器可以加入到该服务器组。
| vpc-bp15zckdt37pq72zv**** |
| AnyPortEnabled | boolean | 否 | 是否开启全端口转发。取值：
| false |
| ConnectionDrainEnabled | boolean | 否 | 是否开启连接优雅中断。取值：
| false |
| ConnectionDrainTimeout | integer | 否 | 设置连接优雅中断超时时间。单位：秒。 取值范围：0~900。 | 10 |
| Scheduler | string | 否 | 调度算法。取值：
| Wrr |
| PreserveClientIpEnabled | boolean | 否 | 是否开启客户端地址保持功能。取值：
| false |
| HealthCheckConfig | object | 否 | 健康检查相关配置。 | |
| HealthCheckEnabled | boolean | 否 | 是否开启健康检查，取值：
| true |
| HealthCheckType | string | 否 | 健康检查协议。取值：TCP（默认值）或HTTP。 | TCP |
| HealthCheckConnectPort | integer | 否 | 健康检查的后端服务器的端口。 取值范围： 0~65535。 默认值：0，表示使用后端服务器的端口进行健康检查。 | 0 |
| HealthyThreshold | integer | 否 | 健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。 取值范围：2~10。 默认值：2。 | 2 |
| UnhealthyThreshold | integer | 否 | 健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。 取值范围：2~10。 默认值：2。 | 2 |
| HealthCheckConnectTimeout | integer | 否 | 健康检查响应的最大超时时间。单位：秒。 取值范围：1~300。 默认值：5。 | 5 |
| HealthCheckInterval | integer | 否 | 健康检查的时间间隔。单位：秒。 取值范围：5~50。 默认值：10。 | 10 |
| HealthCheckDomain | string | 否 | 用于健康检查的域名。取值：
说明
仅HealthCheckType为HTTP时，该参数生效。
| $SERVER_IP |
| HealthCheckUrl | string | 否 | 健康检查路径。 长度为1~80个字符，只能使用大小写英文字母、数字、字符 说明
仅HealthCheckType为HTTP时，该参数生效。
| /test/index.html |
| HealthCheckHttpCode | array | 否 | 健康状态返回码，多个状态码用半角逗号（,）分隔。 取值：http_2xx（默认值）、http_3xx、http_4xx和http_5xx。 说明
仅HealthCheckType为HTTP时，该参数生效。
| |
| string | 否 | 健康状态返回码，多个状态码用半角逗号（,）分隔。 取值：http_2xx（默认值）、http_3xx、http_4xx和http_5xx。 说明
仅HealthCheckType为HTTP时，该参数生效。
| http_2xx | |
| HttpCheckMethod | string | 否 | 健康检查方法，取值：GET（默认值）或HEAD。 说明
仅HealthCheckType为HTTP时，该参数生效。
| GET |
| ResourceGroupId | string | 否 | 服务器组所属的资源组ID。 | rg-atstuj3rtop**** |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| true |
| ClientToken | string | 否 | 客户端Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明
若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
| RegionId | string | 否 | 网络型负载均衡实例所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 | cn-hangzhou |
| Tag | object [] | 否 | 标签列表。 | |
| Key | string | 否 | 标签键。最多支持128个字符，不能以 一次调用最多支持添加20个标签。 | env |
| Value | string | 否 | 标签值。最多支持128个字符，不能以 一次调用最多支持添加20个标签。 | product |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
"ServerGroupId": "sgp-atstuj3rtoptyui****",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfig | The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal. | 服务器组的配置与健康检查设置冲突。请检查配置参数。 |
| 400 | IllegalParamFormat.ParseCreateRsPoolRequestFailed | The param format of CreateRsPoolRequest is illegal. | CreateRsPoolRequestFailed的参数格式不合法，请参考OpenAPI文档检查请求参数。 |
| 400 | IllegalParam.PreserveClientIpSwitch | The param of PreserveClientIpSwitch is illegal. | 参数PreserveClientIpSwitch非法。请检查参数PreserveClientIpSwitch的输入值。 |
| 400 | OperationDenied.VpcNotSupportIpv6 | The operation is not allowed because of VpcNotSupportIpv6. | 使用的VPC不支持Ipv6。 |
| 400 | IlleagalParam.healthCheckUrl | The param of healthCheckUrl in healthCheckConfig is illegal. | 健康检查设置中使用的健康检查的url不合法。 |
| 400 | IllegalParam.healthCheckDomain | The parameter of healthCheckConfig.healthCheckDomain is illegal. | 健康检查配置中的healthCheckDomain非法，请检查输入参数。 |
| 400 | OperationDenied.UidNotAllowQuic29 | The operation is not allowed because of uid not allow quic29 version. | 用户ID不支持Quic29，请联系客户经理加白。 |
| 400 | IlleagalParam.healthCheckUrl | The parameter of healthCheckUrl in healthCheckConfig is illegal. | 健康检查设置中使用的健康检查的URL不合法。 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因为账号没有权限，所以鉴权失败。 |
| 404 | ResourceNotFound.Vpc | The specified resource of Vpc is not found. | 找不到指定的VPC资源，请检查输入参数。 |
| 404 | ResourceNotFound.ResourceGroup | The param of resourceGroup not existed. | 资源组不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-10-07 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
| 2023-09-27 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
| 2023-09-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
| 2023-09-18 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
| 2023-09-05 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
| 2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
| 2023-06-30 | API 内部配置变更，不影响调用 | 看变更集 | ||||||||||||
| ||||||||||||||
| 2023-06-29 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|
