调用 CreateServerGroup 接口创建一个后端服务器组。 ## 使用说明 * 每个CLB实例默认最多可创建200个后端服务器组。 * 调用一次接口最多可添加20台后端服务器。 ## 调试 ## 请求参数 |**名称** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |CreateServerGroup |要执行的操作，取值为CreateServerGroup。 | |Version |String |是 |2020\-04\-01 |API版本信息，当前版本为：2020\-04\-01。 | |LoadBalancerId |String |是 |clb\-bp1b6c719dfa08ex\*\*\*\* |负载均衡实例的ID。|\ | | | | |您可以调用[DescribeLoadBalancers](https://www.volcengine.com/docs/6406/71772)接口，查询负载均衡实例ID。 | |ServerGroupName |String |否 |myservergroup |后端服务器组名称。|\ | | | | ||\ | | | | |* 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（\-）。|\ | | | | |* 限制为1 ～ 128个字符。|\ | | | | |* 不填默认为后端服务器组ID。 | |Description |String |否 |This is a servergroup. |后端服务器组的描述。|\ | | | | ||\ | | | | |* 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（\-）、中文逗号（，）、中文句号（。）。|\ | | | | |* 长度限制为0 ～ 255个字符。|\ | | | | |* 不填则默认为空字符串。 | |AddressIpVersion |String |否 |ipv4 |后端服务器组的IP地址类型。取值如下：|\ | | | | ||\ | | | | |* ipv4（默认值）：表示该后端服务器组IPv4类型。|\ | | | | |* ipv6：表示该后端服务器组为IPv6类型。|\ | | | | ||\ | | | | |:::tip|\ | | | | |支持IPv6后端的功能正在邀测中，暂仅支持完成 [企业认证](https://www.volcengine.com/docs/6261/64937) 的账号申请试用，如需试用，请联系客户经理。|\ | | | | ||\ | | | | |:::| |Type |String |否 |instance |后端服务器组的类型。取值如下：|\ | | | | ||\ | | | | |* instance（默认值）：云服务器实例。|\ | | | | |* ip：IP地址。|\ | | | | ||\ | | | | |> IP地址作为后端服务器的功能正在邀测中，暂仅支持完成 [企业认证](https://www.volcengine.com/docs/6261/64937) 的账号申请试用，如需试用，请联系客户经理。 | |Servers.N.Type |String |否 |Servers.1.Type=ecs&Servers.2.Type=eni |后端服务器的类型。|\ | | | | ||\ | | | | |* 当参数`Type`取instance时，取值如下：|\ | | | | | * ecs：云服务器实例。|\ | | | | | * eni：网卡。|\ | | | | |* 当参数`Type`取ip时，本参数取值为ip。|\ | | | | |* 参数 \- N：表示后端服务器的序号。取值范围：1 ～ 20。 | |Servers.N.InstanceId |String |否 |Servers.1.InstanceId=i\-3tkuehz8oa3vj0wz\*\*\*\*&Servers.2.InstanceId=eni\-2feo5qd3orri85oxruvxv\*\*\*\* |后端服务器。|\ | | | | ||\ | | | | |* 取值情况如下：|\ | | | | | * 当`Servers.N.Type` 取ecs时，传云服务器实例的ID。您可以调用[DescribeInstances](https://www.volcengine.com/docs/6396/70466)接口，查询云服务器实例ID。|\ | | | | | * 当`Servers.N.Type` 取eni时，传已挂载至云服务器的辅助网卡的ID。您可以调用[DescribeNetworkInterfaces](https://www.volcengine.com/docs/6401/70761)接口，查询网卡ID。|\ | | | | | * 当`Servers.N.Type` 取ip时，传IP地址作为后端服务器。|\ | | | | |* 参数 \- N：表示后端服务器的序号。取值范围：1 ～ 20。|\ | | | | |* 多个后端服务器ID间使用“&”分隔。 | |Servers.N.Weight |Integer |否 |Servers.1.Weight=100&Servers.2.Weight=100 |后端服务器的权重，取值范围为0 ～ 100。|\ | | | | ||\ | | | | |* 不填则默认为0。0表示不会将请求转发给该后端服务器。|\ | | | | |* 参数 \- N：表示后端服务器的序号。取值范围：1 ～ 20。 | |Servers.N.Ip |String |否 |Servers.1.Ip=192.XX.XX.2&Servers.2.Ip=192.XX.XX.3 |后端服务器的私网IP地址。|\ | | | | ||\ | | | | |* 您可以调用[DescribeInstances](https://www.volcengine.com/docs/6396/70466)接口获取“ecs”类型后端服务器的私网IP地址，调用[DescribeNetworkInterfaces](https://www.volcengine.com/docs/6401/70761)接口获取“eni”类型后端服务器的私网IP地址。|\ | | | | |* 参数 \- N：表示后端服务器的序号。取值范围：1 ～ 20。|\ | | | | |* 多个后端服务器IP之间使用“&”分隔。 | |AnyPortEnabled |String |否 |on |后端服务器组是否开启全端口转发。|\ | | | | ||\ | | | | |* on：开启。|\ | | | | |* off（默认值）：关闭。|\ | | | | ||\ | | | | |:::tip|\ | | | | |该参数正在邀测中，暂仅支持完成 [企业认证](https://www.volcengine.com/docs/6261/64937) 的账号申请试用，如需试用，请联系客户经理。|\ | | | | ||\ | | | | |:::| |Servers.N.Port |Integer |否 |Servers.1.Port=88&Servers.2.Port=443 |后端服务器接收请求的端口号，取值范围为1～65535。|\ | | | | |参数 \- N：表示后端服务器的序号。取值范围：1 ～ 20。|\ | | | | |:::tip|\ | | | | ||\ | | | | |* 参数AnyPortEnabled为“off”，且需要同时添加后端服务器时，该参数必须传入；参数AnyPortEnabled为“on”时，该参数默认为0。|\ | | | | |* 如果您不希望在创建后端服务器组的同时添加后端服务器，那么可以不传入该参数。|\ | | | | |:::|\ | | | | |* 多个后端服务器IP之间使用“&”分隔。 | |Servers.N.Description |String |否 |Servers.1.Description=ecs1&Servers.2.Description=eni1 |后端服务器的描述。|\ | | | | ||\ | | | | |* 参数 \- N：表示后端服务器的序号。取值范围：1 ～ 20。|\ | | | | |* 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（\-）、中文逗号（，）、中文句号（。）。|\ | | | | |* 长度限制为0 ～ 255个字符。|\ | | | | |* 不填则默认为空字符串。 | |Tags.N.Key |String |否 |Tags.1.Key=key1&Tags.2.Key=key2 |用户标签的标签键。|\ | | | | ||\ | | | | |* 参数 \- N：表示标签键的序号，取值范围：1～20。|\ | | | | |* 多个标签键之间用&分隔。|\ | | | | |* 不能以 `volc:`或`sys:`开头，包括任意大小写形式。|\ | | | | |* 长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（\-）和@（@）。|\ | | | | |* 若标签键开头或结尾存在空格，系统会自动为其去除。|\ | | | | ||\ | | | | |:::tip|\ | | | | |同一资源的标签键不允许重复。|\ | | | | ||\ | | | | |:::| |Tags.N.Value |String |否 |Tags.1.Value=value1&Tags.2.Value=value2 |用户标签的标签值。|\ | | | | ||\ | | | | |* 参数 \- N：表示标签值的序号，取值范围：1～20。|\ | | | | |* 多个标签值之间用&分隔。|\ | | | | |* 长度取值范围为0～256字符，不填默认为空。|\ | | | | |* 允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（\-）和@（@）。|\ | | | | |* 大小写敏感。|\ | | | | |* 若标签值开头或结尾存在空格，系统会自动为其去除。|\ | | | | ||\ | | | | |:::tip|\ | | | | |若传入该参数，则必须先传入`Tags.N.Key`。|\ | | | | ||\ | | | | |:::| ## 返回参数 |名称 |类型 |示例值 |描述 | |---|---|---|---| |RequestId |String |20210811152539010225146063030\*\*\*\* |请求ID。 | |ServerGroupId |String |rsp\-bp1o94dp5i6ea\*\*\*\* |后端服务器组ID。 | ## 请求示例 ```json GET /?Action=CreateServerGroup&Version=2020-04-01&LoadBalancerId=clb-bp1b6c719dfa08ex****&ServerGroupName=myservergroup&Servers.1.InstanceId=i-3tkuehz8oa3vj0wz****&Servers.1.Ip=192.XX.XX.2&Servers.1.Port=88&Servers.1.Type=ecs&Servers.1.Weight=100 HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing Service: clb ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "20210811152539010225146063030****", "Action": "CreateServerGroup", "Version": "2020-04-01", "Service": "clb", "Region": "cn-beijing" }, "Result": { "RequestId": "20210811152539010225146063030****", "ServerGroupId": "rsp-bp1o94dp5i6ea****" } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6406/71761)文档。 |

HttpCode

|错误码 |错误信息 |描述 |\ |---|---|---|---| | | | | | |

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

400

|QuotaExceed.ServerGroupNumberEachInstance |You've reached the limit on the number of ServerGroups that you can create. |已达到可创建后端服务器组的数量的配额上限{_tag_}。 |\ | | | | | |

400

|QuotaExceed.ServerNumberEachInstance |You've reached the limit on the number of Servers that you can create. |已达到可创建后端服务器的数量的配额上限{_tag_}。 |\ | | | | | |

400

403

403

403

404

404

404

404

404

409

412

412

412