ScaleWithAdjustment_弹性伸缩_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 调用该接口前,请确保满足以下条件:
    • 伸缩组处于 Active 状态。
    • 伸缩组内没有执行中的伸缩活动。
  • 当伸缩组没有执行中的伸缩活动时,该接口可以绕过冷却时间(Cooldown)直接执行伸缩活动。
  • 如果伸缩规则需要增加的 ECS 实例数加上当前伸缩组的实例数(Total Capacity)大于最大实例数(MaxSize),则按 Total Capacity=MaxSize 执行伸缩活动。
  • 如果当前伸缩组内的实例数(Total Capacity)减去伸缩规则需要减少的 ECS 实例数小于最小实例数(MinSize),则按 Total Capacity=MinSize 执行伸缩活动。

调用该接口返回成功,只是表示弹性伸缩服务接受了该接口的调用请求,可以执行伸缩活动,但不代表伸缩活动能够执行成功。您需要通过返回的ScalingActivityId查看该伸缩活动的执行状态。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ess:ScaleWithAdjustment
Update
ScalingGroup
acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

请求参数

字段名称字段详情
ScalingGroupIdstring

伸缩组的 ID。

示例值:asg-j6c1o397427hyjdc****参考取值来源:
    ApplyScalingGroup
    CreateScalingGroup
    DescribeScalingGroups
    AttachServerGroups
    DetachServerGroups
AdjustmentTypestring

伸缩活动调整方式,取值范围:展开详情

示例值:QuantityChangeInCapacity
AdjustmentValueinteger<int32>

伸缩活动调整值。任何情况下,单次调整的 ECS 实例台数都不能超过 1000,否则会导致调整失败。不同调整方式对应的取值范围:展开详情

示例值:100取值 <= 2147483647
MinAdjustmentMagnitudeinteger<int32>

伸缩活动最小调整实例数,仅当AdjustmentTypePercentChangeInCapacity时生效。

示例值:1
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

示例值:123e4567-e89b-12d3-a456-42665544****
SyncActivityboolean

伸缩活动同步执行开关,仅对具有期望实例数配置项的伸缩组有效。取值范围:展开详情

示例值:false
Overridesobject

ECI 伸缩组扩容指定覆写参数。

LifecycleHookContextobject

生命周期挂钩上下文信息。

ActivityMetadatastring

伸缩活动的元数据。

示例值:{"key":"value"}

返回参数

字段名称字段详情
ScalingActivityIdstring

伸缩活动的 ID。

示例值:asa-bp175o6f6ego3r2j****
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ActivityTypestring

伸缩活动的类型。展开详情

示例值:CapacityChange

返回示例

变更历史

变更时间变更内容概要操作
2024-03-13
新增请求参数LifecycleHookContext
新增请求参数ActivityMetadata
2023-12-06
新增请求参数Overrides
2022-11-02
变更返回参数
  • 1
  • 2
  • 10 条/页

相关示例