文档

RemoveServersFromServerGroup - 移除后端服务器

更新时间:

从服务器组中移除后端服务器。

接口说明

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

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

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

    • 当后端服务器处于 Removing 状态时,表示后端服务器正在从服务器组中移除。
    • 当查询不到该后端服务器时,表示后端服务器移除成功。

调试

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

授权信息

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

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

请求参数

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

服务器组 ID。

sgp-atstuj3rtop****
Serversobject []

后端服务器组列表,最多支持 200 个服务器。

Portinteger

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

说明 ServerType 取值为 EcsEniEciIp 时,该参数必传。
80
ServerIdstring

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

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

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

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

说明 您可以通过调用 ListServerGroups 接口获取服务器组类型的取值。
i-bp1f9kdprbgy9uiu****
ServerIpstring

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

192.168.1.1
ServerTypestring

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

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

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

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

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

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

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

返回参数

名称类型描述示例值
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错误码错误信息描述
400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.服务器组状态无效。
400ResourceInConfiguring.BackendServerThe specified resource of %s is being configured, please try again later.指定的资源%s正在配置中,请稍后再试
400ResourceInConfiguringThe specified resource of %s is being configured. Please try again later.指定的资源在变更中,请稍后再试
403Forbidden.ServerGroupAuthentication is failed for ServerGroup.当前服务器组权限校验失败。
404ResourceNotFound.ServerGroupThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.BackendServerThe specified resource %s is not found.资源%s不存在。

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

变更历史

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