对于需要动态调整实例数量来应对业务变化负载以及确保应用程序的高可用性场景,调用API AttachServerGroups为伸缩组添加一个或多个负载均衡服务器组,支持的服务器组类型包括应用型负载均衡ALB和网络型负载均衡NLB,可以在业务变化时自动实现弹性扩展,并根据负载情况动态分配流量、提高应用程序的稳定性。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ess:AttachServerGroups | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 伸缩组所属地域的 ID。 | cn-hangzhou |
ScalingGroupId | string | 是 | 伸缩组的 ID。 | asg-bp1fo0dbtsbmqa9h**** |
ClientToken | string | 否 | 保证请求幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
ForceAttach | boolean | 否 | 是否将当前伸缩组内的 ECS 实例或 ECI 实例添加到新增的服务器组。取值范围:
默认值:false。 | false |
ServerGroups | array<object> | 是 | 负载均衡服务器组的相关信息集合。 | |
object | 是 | 负载均衡服务器组的相关信息集合。 | ||
ServerGroupId | string | 是 | 负载均衡服务器组 ID。 | sgp-5yc3bd9lfyh***** |
Type | string | 是 | 负载均衡服务器组类型。取值范围:
| ALB |
Weight | integer | 是 | 弹性伸缩将 ECS 实例或 ECI 实例添加到服务器组后,ECS 实例或 ECI 实例作为后端服务器的权重。取值范围:0~100。 权重越高,ECS 实例或 ECI 实例将被分配到越多的访问请求。如果权重为 0,则 ECS 实例或 ECI 实例不会收到访问请求。 | 100 |
Port | integer | 是 | 弹性伸缩将 ECS 实例或 ECI 实例添加到服务器组后,ECS 实例或 ECI 实例使用的端口号。 取值范围:1~65535。 | 22 |
返回参数
示例
正常返回示例
JSON
格式
{
"ScalingActivityId": "asa-bp1c9djwrgxjyk31****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-18 | API 内部配置变更,不影响调用 | 查看变更详情 |