文档

DetachServerGroups

更新时间:

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DetachServerGroups

系统规定参数。取值:DetachServerGroups

RegionId String cn-hangzhou

伸缩组所属的地域ID。

ScalingGroupId String asg-bp18p2yfxow2dloq****

伸缩组ID。

ClientToken String 123e4567-e89b-12d3-a456-42665544****

保证请求幂等性。

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

ForceDetach Boolean false

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

  • true:移除。
  • false:不移除。

默认值:false。

ServerGroup.N.ServerGroupId String sgp-1gv2uidn2msy****

负载均衡服务器组的ID。

ServerGroup.N.Type String ALB

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

  • ALB:应用型负载均衡ALB(Application Load Balancer)。
  • NLB:网络型负载均衡NLB(Network Load Balancer)。
ServerGroup.N.Port Integer 22

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

返回数据

名称

类型

示例值

描述

ScalingActivityId String asa-bp1gbswjhjrw8tko****

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

说明 仅当ForceDetach取值为true时,返回该参数。
RequestId String 6EF9BFEE-FE07-4627-B8FB-14326FB9****

请求ID。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DetachServerGroups
&RegionId=cn-hangzhou
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&ForceDetach=false
&ServerGroup=[{"ServerGroupId":"sgp-1gv2uidn2msy****","Type":"ALB","Port":22}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DetachServerGroupsResponse>
    <ScalingActivityId>asa-bp1gbswjhjrw8tko****</ScalingActivityId>
    <RequestId>6EF9BFEE-FE07-4627-B8FB-14326FB9****</RequestId>
</DetachServerGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

  • 本页导读 (1)