弹性伸缩
弹性伸缩
文档指南
请输入
- 文档首页
弹性伸缩API参考伸缩规则CreateScalingPolicy - 创建一个伸缩规则
复制全文
下载 pdfCreateScalingPolicy - 创建一个伸缩规则
文档反馈
问问助手调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateScalingPolicy
要执行的操作，取值：CreateScalingPolicy。
Version string 必选 示例值：2020-01-01
API的版本，取值：2020-01-01。
AlarmPolicy.Effective string 可选 示例值：\* * 3-5 * *
指定报警任务的生效时间段。
- 不填表示在所有时间都生效。
- 如需在特定时间生效，请使用Cron表达式配置，适用于在业务高峰期关闭缩容等场景。
ScalingGroupId string 必选 示例值：scg-ybmssdnnhn5pkgyd****
ScalingPolicyName string 必选 示例值：test-policy
伸缩规则的名称，在同一地域下同一伸缩组中伸缩规则名称唯一。取值:
- 只能以中文、字母开头。
- 只能包含中文、字母、数字、下划线和中划线。
- 长度限制为1~ 128个字符。
- 暂不支持特殊字符。
ScalingPolicyType string 必选 示例值：Scheduled
伸缩规则的类型，取值：
- Scheduled：定时任务。
- Recurrence：周期任务。
- Alarm：报警任务。
AdjustmentType string 可选 示例值：QuantityChangeInCapacity
伸缩规则的伸缩行为， 适用于简单规则和步进规则，取值：
- QuantityChangeInCapacity：增加或减少指定数量的实例。
- PercentChangeInCapacity：增加或减少指定比例的实例。
- TotalCapacity： 将当前伸缩组的实例数量调整到指定数量。
AdjustmentValue integer 可选 示例值：1
伸缩行为的调整数值， 适用于简单规则和步进规则，取值：
- 当AdjustmentType参数取值为QuantityChangeInCapacity时：-100 ~ 100，不允许为0，单位：个。
- 当AdjustmentType参数取值为PercentChangeInCapacity时：-100 ~ 10000，不允许为0，单位：%。
- 当AdjustmentType参数取值为TotalCapacity时：默认为0 ~ 100，单位：个。
说明
单次调用本接口最多可以调整的实例个数不允许超过300个。
Cooldown integer 可选 示例值：60
伸缩规则的冷却时间。 取值：0~86400，单位：秒，不填则默认使用伸缩组的冷却时间。
说明
当伸缩规则的冷却时间和伸缩组的冷却时间冲突时，伸缩规则的冷却时间更为优先。
ScheduledPolicy.LaunchTime string 可选 示例值：2022-04-01T16:00Z
表示任务的触发时间。
- 当ScalingPolicyType取值为Scheduled时，表示定时任务的触发时间，需大于当前时刻。
- 当ScalingPolicyType取值为Recurrence时：
- 如果未指定ScheduledPolicy.RecurrenceType时，则表示仅按照此处指定的日期和时间执行一次。
- 如果指定了ScheduledPolicy.RecurrenceType，则表示周期任务开始时间。
- 仅支持选择自创建/修改当日起90日内的时间。
- 当ScalingPolicyType取值为Alarm时，本参数无效。
ScheduledPolicy.RecurrenceEndTime string 可选 `示例值：2022-04-02T16:00Z
`
表示周期任务的结束时间。仅支持选择自创建当日起365日内的时间。
- 若不配置，则根据重复周期（ScheduledPolicy.RecurrenceType）默认为此刻后的一天/周/月。
- 设置为空，表示本任务永不停止。
说明
当ScalingPolicyType取值为Recurrence时有效且为必填项。
ScheduledPolicy.RecurrenceType string 可选 示例值：Daily
表示周期任务的重复周期，取值：
- Daily：每XX天执行一次。
- Weekly：选择每周中的几天，每天执行一次。
- Monthly：选择每月中XX号到XX号，每天执行一次。
- Cron：按照指定的Cron表达式执行。
说明
当ScalingPolicyType取值为Recurrence时有效且为必填项。
ScheduledPolicy.RecurrenceValue string 可选 示例值：3
表示重复执行周期任务的数值。
- 当ScheduledPolicy.RecurrenceType参数取值为Daily时，只能填写一个值，取值：1 ~ 31。
- 当ScheduledPolicy.RecurrenceType参数取值为Weekly时，可以填入多个值，使用英文逗号（,）分隔。星期一到星期日的取值依次为：1,2,3,4,5,6,7。
- 当ScheduledPolicy.RecurrenceType参数取值为Monthly时，格式为A-B。A、B的取值范围均为1~31，且B必须大于等于A。
- 当ScheduledPolicy.RecurrenceType参数取值为Cron 时，表示UTC+8时间，支持分、时、日、月、星期的5域表达式，支持通配符英文逗号（,）、英文问号（?）、连词符（-）、星号（*）、井号（#）、斜线（/）、L和W。
说明
当ScalingPolicyType取值为Recurrence时有效且为必填项。
AlarmPolicy.RuleType string 可选 示例值：Static
报警任务的类型，取值：
- Static：表示由agent采集的静态监控。
说明
仅当ScalingPolicyType取值为Alarm时有效且为必填项。
AlarmPolicy.EvaluationCount integer 可选 示例值：3
当监控指标数据连续几次达到阈值时，即触发伸缩行为。取值：1 ～ 180。
说明
仅当ScalingPolicyType取值为Alarm时有效且为必填项。
AlarmPolicy.Condition.MetricName string 可选 示例值：CpuTotal_Max
单指标告警时的监控指标名称，取值：
- CpuTotal_Max：带内CPU使用率最大值，表示伸缩组中所有实例CPU使用率的最大值。
- CpuTotal_Min：带内CPU使用率最小值。
- CpuTotal_Avg：带内CPU使用率平均值。
- MemoryUsedUtilization_Max：带内内存使用率最大值。
- MemoryUsedUtilization_Min：带内内存使用率最小值。
- MemoryUsedUtilization_Avg：带内内存使用率平均值。
- Instance_CpuBusy_Max：带外CPU使用率最大值。
- Instance_CpuBusy_Min：带外CPU使用率最小值。
- Instance_CpuBusy_Avg：带外CPU使用率平均值。
- Instance_NetTxBits_Avg: 带外网络流出速率平均值。
- Instance_NetRxBits_Avg: 带外网络流入速率平均值。
- Instance_NetTxPackets_Avg: 带外网络发送包速率平均值。
- Instance_NetRxPackets_Avg: 带外网络接收包速率平均值。
- SystemDiskReadBytes_Avg: 带内系统盘读带宽平均值。
- SystemDiskWriteBytes_Avg: 带内系统盘写带宽平均值。
- SystemDiskReadIOPS_Avg: 带内系统盘读IOPS平均值。
- SystemDiskWriteIOPS_Avg: 带内系统盘写IOPS平均值。
- NetTcpConnection_Avg: 带内TCP连接数平均值。
说明
仅当ScalingPolicyType取值为Alarm时有效，且必须配置AlarmPolicy.Condition.x或AlarmPolicy.Conditions.x相关参数，当二者同时配置时，仅AlarmPolicy.Conditions.x生效。
AlarmPolicy.Condition.MetricUnit string 可选 示例值：Percent
单指标告警时的监控指标阈值的单位。取值：
- 当AlarmPolicy.Condition.MetricName参数取值为CPU/内存使用率时: Percent。
- 当AlarmPolicy.Condition.MetricName参数取值为系统盘读/写带宽时: Bytes/Second(IEC)。
- 当AlarmPolicy.Condition.MetricName参数取值为系统盘读/写IOPS时: Count/Second。
- 当AlarmPolicy.Condition.MetricName参数取值为TCP连接数时: Count。
- 当AlarmPolicy.Condition.MetricName参数取值为网络流入/流出速率时: Bits/Second(IEC)。
- 当AlarmPolicy.Condition.MetricName参数取值为网络收发包速率时: Packet/Second。
说明
仅当ScalingPolicyType取值为Alarm时有效，且必须配置AlarmPolicy.Condition.x或AlarmPolicy.Conditions.x相关参数，当二者同时配置时，仅AlarmPolicy.Conditions.x生效。
AlarmPolicy.Condition.Threshold string 可选 示例值：10
单指标告警时的监控指标的阈值，取值：
- 当AlarmPolicy.Condition.MetricUnit取值为Percent时：1 ～ 100。
- 当AlarmPolicy.Condition.MetricUnit取值为Bytes/Second(IEC)时：大于0的整数。
- 当AlarmPolicy.Condition.MetricUnit取值为Count/Second时：大于0的整数。
- 当AlarmPolicy.Condition.MetricUnit取值为Count时：大于0的整数。
- 当AlarmPolicy.Condition.MetricUnit取值为Bits/Second(IEC)时：大于0的整数。
- 当AlarmPolicy.Condition.MetricUnit取值为Packet/Second时：大于0的整数。
说明
仅当ScalingPolicyType取值为Alarm时有效，且必须配置AlarmPolicy.Condition.x或AlarmPolicy.Conditions.x相关参数，当二者同时配置时，仅AlarmPolicy.Conditions.x生效。
AlarmPolicy.Condition.ComparisonOperator string 可选 示例值：\>
单指标告警时的规则表达式对象。
- >：大于
- <：小于
- =：等于
说明
仅当ScalingPolicyType取值为Alarm时有效，且必须配置AlarmPolicy.Condition.x或AlarmPolicy.Conditions.x相关参数，当二者同时配置时，仅AlarmPolicy.Conditions.x生效。
AlarmPolicy.Conditions.N.MetricName string[] 可选 示例值：CpuTotal_Max
多指标告警时的监控指标名称。
- 取值：
- CpuTotal_Max：带内CPU使用率最大值。
- CpuTotal_Min：带内CPU使用率最小值。
- CpuTotal_Avg：带内CPU使用率平均值。
- MemoryUsedUtilization_Max：带内内存使用率最大值。
- MemoryUsedUtilization_Min：带内内存使用率最小值。
- MemoryUsedUtilization_Avg：带内内存使用率平均值。
- Instance_CpuBusy_Max：带外CPU利用率最大值。
- Instance_CpuBusy_Min：带外CPU利用率最小值。
- Instance_CpuBusy_Avg：带外CPU利用率平均值。
- Instance_NetTxBits_Avg: 带外网络流出速率平均值。
- Instance_NetRxBits_Avg: 带外网络流入速率平均值。
- Instance_NetTxPackets_Avg: 带外网络发送包速率平均值。
- Instance_NetRxPackets_Avg: 带外网络接收包速率平均值。
- SystemDiskReadBytes_Avg: 带内系统盘读带宽平均值。
- SystemDiskWriteBytes_Avg: 带内系统盘写带宽平均值。
- SystemDiskReadIOPS_Avg: 带内系统盘读IOPS平均值。
- SystemDiskWriteIOPS_Avg: 带内系统盘写IOPS平均值。
- NetTcpConnection_Avg: 带内TCP连接数平均值。
- 参数 - N：表示指标的序号，取值：1 - 5。
- 多个实例规格之间用&分隔。
说明
仅当ScalingPolicyType取值为Alarm时有效，且必须配置AlarmPolicy.Condition.x或AlarmPolicy.Conditions.x相关参数，当二者同时配置时，仅AlarmPolicy.Conditions.x生效。
AlarmPolicy.Conditions.N.MetricUnit string[] 可选 示例值：Percent
多指标告警时的监控指标阈值的单位。
- 取值：
- 当AlarmPolicy.Conditions.MetricName参数取值为CPU/内存使用率时: Percent。
- 当AlarmPolicy.Conditions.MetricName参数取值为系统盘读/写带宽时: Bytes/Second(IEC)。
- 当AlarmPolicy.Conditions.MetricName参数取值为系统盘读/写IOPS时: Count/Second。
- 当AlarmPolicy.Conditions.MetricName参数取值为TCP连接数时: Count。
- 当AlarmPolicy.Condition.MetricName参数取值为网络流入/流出速率时: Bits/Second(IEC)。
- 当AlarmPolicy.Condition.MetricName参数取值为网络收发包速率时: Packet/Second。
- 参数 - N：表示指标的序号，取值：1 - 5。
- 多个实例规格之间用&分隔。
说明
仅当ScalingPolicyType取值为Alarm时有效，且必须配置AlarmPolicy.Condition.x或AlarmPolicy.Conditions.x相关参数，当二者同时配置时，仅AlarmPolicy.Conditions.x生效。
AlarmPolicy.Conditions.N.Threshold string[] 必选 示例值：10
多指标告警时的监控指标的阈值。
- 取值：
- 当AlarmPolicy.Conditions.MetricUnit取值为Percent时：1 ～ 100。
- 当AlarmPolicy.Conditions.MetricUnit取值为Bytes/Second(IEC)时：大于0的整数。
- 当AlarmPolicy.Conditions.MetricUnit取值为Count/Second时：大于0的整数。
- 当AlarmPolicy.Conditions.MetricUnit取值为Count时：大于0的整数。
- 当AlarmPolicy.Condition.MetricUnit取值为Bits/Second(IEC)时：大于0的整数。
- 当AlarmPolicy.Condition.MetricUnit取值为Packet/Second时：大于0的整数。
- 参数 - N：表示指标的序号，取值：1 - 5。
- 多个实例规格之间用&分隔。
说明
仅当ScalingPolicyType取值为Alarm时有效，且必须配置AlarmPolicy.Condition.x或AlarmPolicy.Conditions.x相关参数，当二者同时配置时，仅AlarmPolicy.Conditions.x生效。
AlarmPolicy.Conditions.N.ComparisonOperator string[] 可选 示例值：\>
多指标告警时的规则表达式对象。
- >：大于
- <：小于
- =：等于
说明
仅当ScalingPolicyType取值为Alarm时有效，且必须配置AlarmPolicy.Condition.x或AlarmPolicy.Conditions.x相关参数，当二者同时配置时，仅AlarmPolicy.Conditions.x生效。
AlarmPolicy.ConditionOperator string 可选 示例值：||
多指标告警时的判定条件。
- &&：多个指标同时成立才判定为触发告警。
- ||（默认）：任意指标满足条件就判定为触发告警。
说明
仅当ScalingPolicyType取值为Alarm时有效，且配置AlarmPolicy.Conditions.x相关参数时生效。
ClientToken string 可选 示例值：333456899ff****
保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：
仅支持ASCII字符，且不能超过64个字符。
返回参数
ScalingPolicyId string 示例值：sp-ybmvamf8uql8j1fl****
伸缩规则的ID。
请求示例
返回示例
错误码
最近更新时间：2025.08.27 19:18:33
这个页面对您有帮助吗？
有用
有用
无用
无用