本产品(
弹性伸缩/2022-02-22
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
伸缩组
API | 标题 | API概述 |
---|---|---|
CreateScalingGroup | 创建一个伸缩组 | 如果您需要根据业务变动需求与策略自动增加或减少指定类型的实例数量,则可以通过调用API CreateScalingGroup创建伸缩组来自动调整您的业务计算能力(即实例数量)。 |
ModifyScalingGroup | 修改一个伸缩组 | 修改一个伸缩组。 |
EnableScalingGroup | 启用一个伸缩组 | 启用一个伸缩组。 |
DisableScalingGroup | 停用一个伸缩组 | 停用一个伸缩组。 |
SetGroupDeletionProtection | 为伸缩组开启或关闭删除保护 | 如果开启伸缩组删除保护功能后,此时不能删除该伸缩组;如果关闭伸缩组删除保护功能,此时可直接删除该伸缩组,本文为您介绍如何调用API SetGroupDeletionProtection为伸缩组开启或关闭伸缩组删除保护功能。 |
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 | 暂停伸缩组中的指定流程 | 暂停伸缩组中的指定流程。 |
ResumeProcesses | 恢复伸缩组中被暂停的流程 | 您可以主动调用API ResumeProcesses恢复伸缩组中被暂停的流程,由伸缩组继续按功能逻辑执行指定流程。例如,您恢复健康检查流程后,如果伸缩组某实例被视为不健康就会自动被移出伸缩组。 |
AttachVServerGroups | 添加负载均衡实例下虚拟服务器组 | 添加负载均衡实例下的一个或者多个虚拟服务器组。 |
DetachVServerGroups | 移除一个或者多个虚拟服务器组 | 伸缩组支持关联负载均衡实例,可以有效增强伸缩组的服务能力。如果您的业务暂不需要通过负载均衡实例将访问流量分发到伸缩组内的多个实例中去,您可以调用API DetachVServerGroups移除一个或者多个虚拟服务器组。 |
AttachAlbServerGroups | 添加一个或多个ALB服务器组 | 向伸缩组添加一个或多个ALB服务器组。 |
DetachAlbServerGroups | 移出一个或多个ALB服务器组 | 从伸缩组移出一个或多个ALB服务器组。 |
AttachServerGroups | 添加一个或多个负载均衡服务器组 | 从伸缩组添加一个或多个负载均衡服务器组,支持的服务器组类型包括:应用型负载均衡ALB (Application Load Balancer)、网络型负载均衡NLB (Network Load Balancer)。 |
DetachServerGroups | 移除一个或多个负载均衡服务器组 | 从伸缩组移除一个或多个负载均衡服务器组,支持的服务器组类型包括:应用型负载均衡ALB (Application Load Balancer)、网络型负载均衡NLB (Network Load Balancer)。 |
ChangeResourceGroup | 更改伸缩组所属的资源组 | 将一个伸缩组作为资源加入一个资源组。 |
ApplyScalingGroup | 基于配置文件管理伸缩组 | 如果您需要通过配置文件方式快速创建、管理伸缩组,则可以通过调用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 | 标题 | API概述 |
---|---|---|
CreateScalingRule | 创建一条伸缩规则 | 创建一条伸缩规则。 |
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 | 查询定时任务的信息 | 查询定时任务的信息。 |
DeleteScheduledTask | 删除一个定时任务 | 删除一个定时任务。 |
报警任务
API | 标题 | API概述 |
---|---|---|
CreateAlarm | 创建一个报警任务 | 创建一个报警任务。 |
DescribeAlarms | 查询报警任务的信息 | 查询报警任务的信息。 |
ModifyAlarm | 修改报警任务 | 修改一个报警任务。 |
EnableAlarm | 启用一个报警任务 | 启用一个报警任务。 |
DisableAlarm | 停用一个报警任务 | 停用一个报警任务。 |
DeleteAlarm | 删除一个报警任务 | 删除一个报警任务。 |
生命周期挂钩
API | 标题 | API概述 |
---|---|---|
CreateLifecycleHook | 为伸缩组创建一个或多个生命周期挂钩 | 为伸缩组创建一个或多个生命周期挂钩。 |
ModifyLifecycleHook | 修改一个生命周期挂钩的信息 | 修改一个生命周期挂钩的信息。 |
DescribeLifecycleHooks | 查询生命周期挂钩 | 查询生命周期挂钩。 |
RecordLifecycleActionHeartbeat | 延长生命周期挂钩触发后被挂起等待时间 | 延长一个生命周期挂钩触发后被挂起的ECS实例的等待时间。 |
DescribeLifecycleActions | 伸缩活动对应的生命周期操作 | 查看伸缩活动对应的生命周期操作。 |
CompleteLifecycleAction | 提前结束伸缩活动的等待状态 | 如果您为伸缩组配置了生命周期挂钩功能,您可以根据实际业务需要,调用API CompleteLifecycleAction提前结束伸缩活动的等待状态去执行下一步动作。 |
DeleteLifecycleHook | 删除一个生命周期挂钩 | 删除一个生命周期挂钩。 |
事件通知
API | 标题 | API概述 |
---|---|---|
CreateNotificationConfiguration | 创建弹性伸缩事件及资源变化通知 | 调用API CreateNotificationConfiguration创建弹性伸缩事件及资源变化通知,帮助您及时掌握伸缩组的动态,进一步实现弹性伸缩事件的自动化管理。 |
ModifyNotificationConfiguration | 修改一条弹性伸缩事件及资源变化通知 | 修改一条弹性伸缩事件及资源变化通知。 |
DescribeNotificationConfigurations | 查询弹性伸缩事件及资源变化通知 | 查询您创建的弹性伸缩事件及资源变化通知。 |
DeleteNotificationConfiguration | 删除一条弹性伸缩事件及资源变化通知 | 删除一条弹性伸缩事件及资源变化通知。 |
DescribeNotificationTypes | 查询弹性伸缩事件及资源变化通知的类型 | 查询弹性伸缩事件及资源变化通知的类型。 |
实例
API | 标题 | API概述 |
---|---|---|
EnterStandby | 将伸缩组内的ECS实例设置为备用状态 | 将伸缩组内的ECS实例设置为备用状态。 |
ExitStandby | 使备用状态实例进入运行状态 | 使伸缩组内处于备用状态的ECS实例进入运行状态。 |
RebalanceInstances | 重新平衡ECS实例分布 | 如果由于库存不足等原因导致可用区之间ECS实例的数量不均衡,您可以通过调用API RebalanceInstances重新平衡多可用区伸缩组内ECS实例的分布。 |
SetInstanceHealth | 设置伸缩组内ECS实例的健康状态 | 在某些情况下,自动健康检查可能无法准确发现ECS实例或ECI实例的健康状态,通过手动设置实例的健康状态可以对故障实例进行快速识别和处理。此时,您可以调用API SetInstanceHealth设置伸缩组内ECS实例或ECI实例的健康状态,能够更好地应对实际的业务需求和运维情况。 |
SetInstancesProtection | 开始或停止保护伸缩组内ECS实例 | 开始保护或者停止保护伸缩组内的一台或者多台ECS实例。 |
地域
API | 标题 | API概述 |
---|---|---|
DescribeRegions | 查询可以使用弹性伸缩服务的地域 | 查询可以使用弹性伸缩服务的地域。 |
标签
API | 标题 | API概述 |
---|---|---|
TagResources | 为资源列表创建并绑定标签 | 为指定的弹性伸缩资源列表统一创建并绑定标签。 |
ListTagResources | 查询弹性伸缩资源已经绑定的标签列表 | 查询一个或多个弹性伸缩资源已经绑定的标签列表。 |
UntagResources | 为指定的弹性伸缩资源列表统一解绑标签 | 为指定的弹性伸缩资源列表统一解绑标签。解绑后,如果该标签没有绑定其他任何资源,会被自动删除。 |
ListTagKeys | 查询弹性伸缩资源标签键的列表 | 调用API ListTagKeys查询弹性伸缩资源标签键的列表,有利于您对弹性伸缩资源进行分类、识别以及监控等,提供更灵活和便捷的资源管理。 |
ListTagValues | 查询弹性伸缩资源标签键对应的标签值 | 查询弹性伸缩资源标签键对应的标签值。 |
其他
API | 标题 | API概述 |
---|---|---|
VerifyUser | 验证是否已开通弹性伸缩服务 | 验证是否已开通弹性伸缩服务。 |
VerifyAuthentication | 检测是否已授权弹性伸缩操作ECS和ECI资源 | 检测是否已授权弹性伸缩调操作ECS和ECI资源。 |
DescribeLimitation | 查询资源配额限制 | 调用API DescribeLimitation查询资源配额限制。例如查询支持创建定时任务的最大值、查询支持关联负载均衡实例的最大数量、查询支持设置伸缩组内最大实例数以及伸缩配置最大数量等。 |
ModifyInstanceAttribute | 修改伸缩组内实例的部分信息 | 调用ModifyInstanceAttribute修改伸缩组中一台ECS实例的部分信息,目前仅支持修改手动添加到伸缩组中实例的生命周期托管属性。 |