首页 负载均衡 应用型负载均衡ALB 开发参考 API参考 API目录 服务器组 ReplaceServersInServerGroup - 替换后端服务器组中的后端服务器

ReplaceServersInServerGroup - 替换后端服务器组中的后端服务器

更新时间: 2023-08-23 21:04:27

调用ReplaceServersInServerGroup替换后端服务器组中的后端服务器。

接口说明

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

  1. 您可以调用ListServerGroups查询服务器组的状态:

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

    • 当后端服务器处于Replacing状态时,表示服务器组移出服务器并加入新的服务器。
    • 当后端服务器处于** Available**状态时,表示后端服务器运行中。

调试

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

调试

授权信息

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

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

请求参数

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

服务器组ID。

说明 函数计算类型的服务器组不支持替换后端服务器。
sgp-5114d593o96qxy****
AddedServersobject []

待添加的后端服务器列表,单次调用最多支持传入40个服务器。

Descriptionstring

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

test
Portinteger

后端服务器组使用的端口。取值范围:1~65535。单次调用最多支持传入40个服务器。

80
ServerIdstring

后端服务器ID。单次调用最多支持传入40个服务器。

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

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

说明 函数计算类型的服务器组不支持替换后端服务器。您可以通过调用ListServerGroups接口获取服务器组类型的取值。
i-bp1f9kdprbgy9uiu****
ServerIpstring

ENI多IP模式时指定的IP地址。单次调用最多支持传入40个服务器。

192.168.1.1
ServerTypestring

后端服务器类型,单次调用最多支持传入40个服务器。取值:

  • Ecs:ECS实例。
  • Eni:ENI弹性网卡实例。
  • Eci:ECI弹性容器。
Ecs
Weightinteger

后端服务器的权重,单次调用最多支持传入40个服务器。

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

100
RemovedServersobject []

待删除的后端服务器。

ServerIdstring

后端服务器ID。单次调用最多支持传入40个服务器。

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

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

说明 函数计算类型的服务器组不支持替换后端服务器。您可以通过调用ListServerGroups接口获取服务器组类型的取值。
ecs-bp1ac9uozods2uc****
ServerIpstring

ENI多IP模式时指定的IP地址。单次调用最多支持传入40个服务器。

192.168.1.12
ServerTypestring

后端服务器类型,单次调用最多支持传入40个服务器。取值:

  • Ecs:ECS实例。
  • Eni:ENI弹性网卡实例。
  • Eci:ECI弹性容器。
ecs
Portinteger

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

81
ClientTokenstring

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

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

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

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

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

返回参数

名称类型描述示例值
object

返回数据结构体。

JobIdstring

异步任务ID。

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

请求ID。

365F4154-92F6-4AE4-92F8-7FF34B540710

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.-
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。
400DuplicatedParam.BackendServerThe param of %s is duplicated.-
400OperationDenied.EciNotSupportJobTypeThe operation is not allowed because of eci not support job type.-
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不存在。
404ResourceNotFound.BackendServerThe specified resource %s is not found.资源%s不存在。

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

变更历史

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