弹性伸缩API介绍（2022-02-22）_弹性伸缩(ESS)-阿里云帮助中心

本产品（弹性伸缩/2022-02-22）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

伸缩组

API	标题	API概述
CreateScalingGroup	创建一个伸缩组	如果您需要根据业务变动需求与策略自动增加或减少指定类型的实例数量，则可以通过调用API CreateScalingGroup创建伸缩组来自动调整您的业务计算能力（即实例数量）。
ModifyScalingGroup	修改一个伸缩组	如果您需要根据业务变动需求与策略自动增加或减少指定类型的实例数量，则可以通过配置伸缩组来自动调整您的业务计算能力（即实例数量）。如果当前伸缩组属性不再满足业务需求，则您可以调用API ModifyScalingGroup修改伸缩组属性（例如最大实例数、最小实例数或期望实例数等属性），避免重新创建伸缩组并重新配置相关属性，节省了时间和资源成本。
EnableScalingGroup	启用一个伸缩组	如果伸缩组处于停用状态，并且该伸缩组已通过指定启动模板方式或者创建并启用伸缩配置方式指定了实例配置来源，您可以调用API EnableScalingGroup启用一个伸缩组，通过弹性伸缩来自动调整您的业务计算能力（即实例数量）。
DisableScalingGroup	停用一个伸缩组	停用一个伸缩组。
SetGroupDeletionProtection	为伸缩组开启或关闭删除保护	如果开启伸缩组删除保护功能后，此时不能删除该伸缩组；如果关闭伸缩组删除保护功能，此时可直接删除该伸缩组，本文为您介绍如何调用API SetGroupDeletionProtection为伸缩组开启或关闭伸缩组删除保护功能。
DeleteScalingGroup	删除一个伸缩组	如果您需要根据业务变动需求与策略自动增加或减少指定类型的实例数量，则可以通过配置伸缩组来自动调整您的业务计算能力（即实例数量）。如果您不再需要某个伸缩组，可以调用API DeleteScalingGroup删除该伸缩组来空出伸缩组配额。
DescribeScalingGroups	查询伸缩组列表	如果您需要查看伸缩组的基本信息、伸缩组内实例、伸缩配置等信息，您可以通过调用API DescribeScalingGroups查询该伸缩组。
DescribeScalingGroupDetail	查询指定伸缩组详情	查看指定伸缩组的基本信息、伸缩组内实例、伸缩配置等信息，您可以通过调用DescribeScalingGroupDetail查询该伸缩组。当ECI类型伸缩组指定OutputFormat参数为YAML时，可以输出K8s Deployment YAML格式内容。
DescribeScalingInstances	查询伸缩组内ECS实例列表	查询伸缩组内ECS实例的列表，并列出ECS实例的信息。
DescribeScalingActivities	查询伸缩活动	查询伸缩活动。
DescribeScalingActivityDetail	查询一个伸缩活动的详细信息	查询一个伸缩活动的详细信息。
AttachLoadBalancers	添加一个或多个负载均衡实例	伸缩组支持关联负载均衡实例，通过负载均衡实例将访问流量分发到伸缩组内的多个实例中，可以有效增强伸缩组的服务能力，您可以调用API AttachLoadBalancers添加一个或多个负载均衡实例。
DetachLoadBalancers	移除一个或多个负载均衡实例	移除一个或多个负载均衡实例。
AttachDBInstances	添加一个或多个RDS实例	通过调用API AttachDBInstances为伸缩组添加一个或多个RDS实例，可实现根据您的需要随时调整伸缩组内的RDS实例数量，增加您使用上的灵活性与实用性。
DetachDBInstances	移除一个或多个RDS实例	如果您需要减少伸缩组内的RDS实例，可以通过调用API DetachDBInstance移除一个或多个RDS实例，来改变伸缩组与RDS实例的强行绑定关系，增加您使用上的灵活性与实用性。
SuspendProcesses	暂停伸缩组中的指定流程	通过调用API SuspendProcesses主动暂停伸缩组某些指定流程，然后去执行其他操作，方便您更加精细地控制伸缩组活动。
ResumeProcesses	恢复伸缩组中被暂停的流程	您可以主动调用API ResumeProcesses恢复伸缩组中被暂停的流程，由伸缩组继续按功能逻辑执行指定流程。例如，您恢复健康检查流程后，如果伸缩组某实例被视为不健康就会自动被移出伸缩组。
AttachVServerGroups	添加负载均衡实例下虚拟服务器组	伸缩组关联负载均衡实例（CLB）后，加入伸缩组的实例会自动添加为CLB实例的后端服务器，处理来自CLB实例转发的访问请求。当需要将不同的请求转发到不同的后端服务器上时，或需要通过域名和URL进行请求转发时，您可以调用API AttachVServerGroups来添加负载均衡实例下的一个或者多个虚拟服务器组，通过虚拟服务器组管理不同的后端服务器。
DetachVServerGroups	移除一个或者多个虚拟服务器组	伸缩组支持关联负载均衡实例，可以有效增强伸缩组的服务能力。如果您的业务暂不需要通过负载均衡实例将访问流量分发到伸缩组内的多个实例中去，您可以调用API DetachVServerGroups移除一个或者多个虚拟服务器组。
AttachAlbServerGroups	添加一个或多个ALB服务器组	对于需要动态调整实例数量来应对业务变化负载以及确保应用程序的高可用性场景，调用API AttachAlbServerGroups向伸缩组添加一个或多个ALB服务器组，可以在业务变化时自动实现弹性扩展，并根据负载情况动态分配流量、提高应用程序的稳定性。
DetachAlbServerGroups	移出一个或多个ALB服务器组	从伸缩组移出一个或多个ALB服务器组。
AttachServerGroups	添加一个或多个负载均衡服务器组	对于需要动态调整实例数量来应对业务变化负载以及确保应用程序的高可用性场景，调用API AttachServerGroups为伸缩组添加一个或多个负载均衡服务器组，支持的服务器组类型包括应用型负载均衡ALB和网络型负载均衡NLB，可以在业务变化时自动实现弹性扩展，并根据负载情况动态分配流量、提高应用程序的稳定性。
DetachServerGroups	移除一个或多个负载均衡服务器组	对于需要动态调整实例数量来应对业务变化负载以及确保应用程序的高可用性场景，调用API DetachServerGroups从伸缩组移除一个或多个负载均衡服务器组，支持的服务器组类型包括应用型负载均衡ALB和网络型负载均衡NLB，可以实现对负载均衡策略的动态调整，并帮助提高系统的高可用性。
ChangeResourceGroup	更改伸缩组所属的资源组	资源组指对您拥有的云资源（例如伸缩组资源）从用途、权限、归属等维度上进行分组，实现企业内部多用户、多项目的资源分级管理。您可以调用API ChangeResourceGroup将伸缩组资源从一个资源组更改到另一个资源组，在新的资源组里集中监控和管理该伸缩组资源，免去了您在多种阿里云服务间反复查看资源的负担。
ApplyScalingGroup	基于配置文件管理伸缩组	如果您需要通过配置文件方式快速创建、管理伸缩组，则可以通过调用API ApplyScalingGroup来创建和管理伸缩组。

伸缩配置

API	标题	API概述
CreateScalingConfiguration	创建一个ECS类型伸缩配置	调用API CreateScalingConfiguration接口创建一个ECS类型的伸缩配置，方便弹性伸缩在触发弹性扩张活动时以该伸缩配置为模板自动创建ECS实例。
DescribeScalingConfigurations	查询ECS类型伸缩配置信息	调用API DescribeScalingConfigurations查询ECS类型伸缩配置的信息，方便您提前了解弹性扩张时使用的ECS实例模板详情。
ModifyScalingConfiguration	修改一个ECS类型伸缩配置	如果当前的伸缩配置不满足业务需求，您可以通过调用API ModifyScalingConfiguration修改ECS类型的伸缩配置（即待扩容的ECS实例模板）。
DeleteScalingConfiguration	删除一个ECS类型伸缩配置	删除一个伸缩配置。
CreateEciScalingConfiguration	创建一个ECI类型伸缩配置	创建一个ECI类型的伸缩配置，弹性伸缩会以该伸缩配置作为ECI实例使用的模板，在触发弹性扩容活动时自动创建ECI实例满足您的业务需求。
DescribeEciScalingConfigurations	查询ECI类型伸缩配置信息	查询ECI类型的伸缩配置信息，了解伸缩配置详情，方便创建ECI实例时选用合适的模板。
DescribeEciScalingConfigurationDetail	查询指定ECI类型伸缩配置信息详情	查询ECI类型的伸缩配置信息，了解伸缩配置详情，方便创建ECI实例时选用合适的模板。当指定OutputFormat参数为YAML时，可以输出K8s Deployment YAML格式内容。
ModifyEciScalingConfiguration	修改一个ECI类型伸缩配置	如果当前ECI类型的伸缩配置已不满足业务需求，您可以调用ModifyEciScalingConfiguration修改该伸缩配置参数。
ApplyEciScalingConfiguration	基于配置文件管理伸缩配置	如果您需要通过配置文件方式快速创建、管理ECI伸缩组伸缩配置，则可以通过调用ApplyEciScalingConfiguration来创建、更新ECI伸缩组伸缩配置。
DeleteEciScalingConfiguration	删除一个ECI类型伸缩配置	当前伸缩配置处于未生效状态，且伸缩组中不存在使用该伸缩配置自动创建的ECI实例，您可以调用API DeleteEciScalingConfiguration删除不再需要的一个ECI类型的伸缩配置，可以有效避免占用伸缩配置的配额。

伸缩规则

API	标题	API概述
CreateScalingRule	创建一条伸缩规则	伸缩规则的作用由伸缩规则的类型来决定，可用于触发伸缩活动或者智能设置伸缩组边界值。根据不同业务需求，通过调用API CreateScalingRule创建不同类型的伸缩规则，例如，业务需要只能设置伸缩组边界值，建议您选择预测规则类型。
ModifyScalingRule	修改一条伸缩规则	创建伸缩规则后，如果当前伸缩规则不再满足需求，您可以调用API ModifyScalingRule修改一项或多项伸缩规则属性，无需重新创建新的伸缩规则，避免不必要的重复操作，节约时间和资源成本。
DescribeScalingRules	查询伸缩规则	查询伸缩组下的伸缩规则，并列出伸缩规则的信息。
DeleteScalingRule	删除一条伸缩规则	删除一条伸缩规则。

触发任务

API	标题	API概述
ExecuteScalingRule	执行一条伸缩规则	执行一条伸缩规则。
ScaleWithAdjustment	基于指定调整规则触发性扩缩容	基于指定调整规则触发弹性扩缩容。
AttachInstances	为伸缩组手动添加实例	将实例添加到伸缩组中并提供服务。通过调用AttachInstances，您可以将伸缩组以外ECS实例、ECI实例或托管实例添加到伸缩组中提供服务，或者将伸缩组中处于节省停机状态的ECS实例重新启动变为服务状态在伸缩组中提供服务。
RemoveInstances	从一个伸缩组删除一台或多台实例	从一个伸缩组删除一台或多台ECS实例或ECI实例。
DetachInstances	从一个伸缩组移出一台或多台实例	从一个伸缩组移出一台或多台ECS实例、ECI实例或托管实例。

定时任务

API	标题	API概述
CreateScheduledTask	创建一个定时任务	定时任务是一种预设任务，您可以通过调用API CreateScheduledTask创建一个定时任务，在指定时间执行指定伸缩规则，实现计算资源的自动扩张或收缩，来满足业务需求的同时又能控制成本。
ModifyScheduledTask	修改一个定时任务的信息	修改一个定时任务的信息。
DescribeScheduledTasks	查询定时任务的信息	定时任务是一种预设任务，可以在指定时间执行指定的伸缩规则，实现计算资源的自动扩缩容。定时任务创建完成后，您可以调用API DescribeScheduledTasks查询定时任务的详细信息，例如，定时任务的触发时间点、定时任务总数、执行定时任务的伸缩组的ID等。
DeleteScheduledTask	删除一个定时任务	针对业务量的变化时间可预测的场景，您可以通过配置定时任务，在业务高峰到达前已准备好充足的计算资源，或者在业务高峰后及时释放空闲的计算资源，满足业务需求的同时又能控制成本。如果当前定时任务不再使用，您也可以调用API DeleteScheduledTask直接删除该定时任务。

报警任务

API	标题	API概述
CreateAlarm	创建一个报警任务	创建一个报警任务。
DescribeAlarms	查询报警任务的信息	查询报警任务的信息。
ModifyAlarm	修改报警任务	修改一个报警任务。
EnableAlarm	启用一个报警任务	针对具有突发性或时间上不易预测的业务，您可以通过报警任务关联云监控指标管理业务变化。弹性伸缩在统计值满足报警条件时触发报警，并在生效周期内自动执行伸缩规则，动态调整伸缩组内的ECS实例或ECI实例数量。如果您需要继续使用一个已停用的报警任务，可以调用API EnableAlarm启用一个报警任务。
DisableAlarm	停用一个报警任务	针对具有突发性或时间上不易预测的业务，您可以通过报警任务关联云监控指标管理业务变化。弹性伸缩在统计值满足报警条件时触发报警，并在生效周期内自动执行伸缩规则，动态调整伸缩组内的ECS实例或ECI实例数量。如果您暂时不需要一个报警任务触发伸缩活动，可以调用API DisableAlarm停用该报警任务。
DeleteAlarm	删除一个报警任务	针对具有突发性或时间上不易预测的业务，您可以通过报警任务关联云监控指标进行管理。弹性伸缩会实时统计指标数据，在统计值满足报警条件时触发报警，并在生效周期内自动执行伸缩规则，动态调整伸缩组内的ECS实例或ECI实例数量。如果您不再使用当前的报警任务，您也可以调用API DeleteAlarm直接删除该报警任务。

生命周期挂钩

API	标题	API概述
CreateLifecycleHook	为伸缩组创建一个或多个生命周期挂钩	为伸缩组创建一个或多个生命周期挂钩。
ModifyLifecycleHook	修改一个生命周期挂钩的信息	修改一个生命周期挂钩的信息。
DescribeLifecycleHooks	查询生命周期挂钩	查询生命周期挂钩。
RecordLifecycleActionHeartbeat	延长生命周期挂钩触发后被挂起等待时间	延长一个生命周期挂钩触发后被挂起的ECS实例的等待时间。
DescribeLifecycleActions	伸缩活动对应的生命周期操作	查看伸缩活动对应的生命周期操作。
CompleteLifecycleAction	提前结束伸缩活动的等待状态	如果您为伸缩组配置了生命周期挂钩功能，您可以根据实际业务需要，调用API CompleteLifecycleAction提前结束伸缩活动的等待状态去执行下一步动作。
DeleteLifecycleHook	删除一个生命周期挂钩	删除一个生命周期挂钩。

事件通知

API	标题	API概述
CreateNotificationConfiguration	创建弹性伸缩事件及资源变化通知	调用API CreateNotificationConfiguration创建弹性伸缩事件及资源变化通知，帮助您及时掌握伸缩组的动态，进一步实现弹性伸缩事件的自动化管理。
ModifyNotificationConfiguration	修改一条弹性伸缩事件及资源变化通知	事件通知支持在发生指定类型的事件后，自动发送消息到云监控、MNS主题和MNS队列，可以帮助您及时掌握伸缩组的动态，进一步实现自动化管理。如果当前事件通知的类型不再满足业务需求，您可以调用API ModifyNotificationConfiguration修改弹性伸缩事件及资源变化通知，您无需重新创建新的事件通知，但不支持修改事件通知的通知方式。
DescribeNotificationConfigurations	查询弹性伸缩事件及资源变化通知	查询您创建的弹性伸缩事件及资源变化通知。
DeleteNotificationConfiguration	删除一条弹性伸缩事件及资源变化通知	事件通知支持在发生指定类型的事件后，自动发送消息到云监控、MNS主题和MNS队列，以便您及时对事件进行定位和处理。如果当前事件通知不再使用，调用API DeleteNotificationConfiguration删除该条弹性伸缩事件及资源变化通知。
DescribeNotificationTypes	查询弹性伸缩事件及资源变化通知的类型	查询弹性伸缩事件及资源变化通知的类型。

实例

API	标题	API概述
EnterStandby	将伸缩组内的ECS实例设置为备用状态	将伸缩组内的ECS实例设置为备用状态。
ExitStandby	使备用状态实例进入运行状态	伸缩组内发生伸缩活动时，不会移出处于备用状态的ECS实例或ECI实例。如果您需要再次使用该实例，可以调用API ExitStandby将伸缩组中处于备用状态的ECS实例或ECI实例移出备用状态并转化为运行状态。
RebalanceInstances	重新平衡ECS实例分布	如果由于库存不足等原因导致可用区之间ECS实例的数量不均衡，您可以通过调用API RebalanceInstances重新平衡多可用区伸缩组内ECS实例的分布。
SetInstanceHealth	设置伸缩组内ECS实例的健康状态	在某些情况下，自动健康检查可能无法准确发现ECS实例或ECI实例的健康状态，通过手动设置实例的健康状态可以对故障实例进行快速识别和处理。此时，您可以调用API SetInstanceHealth设置伸缩组内ECS实例或ECI实例的健康状态，能够更好地应对实际的业务需求和运维情况。
SetInstancesProtection	开始或停止保护伸缩组内ECS实例	调用API SetInstancesProtection可以保护或停止保护伸缩组内的一台或者多台ECS实例，开启ECS实例的保护功能后，您将无法通过控制台、API或命令行等方式手动释放该实例，避免该实例被意外释放，造成不可挽回的后果。

地域

API	标题	API概述
DescribeRegions	查询可以使用弹性伸缩服务的地域	在使用弹性伸缩前，您可以先通过调用API DescribeRegions查询可以在哪些地域使用弹性伸缩服务，方便您选择最适合的地域和可用区来使用弹性伸缩服务，确保在所选地域内获得良好的访问性能。

API	标题	API概述
TagResources	为资源列表创建并绑定标签	为指定的弹性伸缩资源列表统一创建并绑定标签。
ListTagResources	查询弹性伸缩资源已经绑定的标签列表	查询一个或多个弹性伸缩资源已经绑定的标签列表。
UntagResources	为指定的弹性伸缩资源列表统一解绑标签	调用API UntagResources为指定的弹性伸缩资源列表统一解绑标签，可以简化资源管理、提高系统性能优化、降低安全风险。解绑标签后，如果该标签没有绑定其他任何资源，则会被自动删除。
ListTagKeys	查询弹性伸缩资源标签键的列表	调用API ListTagKeys查询弹性伸缩资源标签键的列表，有利于您对弹性伸缩资源进行分类、识别以及监控等，提供更灵活和便捷的资源管理。
ListTagValues	查询弹性伸缩资源标签键对应的标签值	调用API ListTagValues查询弹性伸缩资源标签键对应的标签值，能够帮助您更好地了解弹性伸缩资源，实现资源的有效分类和管理。

其他

API	标题	API概述
VerifyUser	验证是否已开通弹性伸缩服务	调用API VerifyUser验证是否已开通弹性伸缩服务，可以保证业务出现流量波动或负载变化时，系统能够自动扩缩容资源，有助于提高系统的稳定性、可用性和灵活性。
VerifyAuthentication	检测是否已授权弹性伸缩操作ECS和ECI资源	检测是否已授权弹性伸缩调操作ECS和ECI资源。
DescribeLimitation	查询资源配额限制	调用API DescribeLimitation查询资源配额限制。例如查询支持创建定时任务的最大值、查询支持关联负载均衡实例的最大数量、查询支持设置伸缩组内最大实例数以及伸缩配置最大数量等。
ModifyInstanceAttribute	修改伸缩组内实例的部分信息	调用ModifyInstanceAttribute修改伸缩组中一台ECS实例的部分信息，目前仅支持修改手动添加到伸缩组中实例的生命周期托管属性。

伸缩组