本产品(
弹性伸缩/2022-02-22
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
伸缩组
API | 标题 | API概述 |
---|---|---|
CreateScalingGroup | 创建一个伸缩组 | 如果您需要根据业务变动需求与策略自动增加或减少指定类型的实例数量,则可以通过调用API CreateScalingGroup创建伸缩组来自动调整您的业务计算能力(即实例数量)。 |
ModifyScalingGroup | 修改一个伸缩组 | 如果您需要根据业务变动需求与策略自动增加或减少指定类型的实例数量,则可以通过配置伸缩组来自动调整您的业务计算能力(即实例数量)。如果当前伸缩组属性不再满足业务需求,则您可以调用API ModifyScalingGroup修改伸缩组属性(例如最大实例数、最小实例数或期望实例数等属性),避免重新创建伸缩组并重新配置相关属性,节省了时间和资源成本。 |
EnableScalingGroup | 启用一个伸缩组 | 如果伸缩组处于停用状态,并且该伸缩组已通过指定启动模板方式或者创建并启用伸缩配置方式指定了实例配置来源,您可以调用API EnableScalingGroup启用一个伸缩组,通过弹性伸缩来自动调整您的业务计算能力(即实例数量)。 |
DisableScalingGroup | 停用一个伸缩组 | 如果伸缩组处于启用状态,并且您暂时不需要该伸缩组执行伸缩活动,您可以调用API DisableScalingGroup停用该伸缩组。 |
SetGroupDeletionProtection | 为伸缩组开启或关闭删除保护 | 如果开启伸缩组删除保护功能后,此时不能删除该伸缩组;如果关闭伸缩组删除保护功能,此时可直接删除该伸缩组,本文为您介绍如何调用API SetGroupDeletionProtection为伸缩组开启或关闭伸缩组删除保护功能。 |
DeleteScalingGroup | 删除一个伸缩组 | 如果您需要根据业务变动需求与策略自动增加或减少指定类型的实例数量,则可以通过配置伸缩组来自动调整您的业务计算能力(即实例数量)。如果您不再需要某个伸缩组,可以调用API DeleteScalingGroup删除该伸缩组来空出伸缩组配额。 |
DescribeScalingGroups | 查询伸缩组列表 | 如果您需要查看伸缩组的基本信息、伸缩组内实例、伸缩配置等信息,您可以通过调用API DescribeScalingGroups查询该伸缩组。 |
DescribeScalingGroupDetail | 查询指定伸缩组详情 | 您可以通过调用API DescribeScalingGroupDetail查询该伸缩组详情,例如,查看指定伸缩组的基本信息、伸缩组内实例、伸缩配置等信息。当ECI类型的伸缩组指定OutputFormat参数为YAML时,可以输出Kubernetes Deployment YAML格式内容。 |
DescribeScalingInstances | 查询伸缩组内ECS实例列表 | 调用DescribeScalingInstances,通过伸缩组ID查询该伸缩组内的ECS实例列表及实例信息,包括当前伸缩组中,运行状态的抢占式实例总数、ECS实例总数、ECS实例的预热状态、生命周期状态等。同时也支持指定实例健康状态、生命周期状态、创建方式等筛选符合要求的ECS实例。 |
DescribeScalingActivities | 查询伸缩活动 | 通过API DescribeScalingActivities查看伸缩活动的详情,了解通过定时任务、报警任务或手动执行伸缩规则等方式触发伸缩活动的结果。例如,您可以在伸缩活动详情页查看到伸缩活动的状态、活动起因、变化后总实例数等信息。 |
DescribeScalingActivityDetail | 查询一个伸缩活动的详细信息 | 调用DescribeScalingActivityDetail接口,通过伸缩组中伸缩活动ID查询伸缩活动的详细信息,包括伸缩活动状态,错误码和错误信息等,根据错误信息进行故障排查与性能分析。 |
AttachLoadBalancers | 添加一个或多个负载均衡实例 | 伸缩组支持关联负载均衡实例,通过负载均衡实例将访问流量分发到伸缩组内的多个实例中,可以有效增强伸缩组的服务能力,您可以调用API AttachLoadBalancers添加一个或多个负载均衡实例。 |
DetachLoadBalancers | 移除一个或多个负载均衡CLB实例 | 如果当前弹性伸缩组关联的负载均衡实例不能满足您的需求或者您需要取消关联,调用DetachLoadBalancers,通过指定伸缩组的ID、负载均衡实例的ID、ForceDetach等配置参数,移除一个或多个负载均衡 CLB(原 SLB)实例,同时可以选择异步调用以及是否移除负载均衡实例后端服务器中属于当前伸缩组的ECS实例。该接口仅支持移除负载均衡 CLB(原 SLB)实例。 |
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服务器组 | 调用DetachAlbServerGroups,并可以指定伸缩组的ID、ALB 服务器组的ID、ALB 服务器组中 ECS 实例使用的端口号等参数,实现从伸缩组中移出一个或多个ALB服务器组。 |
AttachServerGroups | 添加一个或多个负载均衡服务器组 | 对于需要动态调整实例数量来应对业务变化负载以及确保应用程序的高可用性场景,调用API AttachServerGroups为伸缩组添加一个或多个负载均衡服务器组,支持的服务器组类型包括应用型负载均衡ALB和网络型负载均衡NLB,可以在业务变化时自动实现弹性扩展,并根据负载情况动态分配流量、提高应用程序的稳定性。 |
DetachServerGroups | 移除一个或多个负载均衡服务器组 | 对于需要动态调整实例数量来应对业务变化负载以及确保应用程序的高可用性场景,调用API DetachServerGroups从伸缩组移除一个或多个负载均衡服务器组,支持的服务器组类型包括应用型负载均衡ALB和网络型负载均衡NLB,可以实现对负载均衡策略的动态调整,并帮助提高系统的高可用性。 |
ChangeResourceGroup | 更改伸缩组所属的资源组 | 资源组指对您拥有的云资源(例如伸缩组资源)从用途、权限、归属等维度上进行分组,实现企业内部多用户、多项目的资源分级管理。您可以调用API ChangeResourceGroup将伸缩组资源从一个资源组更改到另一个资源组,在新的资源组里集中监控和管理该伸缩组资源,免去了您在多种阿里云服务间反复查看资源的负担。 |
ApplyScalingGroup | 基于配置文件管理伸缩组 | 如果您需要通过配置文件方式快速创建、管理伸缩组,则可以通过调用API ApplyScalingGroup来创建和管理伸缩组。 |
DescribeElasticStrength | 查询伸缩组的弹性强度 | 伸缩组配置的有效性很大程度决定了扩容过程的成功率。弹性伸缩通过弹性强度描述伸缩配置的有效性,让配置的优良程度量化,帮助用户针对性的优化伸缩配置。 |
伸缩配置
API | 标题 | API概述 |
---|---|---|
CreateScalingConfiguration | 创建一个ECS类型伸缩配置 | 通过调用CreateScalingConfiguration接口,并指定伸缩组ID、实例规格、实例镜像等信息,为伸缩组创建一个ECS类型的伸缩配置。 |
DescribeScalingConfigurations | 查询ECS类型伸缩配置信息 | 调用API DescribeScalingConfigurations查询ECS类型伸缩配置的信息,包括实例规格、镜像等信息,方便您提前了解弹性扩张时使用的ECS实例模板详情。 |
ModifyScalingConfiguration | 修改一个ECS类型伸缩配置 | 如果当前的伸缩配置不满足业务需求,您可以通过调用API ModifyScalingConfiguration修改ECS类型的伸缩配置(即待扩容的ECS实例模板)。 |
DeleteScalingConfiguration | 删除一个ECS类型伸缩配置 | 删除一个伸缩配置。 |
CreateEciScalingConfiguration | 创建一个ECI类型伸缩配置 | 创建一个ECI类型的伸缩配置,弹性伸缩会以该伸缩配置作为ECI实例使用的模板,在触发弹性扩容活动时自动创建ECI实例满足您的业务需求。 |
DescribeEciScalingConfigurations | 查询ECI类型伸缩组的伸缩配置信息 | 通过调用DescribeEciScalingConfigurations,并指定伸缩组的ID、伸缩配置的ID或名称等参数查询ECI类型的伸缩配置信息,例如实例的抢占策略、容器组的实例规格、容器镜像的拉取策略、ECI实例作为后端服务器时的权重等。 |
DescribeEciScalingConfigurationDetail | 查询ECI类型伸缩配置信息 | 调用API DescribeEciScalingConfigurationDetail,通过伸缩组的伸缩配置ID查询对应的伸缩配置信息(例如临时存储空间大小、IPv6地址数、弹性公网IP的带宽等),支持输出为YAML格式。 |
ModifyEciScalingConfiguration | 修改一个ECI类型伸缩配置 | 调用ModifyEciScalingConfiguration,并可以指定待修改伸缩配置的ID、伸缩配置的名称、ECI实例的属性等参数,修改伸缩配置,例如实例重启策略、实例的抢占策略、弹性公网 IP 的带宽等信息。 |
ApplyEciScalingConfiguration | 基于配置文件管理伸缩配置 | 如果您需要通过配置文件方式快速创建和管理ECI类型的伸缩配置,则可以通过调用API ApplyEciScalingConfiguration来创建或更新ECI类型的伸缩配置。 |
DeleteEciScalingConfiguration | 删除一个ECI类型伸缩配置 | 当前伸缩配置处于未生效状态,且伸缩组中不存在使用该伸缩配置自动创建的ECI实例,您可以调用API DeleteEciScalingConfiguration删除不再需要的一个ECI类型的伸缩配置,可以有效避免占用伸缩配置的配额。 |
DescribePatternTypes | 根据实例属性查询实例规格 | 调用DescribePatternTypes接口,并可以指定交换机的ID、实例的vCPU核数、内存大小、规格族级别以及可接受的最高价格等参数,筛选出符合要求的实例规格。 |
伸缩规则
API | 标题 | API概述 |
---|---|---|
CreateScalingRule | 创建一条伸缩规则 | 伸缩规则的作用由伸缩规则的类型来决定,可用于触发伸缩活动或者智能设置伸缩组边界值。根据不同业务需求,通过调用API CreateScalingRule创建不同类型的伸缩规则,例如,业务需要只能设置伸缩组边界值,建议您选择预测规则类型。 |
ModifyScalingRule | 修改一条伸缩规则 | 创建伸缩规则后,如果当前伸缩规则不再满足需求,您可以调用API ModifyScalingRule修改一项或多项伸缩规则属性,无需重新创建新的伸缩规则,避免不必要的重复操作,节约时间和资源成本。 |
DescribeScalingRules | 查询伸缩规则 | 调用DescribeScalingRules并指定伸缩规则ID、伸缩规则名称、伸缩规则唯一标识符等参数,查询伸缩规则及其详细信息。例如,伸缩规则的调整方式、实例预热时间、伸缩规则关联的报警任务信息等。 |
DeleteScalingRule | 删除一条伸缩规则 | 删除一条伸缩规则。 |
触发任务
API | 标题 | API概述 |
---|---|---|
ExecuteScalingRule | 执行一条伸缩规则 | 执行伸缩规则可以实现手动或自动调整ECS实例或ECI实例资源。其中,对于简单规则和步进规则,您才可以调用API ExecuteScalingRule执行一条伸缩规则,而对于目标追踪规则和预测规则,弹性伸缩会自动执行伸缩规则。 |
ScaleWithAdjustment | 基于指定调整规则触发性扩缩容 | 区别于ExecuteScalingRule接口,您无需提前创建伸缩规则,直接调用API ScaleWithAdjustment接口快速基于指定调整规则触发弹性扩缩容。 |
AttachInstances | 为伸缩组手动添加实例 | 调用API AttachInstances将实例手动添加到伸缩组中,即您可以将伸缩组以外的ECS实例、ECI实例或托管实例添加到伸缩组中并提供服务,或者将伸缩组中处于节省停机状态的ECS实例重新启动变为服务状态(运行中状态)并在伸缩组中提供服务。 |
RemoveInstances | 从一个伸缩组删除一台或多台实例 | 如果当前伸缩组状态为启用状态,且伸缩组内不存在执行中的伸缩活动,您可以调用API RemoveInstances从一个伸缩组删除一台或多台不再需要的实例。 |
DetachInstances | 从一个伸缩组移出一台或多台实例 | 如果当前伸缩组状态启用状态,且伸缩组内不存在执行中的伸缩活动,您可以调用API DetachInstances从一个伸缩组移出一台或多台ECS实例、ECI实例或托管实例。 |
定时任务
API | 标题 | API概述 |
---|---|---|
CreateScheduledTask | 创建一个定时任务 | 定时任务是一种预设任务,您可以通过调用API CreateScheduledTask创建一个定时任务,在指定时间执行指定伸缩规则,实现计算资源的自动扩张或收缩,来满足业务需求的同时又能控制成本。 |
ModifyScheduledTask | 修改一个定时任务的信息 | 如果当前伸缩组的定时任务不能满足业务需求,您可以调用ModifyScheduledTask接口,通过指定定时任务的ID修改已有定时任务的配置参数:需要执行的伸缩规则、伸缩组内实例数量、任务执行频率、重试策略等。 |
DescribeScheduledTasks | 查询定时任务的信息 | 定时任务是一种预设任务,可以在指定时间执行指定的伸缩规则,实现计算资源的自动扩缩容。定时任务创建完成后,您可以调用API DescribeScheduledTasks查询定时任务的详细信息,例如,定时任务的触发时间点、定时任务总数、执行定时任务的伸缩组的ID等。 |
DeleteScheduledTask | 删除一个定时任务 | 针对业务量的变化时间可预测的场景,您可以通过配置定时任务,在业务高峰到达前已准备好充足的计算资源,或者在业务高峰后及时释放空闲的计算资源,满足业务需求的同时又能控制成本。如果当前定时任务不再使用,您也可以调用API DeleteScheduledTask直接删除该定时任务。 |
报警任务
API | 标题 | API概述 |
---|---|---|
CreateAlarm | 创建一个报警任务 | 针对具有突发性或时间上不易预测的业务,调用CreateAlarm创建一个报警任务,该任务关联云监控指标后,可以动态调整伸缩组内的ECS实例或ECI实例数量,并实时监控实例指标,帮助您更好地管理和维护云资源。 |
DescribeAlarms | 查询报警任务的信息 | 调用API DescribeAlarms查询报警任务信息,及时了解已有报警任务的配置和监控项数据的变化趋势,帮助您实时发现系统资源异常,确保系统的稳定性和可靠性。 |
ModifyAlarm | 修改报警任务 | 修改一个报警任务。 |
EnableAlarm | 启用一个报警任务 | 针对具有突发性或时间上不易预测的业务,您可以通过报警任务关联云监控指标管理业务变化。弹性伸缩在统计值满足报警条件时触发报警,并在生效周期内自动执行伸缩规则,动态调整伸缩组内的ECS实例或ECI实例数量。如果您需要继续使用一个已停用的报警任务,可以调用API EnableAlarm启用一个报警任务。 |
DisableAlarm | 停用一个报警任务 | 针对具有突发性或时间上不易预测的业务,您可以通过报警任务关联云监控指标管理业务变化。弹性伸缩在统计值满足报警条件时触发报警,并在生效周期内自动执行伸缩规则,动态调整伸缩组内的ECS实例或ECI实例数量。如果您暂时不需要一个报警任务触发伸缩活动,可以调用API DisableAlarm停用该报警任务。 |
DeleteAlarm | 删除一个报警任务 | 针对具有突发性或时间上不易预测的业务,您可以通过报警任务关联云监控指标进行管理。弹性伸缩会实时统计指标数据,在统计值满足报警条件时触发报警,并在生效周期内自动执行伸缩规则,动态调整伸缩组内的ECS实例或ECI实例数量。如果您不再使用当前的报警任务,您也可以调用API DeleteAlarm直接删除该报警任务。 |
实例刷新
API | 标题 | API概述 |
---|---|---|
DescribeInstanceRefreshes | 查询实例刷新任务列表 | 如果您需要查看实例刷新任务的基本信息、 实例刷新任务的进度等信息,您可以调用DescribeInstanceRefreshes查询该伸缩组的实例刷新任务。 |
StartInstanceRefresh | 启动实例刷新任务 | 在您需要将新的伸缩配置应用到伸缩组实例中时,或需要更新伸缩组中实例的镜像时,您可以调用本接口完成伸缩组中实例的刷新。 |
CancelInstanceRefresh | 取消实例刷新任务 | 取消实例刷新任务,会保留已经完成替换和扩容的新实例。 |
RollbackInstanceRefresh | 回滚实例刷新任务 | 在实例刷新任务执行过程中,如果发现期望配置不符合需求,您可以调用此API来回滚实例刷新任务。在回滚时,系统将使用伸缩组当前生效的配置来创建新的实例,以替换那些基于期望配置创建的实例。 |
SuspendInstanceRefresh | 暂停实例刷新任务 | 实例刷新任务执行期间,如果您觉得配置存在问题,但不确定是否需要回滚,您可以调用此API暂停实例刷新任务,在此期间,您可以检查配置是否正确。 |
ResumeInstanceRefresh | 恢复暂停中的实例刷新任务 | 恢复一个处于暂停状态的实例刷新任务。 |
生命周期挂钩
API | 标题 | API概述 |
---|---|---|
CreateLifecycleHook | 为伸缩组创建一个或多个生命周期挂钩 | CreateLifecycleHook API用于在指定的弹性伸缩组中创建一个或多个生命周期挂钩。这些挂钩在实例的生命周期关键阶段(如启动、终止前)介入,使您能够执行自定义操作,如发送通知或执行自动化脚本等。通过此功能,您可以实现更细粒度的控制和管理,例如在实例被自动伸缩活动影响前后执行验证、配置或数据备份任务,从而增强应用部署的灵活性和可靠性。 |
ModifyLifecycleHook | 修改一个生命周期挂钩的信息 | 如果当前伸缩组的生命周期挂钩不能满足业务需求,您无需做删除操作,调用ModifyLifecycleHook,通过待修改生命周期挂钩的ID或名称,伸缩组的ID等参数,修改一个生命周期挂钩的信息,包括生命周期挂钩适用的伸缩活动类型,生命周期挂钩为伸缩组活动设置的等待时间,等待状态结束后的下一步动作等信息。 |
DescribeLifecycleHooks | 查询生命周期挂钩详情 | 调用DescribeLifecycleHooks通过指定生命周期挂钩ID或伸缩组ID来查询生命周期挂钩的信息,包括等待状态结束后的下一步动作、生命周期挂钩对应的伸缩活动类型、通知对象标识符、挂起等待时间等。 |
RecordLifecycleActionHeartbeat | 延长生命周期挂钩触发后ECS实例被挂起等待时间 | 如果伸缩组内生命周期挂钩触发后被挂起的ECS实例的等待时间不能满足您的自定义操作,在ECS实例被挂起状态下,调用RecordLifecycleActionHeartbeat,通过指定生命周期挂钩的ID、伸缩活动的等待状态标识符、需设置的等待时间等配置参数,延长挂起时间。 |
DescribeLifecycleActions | 查看伸缩活动对应的生命周期操作详情 | 调用DescribeLifecycleActions,通过指定伸缩活动的ID、查询凭证、MaxResults等配置参数,查看伸缩活动发生时,生命周期挂钩执行操作的状态、标识符、挂起的ECS实例的ID等信息。 |
CompleteLifecycleAction | 提前结束伸缩活动的等待状态 | 如果您为伸缩组配置了生命周期挂钩功能,您可以根据实际业务需要,调用API CompleteLifecycleAction提前结束伸缩活动的等待状态去执行下一步动作。 |
DeleteLifecycleHook | 删除一个生命周期挂钩 | 如果您不再需要一个生命周期挂钩,可以调用API DeleteLifecycleHook删除该生命周期挂钩,以空出挂钩配额。 |
事件通知
API | 标题 | API概述 |
---|---|---|
CreateNotificationConfiguration | 创建弹性伸缩事件及资源变化通知 | 调用API CreateNotificationConfiguration创建弹性伸缩事件及资源变化通知,帮助您及时掌握伸缩组的动态,进一步实现弹性伸缩事件的自动化管理。 |
ModifyNotificationConfiguration | 修改一条弹性伸缩事件及资源变化通知 | 事件通知支持在发生指定类型的事件后,自动发送消息到云监控、MNS主题和MNS队列,可以帮助您及时掌握伸缩组的动态,进一步实现自动化管理。如果当前事件通知的类型不再满足业务需求,您可以调用API ModifyNotificationConfiguration修改弹性伸缩事件及资源变化通知,您无需重新创建新的事件通知,但不支持修改事件通知的通知方式。 |
DescribeNotificationConfigurations | 查询弹性伸缩事件及资源变化通知 | 调用API DescribeNotificationConfiguration,通过伸缩组ID查询该伸缩组的弹性伸缩事件及资源变化通知,包括事件通知类型和通知方式等。 |
DeleteNotificationConfiguration | 删除一条弹性伸缩事件及资源变化通知 | 事件通知支持在发生指定类型的事件后,自动发送消息到云监控、MNS主题和MNS队列,以便您及时对事件进行定位和处理。如果当前事件通知不再使用,调用API DeleteNotificationConfiguration删除该条弹性伸缩事件及资源变化通知。 |
DescribeNotificationTypes | 查询弹性伸缩事件及资源变化通知的类型 | 调用DescribeNotificationTypes接口,查询弹性伸缩组的弹性伸缩事件及资源变化通知的类型,例如:扩容伸缩活动成功,缩容伸缩活动成功,定时任务到期提醒,弹性扩容活动部分成功等。 |
健康诊断
API | 标题 | API概述 |
---|---|---|
CreateDiagnoseReport | 创建诊断报告 | CreateDiagnoseReport |
DescribeDiagnoseReports | 查询诊断报告 | 查询健康诊断报告列表 |
DescribeScalingGroupDiagnoseDetails | 查询伸缩组最近的一次诊断详情 | 查询伸缩组最近的一次诊断详情,只有当存在诊断结果异常时才会返回结果。 |
实例
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的RemoveInstances接口删除该实例。 |
地域
API | 标题 | API概述 |
---|---|---|
DescribeRegions | 查询可以使用弹性伸缩服务的地域 | 在使用弹性伸缩前,您可以先通过调用API DescribeRegions查询可以在哪些地域使用弹性伸缩服务,方便您选择最适合的地域和可用区来使用弹性伸缩服务,确保在所选地域内获得良好的访问性能。 |
标签
API | 标题 | API概述 |
---|---|---|
TagResources | 为资源列表创建并绑定标签 | 调用API TagResources为指定的弹性伸缩资源列表统一创建并绑定标签,可以帮助您更好地管理和分类资源,通过标签了解资源使用情况,提高资源利用率。 |
ListTagResources | 查询弹性伸缩资源已经绑定的标签列表 | 调用API ListTagResources查询一个或多个弹性伸缩资源已经绑定的标签列表,可以帮助您更好地分类和管理弹性伸缩资源的使用情况,实现资源的自动化管理和权限控制等目标。 |
UntagResources | 为指定的弹性伸缩资源列表统一解绑标签 | 调用API UntagResources为指定的弹性伸缩资源列表统一解绑标签,可以简化资源管理、提高系统性能优化、降低安全风险。解绑标签后,如果该标签没有绑定其他任何资源,则会被自动删除。 |
ListTagKeys | 查询弹性伸缩资源标签键的列表 | 调用API ListTagKeys查询弹性伸缩资源标签键的列表,有利于您对弹性伸缩资源进行分类、识别以及监控等,提供更灵活和便捷的资源管理。 |
ListTagValues | 查询弹性伸缩资源标签键对应的标签值 | 调用API ListTagValues查询弹性伸缩资源标签键对应的标签值,能够帮助您更好地了解弹性伸缩资源,实现资源的有效分类和管理。 |
其他
API | 标题 | API概述 |
---|---|---|
VerifyUser | 验证是否已开通弹性伸缩服务 | 调用API VerifyUser验证是否已开通弹性伸缩服务,可以保证业务出现流量波动或负载变化时,系统能够自动扩缩容资源,有助于提高系统的稳定性、可用性和灵活性。 |
VerifyAuthentication | 检测是否已授权弹性伸缩操作ECS和ECI资源 | 调用VerifyAuthentication并指定主账号的ID,检测账号是否已有服务关联角色AliyunServiceRoleForAutoScaling,用于授权弹性伸缩操作ECS和ECI资源。 |
DescribeLimitation | 查询资源配额限制 | 调用API DescribeLimitation查询资源配额限制。例如查询支持创建定时任务的最大值、支持关联负载均衡实例的最大数量、支持设置伸缩组内最大实例数以及伸缩配置最大数量等。 |
ModifyInstanceAttribute | 修改伸缩组内实例的部分信息 | 调用ModifyInstanceAttribute,并指定伸缩组内实例的ID、伸缩组的ID、伸缩组所属的地域ID等参数,修改伸缩组中一台ECS实例的部分信息,目前仅支持修改手动添加到伸缩组中实例的生命周期托管属性。 |
DescribeAlertConfiguration | 查询伸缩组中需要发送消息的伸缩活动状态 | 调用DescribeAlertConfiguration接口,并指定伸缩组的ID、地域的ID,以查询伸缩组中需要发送短信、站内信和邮件通知的伸缩活动状态,例如伸缩活动执行成功、失败、被拒绝。 |
ModifyAlertConfiguration | 设置伸缩组中需要发送消息通知的伸缩活动状态。 | 设置伸缩组中需要发送短信、邮件通知的伸缩活动状态。 |