文档

AddServersToServerGroup - 添加后端服务器

更新时间:

向服务器组中添加后端服务器。

接口说明

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

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

调试

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

授权信息

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

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

请求参数

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

服务器组 ID。

sgp-atstuj3rtop****
Serversobject []

后端服务器列表, 单次调用最多支持添加 200 个服务器。

Descriptionstring

后端服务器描述。长度为 2~256 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)、短划线(-)、半角逗号(,)、半角分号(;)、正斜线(/)和 at(@)。 单次调用最多支持添加 200 个服务器。

test
Portinteger

后端服务器使用的端口。取值范围:1~65535。 单次调用最多支持添加 200 个服务器。

说明 ServerType 取值为 EcsEniEciIp 时,该参数必传。当 ServerType 取值为 Fc 时,无需配置该参数。
80
ServerIdstring

后端服务器 ID。 单次调用最多支持添加 200 个服务器。

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

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

  • 当服务器组为 Fc 时,该参数为函数计算的 ARN 标识。

i-uf616vu8me******
ServerIpstring

指定 IP 地址。 单次调用最多支持添加 200 个服务器。

说明 ServerType 取值为 Fc 时,无需配置该参数。
192.168.1.1
ServerTypestring

后端服务器类型。 单次调用最多支持添加 200 个服务器。取值:

  • Ecs:ECS 实例
  • Eni:ENI 弹性网卡实例
  • Eci:ECI 弹性容器
  • Ip:IP 地址
  • Fc:函数计算
Ecs
Weightinteger

后端服务器的权重,取值范围:0~100。默认值为 100。如果设置权重为 0,则不会将请求转发给该后端服务器。 单次调用最多支持添加 200 个服务器。

说明 ServerType 取值为 Fc 时,无需配置该参数。
100
RemoteIpEnabledboolean

是否开启远端 IP 功能。 单次调用最多支持添加 200 个服务器。取值:

  • true:开启。

  • false:不开启。

说明 ServerType 取值为 Ip 时,该参数有效。
false
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
593B0448-D13E-4C56-AC0D-FDF0******
DryRunboolean

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

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

返回参数

名称类型描述示例值
object

返回数据结构体

JobIdstring

异步任务 ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF34******

示例

正常返回示例

JSON格式

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}

错误码

HTTP status code错误码错误信息描述
400ResourceQuotaExceeded.ServerAddedNumThe quota of %s is exceeded for resource %s, usage %s/%s.配额%s已超额度限制,资源是%s,目前已使用%s,配额为%s。
400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.服务器组状态无效。
400Conflict.BackendServerThere is already %s having the same configuration with %s.%s冲突,已经存在同配置的%s。
400OperationDenied.VpcVportNotFoundThe operation is not allowed because of %s.不允许该操作,原因:vpc端口未找到
400IncorrectStatus.EniThe status of %s [%s] is incorrect.资源%s [%s]的状态无效。
400ResourceInUse.IPThe specified resource %s is in use.资源%s正在使用中。
400OperationDenied.NoAvailableVSwitchThe operation is not allowed because of %s.操作被拒绝,原因是%s。
400OperationDenied.VgwVipNotFoundThe operation is not allowed because of %s.操作被拒绝,原因是%s。
400OperationDenied.CloudBoxThe operation is not allowed because of %s.操作被拒绝,原因是%s。
400Mismatch.TypeThe %s is mismatched for %s and %s.%s在%s和%s中不匹配。
400Mismatch.VpcIdThe %s is mismatched for %s and %s.%s在%s和%s中不匹配。
400ResourceQuotaExceeded.LoadBalancerServersNumThe quota of %s is exceeded for resource %s, usage %s/%s.配额%s已超额度限制,资源是%s,目前已使用%s,配额为%s。
400ResourceInConfiguringThe specified resource of %s is being configured. Please try again later.指定的资源在变更中,请稍后再试
400DuplicatedParam.BackendServerThe param of %s is duplicated.参数%s是重复的。
400OperationDenied.EciNotSupportJobTypeThe operation is not allowed because of eci not support job type.服务器组不支持添加Job优化型ECI实例。
400IllegalParam.ServerIpThe param of ServerIp is illegal.参数ServerIp非法
400Mismatch.ServerTypeThe %s is mismatched for %s and %s.%s在%s和%s中不匹配。
400ServiceUnavailableThe request has failed due to a temporary failure of the server.请求因服务器暂时性故障而失败。
403Forbidden.ServerGroupAuthentication has failed for ServerGroup.对ServerGroup鉴权失败
404ResourceNotFound.ServerGroupThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.EcsThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.EciThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.EniThe specified resource %s is not found.资源%s不存在。

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

变更历史

变更时间变更内容概要操作
2024-01-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2024-01-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2024-01-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2024-01-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2024-01-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2024-01-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
    新增错误码:403
2023-07-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
  • 本页导读 (1)
文档反馈