首页 负载均衡 传统型负载均衡CLB 开发参考 API参考 API目录 虚拟服务器组 AddVServerGroupBackendServers - 向指定的虚拟服务器组中添加后端服务器

AddVServerGroupBackendServers - 向指定的虚拟服务器组中添加后端服务器

更新时间: 2024-03-14 14:40:01

向指定的虚拟服务器组中添加后端服务器。

调试

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

授权信息

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

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

请求参数

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

负载均衡实例的地域 ID。

cn-hangzhou
VServerGroupIdstring

虚拟服务器组 ID。

rsp-cige6******
BackendServersstring

要添加的后端服务器列表,包含以下参数:

  • ServerId:String 类型,必选,后端服务器的实例 ID,分为 ECS 实例 ID、ENI 实例 ID 和 ECI 实例 ID,当 ServerId 参数值为 ENI 实例 ID 或 ECI 实例 ID 时,Type 参数值必选。

  • Weight:后端服务器的权重,取值:0~100。默认值:100。 如果值为 0,则不会将请求转发给该后端服务器。

  • Description:String 类型,非必选,后端服务器描述,长度为 1~80 个字符,支持中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)。

  • Type:后端服务器类型,取值:

    • ecs:ECS 实例(默认)。

    • eni:弹性网卡实例。

    • eci:弹性容器实例。

说明 只有性能保障型实例支持添加 eni 和 eci 类型的后端服务器。
  • ServerIp:ENI 或 ECI 的实例 IP。

  • Port:用来接收请求的后端端口。

示例说明如下:

  • 挂载 ECS 示例:

    [{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port":"80","Description":"test-112" }]

  • 挂载 ENI:

    [{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-112" }]

  • 挂载 ENI 多 IP:

    [{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-113" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port":"80","Description":"test-113" }]

  • 挂载 ECI:

    [{ "ServerId": "eci-xxxxxxxxx", "Weight": "100", "Type": "eci", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-114" }]

说明 必须是状态为运行中的后端服务器才可以加入负载均衡实例,每次调用最多可添加 20 个后端服务器。
[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port":"80","Description":"test-113" }]

返回参数

名称类型描述示例值
object
VServerGroupIdstring

虚拟服务器组 ID。

rsp-cige6j******
RequestIdstring

请求 ID。

9DEC9C28-AB05-4DDF-9A78-6B******
BackendServersobject []

后端服务器列表。

Typestring

后端服务器类型,取值:

  • ecs(默认):ECS 实例。

  • eni:弹性网卡实例。

  • eci:弹性容器实例。

eni
Weightinteger

后端服务器的权重。

100
Descriptionstring

后端服务器组描述。

后端服务器组
Portinteger

后端服务器使用的端口。

70
ServerIdstring

ECS 实例 ID 或者 ENI 的实例 ID。

eni-hhshhs****

示例

正常返回示例

JSON格式

{
  "VServerGroupId": "rsp-cige6j******",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B******",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "eni",
        "Weight": 100,
        "Description": "后端服务器组",
        "Port": 70,
        "ServerId": "eni-hhshhs****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidBackendServers.ServerIpConflict%s.存在相同TunnelId和RsIp配置的后端服务器。
400Mismatched.ZoneIdThe zone of the server is not matched with the cloud box loadbalancer.当前服务器的可用区与云盒实例可用区不匹配。
400OperationUnsupported.AddVServerGroupBackendServersThis type of backend server is not allowed to attached to singleTunnel or anyTunnel lb.该类型后端服务器不允许关联singleTunnel或anyTunnel的实例
400IncorrectStatus.RSByPassToas%s.指定后端服务器的BypassToa配置无效。
400BackendServer.InvalidTypeThe specified Type is invalid.后端服务器类型非法。
400BackendServer.ServerRegionIdNotEqualThe specified ServerRegionId must be equal.后端服务器必须属于同一个地域。
400OperationFailed.InvalidCenThe cen related with this loadbalancer is invalid.操作失败,原因是指定负载均衡实例关联的Cen信息缺失。
400IncorrectStatus.CenNotAssociatedThe action is invalid because the loadbalancer is not associated with cen.该操作无效,因为当前负载均衡实例未与cen关联。
400InvalidBackendServers.MissingCenBandWidthThe bandwidth is missing between loadbalancer and backendServers in cen.Cen中的负载均衡实例所在的地域和挂载的目标地域之间要有带宽包。
400InvalidBackendServers.VpcNotInCenThe BackendServers is not in the cen associated with the loadbalancer.后端服务器不在与负载均衡关联的cen中。
400InvalidServerId.NotExistThe specified ServerId is not exist.指定的后端服务器不存在。
400MissingParameter.ServerRegionIdThe parameter ServerRegionId is required.参数ServerRegionId缺失。
400MissingParameter.VbrIdThe parameter VbrId is required.参数VbrId缺失。
400InvalidParameter.ServerRegionIdThe parameter ServerRegionId is invalid for crossborder.指定的ServerRegionId无效。请检查参数约束,并在修改后重试。
400InvalidVbrId.NotInCenThe VbrId is not in the cen associated with the loadbalancer.指定的Vbr不在实例关联的Cen内。
400InvalidParameter.ServerRegionIdThe specified ServerRegionId is invalid.指定的ServerRegionId无效。请检查参数约束,并在修改后重试。
400InvalidParameter.ZoneNotSupportThe zone does not support the parameter %s.当前可用区不支持指定参数。
400MasterSlaveServerConflictThe servers are conflict for MasterSlaveGroup.主备服务器组的后端服务器冲突。
400OperationFailed.ServiceGroupProcessingThe specified service group is processing.操作失败,原因是指定的服务器组正在变配中。
400NetworkConflict%s.虚拟服务器组和ECS配置信息不一致。
400SystemBusyThe system is busy.系统繁忙,请您稍后再试。
400SignatureNonceUsedSpecified signature nonce was used already.指定的签名随机数已经被使用过了。
400VpcSystemBusyInvoke vpc system busy, please retry later.VPC系统异常,请稍后重试。
400OperationDeny.LbNotSupportIPv6ServerThe specified loadbalancer does not support ipv6 server.指定负载均衡实例不支持IPV6后端。
400OperationBusyThe operation is busy.操作繁忙,请稍后再试。
404ResourceNotFound.vServersThe specified enis %s does not exist.提供的instance有的已经不存在,请检查输入参数。
404ResourceNotFound.CenThe specified resource Cen %s not Exists.cen接入点不存在。请根据错误信息进行检查。

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

变更历史

变更时间变更内容概要操作
2023-09-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    新增错误码:404
阿里云首页 负载均衡 相关技术圈