You need to enable JavaScript to run this app.
导航
负载均衡
  • 文档首页
    • /负载均衡/API参考/后端服务器组/CreateServerGroup
CreateServerGroup
最近更新时间：2024.06.04 19:02:26首次发布时间：2021.08.31 10:37:27
我的收藏

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

使用说明

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

调试

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

请求参数

名称
类型
是否必选
示例值
描述
ActionString是CreateServerGroup要执行的操作，取值为CreateServerGroup。
VersionString是2020-04-01API版本信息，当前版本为：2020-04-01。

LoadBalancerId

String

是

clb-bp1b6c719dfa08ex****

负载均衡实例的ID。
您可以调用DescribeLoadBalancers接口，查询负载均衡实例ID。

ServerGroupName

String

否

myservergroup

后端服务器组名称。

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

Description

String

否

This is a servergroup.

后端服务器组的描述。

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

AddressIpVersion

String

否

ipv4

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

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

说明

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

Type

String

否

instance

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

  • instance（默认值）：云服务器实例。
  • ip：IP地址。

IP地址作为后端服务器的功能正在邀测中，如需使用，请联系客户经理。

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接口，查询云服务实例ID。

    • 当Servers.N.Type 取eni时，传已挂载至云服务器的辅助网卡的ID。您可以调用DescribeNetworkInterfaces接口，查询网卡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接口获取“ecs”类型后端服务器的私网IP地址，调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
  • 参数 - N：表示后端服务器的序号。取值范围：1 ～ 20。
  • 多个后端服务器IP之间使用“&”分隔。

Servers.N.Port

Integer

否

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

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

  • 多个后端服务器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字符，允许输入各国语言文字、数字、空格（ ）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。
  • 若标签键开头或结尾存在空格，系统会自动为其去除。

说明

同一资源的标签键不允许重复。

Tags.N.Value

String

否

Tags.1.Value=value1&Tags.2.Value=value2

用户标签的标签值。

  • 参数 - N：表示标签值的序号，取值范围：1～20。
  • 多个标签值之间用&分隔。
  • 长度取值范围为0～256字符，不填默认为空。
  • 允许输入各国语言文字、数字、空格（ ）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。
  • 大小写敏感。
  • 若标签值开头或结尾存在空格，系统会自动为其去除。

说明

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

返回参数

名称
类型
示例值
描述
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.指定的独占集群未购买。