全部产品
Search
文档中心

负载均衡:AddServersToServerGroup - 服务器组中添加后端服务器

更新时间:Nov 14, 2024

向负载均衡服务器组中添加后端服务器。

接口说明

AddServersToServerGroup 接口属于异步接口,即系统返回一个请求 ID,但该后端服务器尚未添加成功,系统后台的添加任务仍在进行。

  1. 您可以调用 ListServerGroups 查询服务器组的状态:
  • 当服务器组处于 Configuring 状态时,表示服务器组正在变配中。
  • 当服务器组处于 Available 状态时,表示服务器组运行中。
  1. 您可以调用 ListServerGroupServers 查询后端服务器的状态:
  • 当后端服务器处于 Adding 状态时,表示后端服务器正在加入服务器组。
  • 当后端服务器处于 Available 状态时,表示后端服务器运行中。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gwlb:AddServersToServerGroupcreate
  • ServerGroup
    acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}
  • NetworkInterface
    acs:ecs:{#regionId}:{#accountId}:eni/{#ServerId}
  • ContainerGroup
    acs:eci:{#regionId}:{#accountId}:containergroup/{#ServerId}

请求参数

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

服务器组 ID。

sgp-atstuj3rtoptyui****
Serversarray<object>

后端服务器列表。

说明 单次调用最多支持传入 200 个服务器。
Serverobject

后端服务器。

Portinteger

后端服务器使用的端口,取值:

  • 6081
6081
ServerIdstring

后端服务器 ID。

  • 当服务器组为 Instance 类型时,该参数为 EcsEniEci 的资源 ID。

  • 当服务器组为 Ip 类型时,该参数为 IP 地址。

i-bp67acfmxazb4p****
ServerIpstring

后端服务器 IP 地址。

192.168.XX.XX
ServerTypestring

后端服务器类型,取值:

  • Ecs:ECS 实例。
  • Eni:ENI 弹性网卡实例。
  • Eci:ECI 弹性容器。
  • Ip:Ip 地址。
Ecs
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会向服务器组中添加后端服务器。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-42665544****

返回参数

名称类型描述示例值
object

返回数据结构体。

RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

错误码

HTTP status code错误码错误信息描述
400Conflict.ServerThe %s [%s] is conflict.%s冲突,已经存在同配置的%s。
400Mismatch.ServerTypeThe %s is mismatched for %s and %s.ServerType不匹配。
400ResourceInUse.IPThe specified resource of %s is in use.指定的IP地址已被使用
400IllegalParam.ServerIpThe param of %s is illegal.参数ServerIp非法,请检查输入参数。
400IllegalParam.EcsNetworkTypeThe param of %s is illegal.参数EcsNetworkType非法,请检查输入参数。
400DuplicatedParam.ServerThe param of %s is duplicated.参数中存在重复的server。
400ResourceInUse.EniThe specified resource of %s is in use.传入的eni不能是网关型负载均衡实例使用的eni,请检查参数。
400IncorrectStatus.EniThe status of %s [%s] is incorrect.资源%s当前状态%s不支持操作
400IllegalParam.IPThe param of %s is illegal.参数IP非法。请检查参数IP的输入值。
400Mismatch.IPThe %s is mismatched for %s and %s.输入的IP类型服务器的ID和IP不匹配。
400Mismatch.VpcIdThe %s is mismatched for %s and %s.两个资源的VPC ID不匹配
400QuotaExceeded.ServerGroupServersNumThe quota of %s is exceeded for resource %s, usage %s/%s.配额gwlb_quota_servergroup_servers_num已超额度限制。
400QuotaExceeded.ServerGroupAzServersNumThe quota of %s is exceeded for resource %s, usage %s/%s.配额gwlb_quota_servergroup_az_servers_num已超额度限制。
400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.资源%s当前状态%s不支持操作
404ResourceNotFound.EniThe specified resource of %s is not found.指定的弹性网卡资源不存在。
404ResourceNotFound.EciThe specified resource of %s is not found.指定的弹性容器实例资源不存在。
404ResourceNotFound.ServerGroupThe specified resource of %s is not found.指定的服务器组资源不存在。
404ResourceNotFound.EcsThe specified resource of %s is not found.指定的云服务器资源不存在。

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