文档

DetachVServerGroups

更新时间:

伸缩组支持关联负载均衡实例,可以有效增强伸缩组的服务能力。如果您的业务暂不需要通过负载均衡实例将访问流量分发到伸缩组内的多个实例中去,您可以调用API DetachVServerGroups移除一个或者多个虚拟服务器组。

接口说明

  • 确定待移除的虚拟服务器组时,需要同时指定以下参数:
    • 负载均衡实例ID(LoadBalancerId)
    • 虚拟服务器组ID(VServerGroupId)
    • 虚拟服务器组端口号(Port)
  • 如果请求参数中的虚拟服务器组与伸缩组中的虚拟服务器组相匹配,则移除该虚拟服务器组。如果未能匹配,则忽略移除请求,且接口不报错。
  • 如果移除伸缩组的负载均衡实例时,您需要确认该负载均衡实例不再向伸缩组内实例分发请求,避免造成服务请求丢失的情况。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DetachVServerGroups

系统规定参数。取值:DetachVServerGroups

RegionId String cn-hangzhou

伸缩组所属地域的ID,例如cn-hangzhoucn-shanghai。更多信息,请参见地域和可用区

ScalingGroupId String asg-bp1fo0dbtsbmqa9h****

伸缩组的ID。

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

保证请求幂等性。

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

ForceDetach Boolean false

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

  • true:移除。如果该参数取值为true,则从伸缩组中移除负载均衡实例时,系统会将负载均衡实例后端服务器上与伸缩组关联的实例移除。
  • false:不移除。如果该参数取值为false,则从伸缩组中移除负载均衡实例时,系统不会从负载均衡实例后端服务器上移除与伸缩组关联的实例。

默认值:false。

VServerGroup.N.VServerGroupAttribute.N.VServerGroupId String rsp-bp1jp1rge****

虚拟服务器组ID。其中:

  • 第一个N为负载均衡实例编号,取值范围:1~5。
  • 第二个N为负载均衡实例下虚拟服务器组的编号,取值范围:1~5。
VServerGroup.N.VServerGroupAttribute.N.Port Integer 22

弹性伸缩将ECS实例或ECI实例添加到虚拟服务器组时使用的端口号,取值范围:1~65535。其中:

  • 第一个N为负载均衡实例编号,取值范围:1~5。
  • 第二个N为负载均衡实例下虚拟服务器组的编号,取值范围:1~5。
VServerGroup.N.LoadBalancerId String lb-bp1p90y3ya9h8s62d****

虚拟服务器组所属负载均衡实例的ID。

N为负载均衡实例编号,取值范围:1~5。

说明 支持最多一次从伸缩组移除5个负载均衡实例。

返回数据

名称

类型

示例值

描述

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

请求ID。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DetachVServerGroups
&RegionId=cn-hangzhou
&ScalingGroupId=asg-bp1fo0dbtsbmqa9h****
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&ForceDetach=false
&VServerGroup=[{"VServerGroupAttribute":[{"VServerGroupId":"rsp-bp1jp1rge****","Port":22}],"LoadBalancerId":"lb-bp1p90y3ya9h8s62d****"}]
&公共请求参数

正常返回示例

XML格式

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

<DetachVServerGroupsResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</DetachVServerGroupsResponse>

JSON格式

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

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

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

HttpCode

错误码

错误信息

描述

403

Forbidden.Unauthorized

A required authorization for the specified action is not supplied.

您未授予弹性伸缩完整的OpenAPI调用权限。

404

InvalidScalingGroupId.NotFound

The specified scaling group does not exist.

账号下不存在指定的伸缩组。

400

InvalidParameter

The specified value of parameter "%s" is not valid.

参数值不合法。

400

MissingParameter

The input parameter "%s" that is mandatory for processing this request is not supplied.

缺少必要的参数。