DetachServerGroups - 移除一个或多个负载均衡服务器组

对于需要动态调整实例数量来应对业务变化负载以及确保应用程序的高可用性场景,调用API DetachServerGroups从伸缩组移除一个或多个负载均衡服务器组,支持的服务器组类型包括应用型负载均衡ALB和网络型负载均衡NLB,可以实现对负载均衡策略的动态调整,并帮助提高系统的高可用性。

调试

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

授权信息

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

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

请求参数

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

伸缩组所属的地域 ID。

cn-hangzhou
ScalingGroupIdstring

伸缩组 ID。

asg-bp18p2yfxow2dloq****
ClientTokenstring

保证请求幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-42665544****
ForceDetachboolean

是否从待移除服务器组中移除当前伸缩组内的 ECS 实例或 ECI 实例。

  • true:移除。

  • false:不移除。

默认值:false。

false
ServerGroupsarray<object>

负载均衡服务器组的相关信息集合。

object

负载均衡服务器组的相关信息集合。

ServerGroupIdstring

负载均衡服务器组的 ID。

sgp-1gv2uidn2msy****
Typestring

负载均衡服务器组类型。取值范围:

  • ALB:应用型负载均衡 ALB(Application Load Balancer)。
  • NLB:网络型负载均衡 NLB(Network Load Balancer)。
ALB
Portinteger

服务器组中 ECS 实例或 ECI 实例使用的端口号。

22

返回参数

名称类型描述示例值
object
ScalingActivityIdstring

移出负载均衡服务器组,并移出该服务器组内的 ECS 实例或 ECI 实例时,伸缩活动的 ID。

说明 仅当ForceDetach取值为true时,返回该参数。
asa-bp1gbswjhjrw8tko****
RequestIdstring

请求 ID。

6EF9BFEE-FE07-4627-B8FB-14326FB9****

示例

正常返回示例

JSON格式

{
  "ScalingActivityId": "asa-bp1gbswjhjrw8tko****",
  "RequestId": "6EF9BFEE-FE07-4627-B8FB-14326FB9****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-18API 内部配置变更,不影响调用查看变更详情