伸缩组关联负载均衡实例(CLB)后,加入伸缩组的实例会自动添加为CLB实例的后端服务器,处理来自CLB实例转发的访问请求。当需要将不同的请求转发到不同的后端服务器上时,或需要通过域名和URL进行请求转发时,您可以调用API AttachVServerGroups来添加负载均衡实例下的一个或者多个虚拟服务器组,通过虚拟服务器组管理不同的后端服务器。
接口说明
-
向伸缩组添加虚拟服务器组时需要满足以下条件:
-
负载均衡实例与伸缩组必须属于同一账号。
-
负载均衡实例与伸缩组必须处于同一地域。
-
负载均衡实例必须处于运行中状态。
-
负载均衡实例至少配置有一个监听且必须开启健康检查。
-
如果负载均衡实例与伸缩组的网络类型均为 VPC,必须处于同一 VPC。
-
当伸缩组的网络类型为 VPC,负载均衡实例的网络类型为经典网络时,如果虚拟服务器组包含 VPC 实例,该实例必须与伸缩组处于同一 VPC。
-
待添加虚拟服务器组必须属于对应的负载均衡实例。
-
不超过伸缩组内虚拟服务器组的限额,具体限额,请参见使用限制。
-
-
添加伸缩组内虚拟服务器组时,需要同时指定以下属性:
-
负载均衡实例 ID(LoadBalancerId)
-
虚拟服务器组 ID(VServerGroupId)
-
虚拟服务器组端口号(Port)
说明 如果通过不同的端口号将同一虚拟服务器组添加至伸缩组,视为伸缩组内添加了多个虚拟服务器组。如果请求参数中的虚拟服务器组 ID 和端口号同时重复,默认使用最先配置的一组,忽略其余虚拟服务器组。 -
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ess:AttachVServerGroups | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 伸缩组所属地域的 ID。如 cn-hangzhou、cn-shanghai,更多信息,请参见地域和可用区。 | cn-hangzhou |
ScalingGroupId | string | 是 | 伸缩组的 ID。 | asg-bp18p2yfxow2dloq**** |
ClientToken | string | 否 | 保证请求幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
ForceAttach | boolean | 否 | 是否将当前伸缩组内的 ECS 实例或 ECI 实例添加到新增的虚拟服务器组。取值范围:
默认值:false。 | false |
VServerGroups | array<object> | 是 | 伸缩组关联的虚拟服务器组的信息集合。 | |
object | 是 | 伸缩组关联的虚拟服务器组的信息集合。 | ||
VServerGroupAttributes | array<object> | 否 | 虚拟服务器组属性。 | |
object | 否 | 虚拟服务器组属性。 | ||
VServerGroupId | string | 否 | 虚拟服务器组的 ID。 | lb-bp1u7etiogg38yvwz**** |
Weight | integer | 否 | 弹性伸缩将 ECS 实例或 ECI 实例添加到虚拟服务器组时设置的权重,取值范围:0~100。 默认值:50。 | 100 |
Port | integer | 否 | 弹性伸缩将 ECS 实例或 ECI 实例添加到虚拟服务器组时使用的端口号,取值范围:1~65535。 | 22 |
LoadBalancerId | string | 否 | 虚拟服务器组所属负载均衡实例的 ID。 | rsp-bp1jp1rge**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|