You need to enable JavaScript to run this app.
导航
负载均衡
  • 文档首页
    • /
  • 负载均衡

CreateServerGroup

最近更新时间：2024.04.11 15:34:05

首次发布时间：2021.08.31 10:37:27

我的收藏

调用 CreateServerGroup 接口创建一个后端服务器组。

使用说明

  • 每个CLB实例默认最多可创建200个后端服务器组。
  • 调用一次接口最多可添加20台后端服务器。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表中，Tags.N.a类型参数中的“N”表示标签信息的序号，需按照数字顺序从1开始填写，取值范围为1～20。多个标签之间使用&分隔。

名称类型是否必填示例值
描述
ActionString是CreateServerGroup要执行的操作，取值为CreateServerGroup。
VersionString是2020-04-01API版本信息，当前版本为：2020-04-01。
LoadBalancerIdString是clb-bp1b6c719dfa08ex****后端服务器组所属的负载均衡实例的ID。您可以调用DescribeLoadBalancers接口获取负载均衡实例ID。

ServerGroupName

String

否

myservergroup

后端服务器组名称。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。
  • 限制为1 ～ 128个字符。
  • 不传入该参数或该参数不传入数值时，默认为后端服务器组ID。

Description

String

否

This is a servergroup.

后端服务器组的描述。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ～ 255个字符。
  • 不传入该参数或该参数不传入数值时，默认为空字符串。

Type

String

否

instance

后端服务器组的类型。取值如下：

  • instance（默认值）：表示该后端服务器组只能添加的后端服务器类型为普通实例。
  • ip：表示该后端服务器组只能添加后端服务器类型为IP地址。

负载均衡支持添加IP类型后端服务器的功能正在邀测中，如需使用，请联系客户经理。

Tags.N.Key

String

否

Tags.1.Key=k1&Tags.2.Key=k2

标签的标签键。

  • 长度限制为1～128个字符。
  • 大小写敏感，不能以volc:或sys:的任意大小写组合开头。
  • 不能以空格开头或结尾。
  • 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

同一资源的标签键不允许重复。如果传入的Tags.N.Key与已有标签的标签键重复，则后添加的标签会覆盖原有标签。

说明

Tags.N.Value

String

否

Tags.1.Value=v1&Tags.2.Value=v2

标签的标签值。

  • 长度限制为1～256个字符。
  • 大小写敏感，不能以空格开头或结尾。
  • 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

如果传入该参数，则必须先传入Tags.N.Key。

Servers.N.InstanceId

String

是

Servers.1.InstanceId=i-3tkuehz8oa3vj0wz****&Servers.2.InstanceId=eni-2feo5qd3orri85oxruvxv****

云服务器实例ID或已绑定云服务器实例的网卡ID。您可以调用DescribeInstances接口获取云服务实例ID，调用DescribeNetworkInterfaces接口获取网卡ID。

  • 参数 - N：表示后端服务器的序号。取值范围为1 ～ 20。
  • 参数Type取值为“ip”时，该参数填入后端服务器的IP地址。
  • 多个后端服务器ID间使用“&”分隔。

说明

如果您不希望在创建后端服务器组的同时添加后端服务器，那么可以不传入该参数。后端服务器组创建成功后，请您调用AddServerGroupBackendServers接口添加后端服务器。

Servers.N.Type

String

是

Servers.1.Type=ecs&Servers.2.Type=eni

后端服务器的类型，取值如下：

  • ecs：云服务器实例。
  • eni：网卡。
参数 - N：表示后端服务器的序号。取值范围为1 ～ 20。

说明

  • 参数Type取值为“instance”，且待添加的后端服务器为云服务器主网卡时，后端服务器类型设置为“ecs”。
  • 参数Type取值为“instance”，且待添加的后端服务器为云服务器绑定的辅助网卡时，后端服务器类型设置为“eni”。
  • 参数Type取值为“ip”时，后端服务器类型设置为“ip”。
  • 如果您不希望在创建后端服务器组的同时添加后端服务器，那么可以不传入该参数。

Servers.N.Weight

Integer

否

Servers.1.Weight=100&Servers.2.Weight=100

后端服务器的权重，取值范围为0 ～ 100。

  • 如果权重设置为0，表示不会将请求转发给该后端服务器。
  • 参数 - N：表示后端服务器的序号。取值范围为1 ～ 20。
  • 不传入该参数或该参数不传入数值时，默认为0。

Servers.N.Ip

String

是

Servers.1.Ip=192.XX.XX.2&Servers.2.Ip=192.XX.XX.3

后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址，调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
参数 - N：表示后端服务器的序号。取值范围为1 ～ 20。

说明

如果您不希望在创建后端服务器组的同时添加后端服务器，那么可以不传入该参数。

Servers.N.Port

Integer

是

Servers.1.Port=88&Servers.2.Port=443

后端服务器接收请求的端口号，取值范围为1～65535。
参数 - N：表示后端服务器的序号。取值范围为1 ～ 20。

说明

如果您不希望在创建后端服务器组的同时添加后端服务器，那么可以不传入该参数。

Servers.N.Description

String

否

Servers.1.Description=ecs1&Servers.2.Description=eni1

后端服务器的描述。

  • 参数 - N：表示后端服务器的序号。取值范围为1 ～ 20。
  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ～ 255个字符。
  • 不传入该参数或该参数不传入数值时，默认为空字符串。

AddressIpVersion

String

否

ipv4

后端服务器组的IP地址类型。取值如下：

  • ipv4（默认值）：表示该后端服务器组IPv4类型。
  • ipv6：表示该后端服务器组为IPv6类型。

说明

支持IPv6后端的功能正在邀测中，如需使用，请联系客户经理申请权限。

返回参数

字段类型示例值
描述
RequestIdString20210811152539010225146063030****请求ID。
ServerGroupIdStringrsp-bp1o94dp5i6ea****后端服务器组ID。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "CreateServerGroup",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "ServerGroupId": "rsp-bp1o94dp5i6ea****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。

说明

其中，XXX表示缺少的参数名称。

400InvalidAddressIpVersion.LoadBalancerMismatchThe specified AddressIpVersion and LoadBalancer are not matched.指定的 IP 类型与负载均衡不匹配。
400InvalidAddressIpVersion.MalformedThe specified AddressIpVersion is malformed.指定的 AddressIpVersion 参数格式不合法。
400InvalidAddressIpVersion.TypeMismatchThe specified AddressIpVersion and Type are not matched.指定的 IP 类型与服务器组类型不匹配。
400InvalidAddressIpVersion.VpcMismatchThe specified AddressIpVersion and Vpc are not matched.指定的 IP 类型与 VPC 不匹配。
400InvalidType.MalformedThe specified Type is malformed.指定的 Type 参数格式不合法。
400InvalidDescription.MalformedThe specified Description is malformed.指定的 Description 参数格式不合法。
400InvalidName.MalformedThe specified Name is malformed.指定的 Name 参数格式不合法。
400InvalidServers.Description.MalformedThe specified Servers.Description is malformed.指定的 Servers.Description 参数格式不合法。
400InvalidServers.Ip.MalformedThe specified Servers.Ip is malformed.指定的 Servers.Ip 参数格式不合法。
400InvalidServers.Port.MalformedThe specified Servers.Port is malformed.指定的 Servers.Port 参数格式不合法。
400InvalidServers.Type.MalformedThe specified Servers.Type is malformed.指定的 Servers.Type 参数格式不合法。
400InvalidServers.Weight.MalformedThe specified Servers.Weight is malformed.指定的 Servers.Weight 参数格式不合法。
400InvalidLoadBalancer.InvalidStatusThe specified LoadBalancer is not in the correct status for the request.指定的负载均衡所处状态无法响应该请求。
400UnsupportedOperation.AccountArrearsThe request on the specified instance is denied due to the account in arrears status.因账户处于欠费状态，对于该实例的操作请求被拒绝。
400InvalidServer.TypeThe specified Server type not match with ServerGroup.指定的后端服务器类型与服务器组类型不一致。
400LimitExceeded.ServerNumberYou've reached the limit on the number of add servers that you can operate.已达到单次可操作的后端服务器的数量上限。
400QuotaExceed.ServerGroupNumberEachInstanceYou've reached the limit on the number of ServerGroups that you can create.已达到可创建后端服务器组的数量的配额上限。
400QuotaExceed.ServerNumberEachInstanceYou've reached the limit on the number of Servers that you can create.已达到可创建后端服务器的数量的配额上限。
400InvalidServerId.ServerIPMismatchThe specified serverIP and InstanceId are not matched.指定的后端服务器 ID 与 IP 不匹配。
400InvalidEni.UnSupportActionThe specified Eni does not support this action.指定的网卡不支持当前操作。
400InvalidBackendServer.ServerVpcMismatchThe specified BackendServer and Vpc are not matched.指定的后端服务器与 VPC 不匹配。
400InvalidIncorrectOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。
400InvalidServerIp.UnSupportActionThe specified Server Ip does not support this action.指定的后端服务器 IP 不支持当前操作。
400InvalidProject.MalformedThe specified Project is malformed.指定的 Project 参数格式不合法。
400InvalidLoadBalancer.UnSupportActionThe specified LoadBalancer does not support this action.指定的负载均衡不支持当前操作。
400InvalidTagKey.MalformedThe specified TagKey is malformed.指定的 TagKey 参数格式不合法。
400InvalidTagValue.MalformedThe specified TagValue is malformed.指定的 TagValue 参数格式不合法。
400LimitExceeded.ServiceManagedTagYou've reached the limit on the number of service managed tags that you can create.已达到单次可创建受管资源标签键值数量的上限。
400LimitExceeded.TagOperationYou've reached the limit on the number of tags that you can operate at a time.已达到单次可操作的标签条目数量上限。
403ForbiddenYou are not authorized to perform operations on the service managed tag.无权限对指定资源打上受管标签。
403InvalidResourceType.ServcieManagedThe specified ResourceType is managed by a service.指定的资源是服务托管资源。
404InvalidLoadBalancer.NotFoundThe specified LoadBalancer does not exist.指定的负载均衡实例不存在。
404InvalidServer.NotFoundThe specified Server does not exist.指定的后端服务器不存在。
404InvalidExclusiveCluster.NotFoundThe specified ExclusiveCluster does not exist.指定的独占集群不存在。
409InvalidServer.ConflictThe specified Server already exists.指定的后端服务器端口已存在。
412InvalidLoadBalancer.ExpiredThe specified LoadBalancer has expired.指定的负载均衡已过期。
412InvalidExclusiveCluster.ExpiredThe specified ExclusiveCluster has expired.指定的独占集群已过期。
412InvalidExclusiveCluster.UnPurchasedThe specified ExclusiveCluster is not purchased.指定的独占集群未购买。