文档

AddBackendServers - 添加后端服务器

更新时间:

添加后端服务器。

接口说明

说明 如果一次请求中添加多个相同的 ECS 实例,只会取第一个,其他相同实例会被忽略。新增后端服务器不能与同监听下已有服务器重复,否则会报错。

调试

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

授权信息

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

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

请求参数

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

负载均衡实例所属地域的 ID。

您可以通过调用 DescribeRegions 获取地域 ID。

cn-beijing
LoadBalancerIdstring

负载均衡实例 ID。

lb-2ze7o5h52g02kkzz******
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:ECS、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
LoadBalancerIdstring

负载均衡实例 ID。

lb-2ze7o5h52g02kkzz****
RequestIdstring

请求 ID。

34B82C81-F13B-4EEB-99F6-A048C67CC830
BackendServersobject []

后端服务器列表。

Typestring

后端服务器类型。取值:

  • ecs:ECS 实例(默认)。
  • eni:弹性网卡实例。
  • eci:弹性容器实例。
ecs
Weightstring

后端服务器的权重。

取值:0~100。默认值:100

如果值为 0,则不会将请求转发给该后端服务器。

100
Descriptionstring

后端服务器描述。

后端服务器
ServerIdstring

ECS、ENI、或者 ECI 实例 ID。

i-2zej4lxhjoq1icu*****

示例

正常返回示例

JSON格式

{
  "LoadBalancerId": "lb-2ze7o5h52g02kkzz****",
  "RequestId": "34B82C81-F13B-4EEB-99F6-A048C67CC830",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": "100",
        "Description": "后端服务器",
        "ServerId": "i-2zej4lxhjoq1icu*****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified load balancer does not support the network type of the ECS instance.负载均衡实例不支持此种网络类型的ECS实例,请您换一种网络类型的ECS后再重试。
400Mismatched.ZoneIdThe zone of the server is not matched with the cloud box loadbalancer.当前服务器的可用区与云盒实例可用区不匹配。
400BackendServerProcessingBackend Server is adding, please try again later.后端服务器正在添加中,请稍后尝试。
400InvalidBackendServers.ServerIpConflict%s.存在相同TunnelId和RsIp配置的后端服务器。
400OperationUnsupported.AddBackendServersThis type of backend server is not allowed to attached to singleTunnel or anyTunnel lb.SingleTunnel和AnyTunnel类型负载均衡实例不支持指定类型的后端服务器。
400IncorrectStatus.RSByPassToas%s.指定后端服务器的BypassToa配置无效。
400OperationFailed.ActionNotSupportThe loadbalancer does not support such action.当前实例不支持该操作。
400NetworkConflict%s.虚拟服务器组和ECS配置信息不一致。
400SystemBusyThe system is busy.系统繁忙,请您稍后再试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)