You need to enable JavaScript to run this app.
导航
CreateScalingPolicy - 创建一个伸缩规则
最近更新时间:2024.06.05 16:46:36首次发布时间:2022.05.13 10:42:45

创建一个伸缩规则。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

CreateScalingPolicy

要执行的操作,取值:CreateScalingPolicy。

Version
String

2020-01-01

API的版本,取值:2020-01-01。

ScalingGroupId
String

scg-ybmssdnnhn5pkgyd****

伸缩规则所属的伸缩组的ID。您可以调用DescribeScalingGroups查询伸缩组ID。

AdjustmentType
String

QuantityChangeInCapacity

伸缩规则的伸缩行为, 适用于简单规则和步进规则,取值:

  • QuantityChangeInCapacity:增加或减少指定数量的实例。
  • PercentChangeInCapacity:增加或减少指定比例的实例。
  • TotalCapacity: 将当前伸缩组的实例数量调整到指定数量。
AdjustmentValue
Integer

1

伸缩行为的调整数值, 适用于简单规则和步进规则,取值:

  • 当AdjustmentType参数取值为QuantityChangeInCapacity时:-100 ~ 100,不允许为0,单位:个。
  • 当AdjustmentType参数取值为PercentChangeInCapacity时:-100 ~ 10000,不允许为0,单位:%。
  • 当AdjustmentType参数取值为TotalCapacity时:默认为0 ~ 100,单位:个。

说明

单次调用本接口最多可以调整的实例个数不允许超过300个。

AlarmPolicy.Condition.ComparisonOperator
String

规则表达式对象。

  • >:大于
  • <:小于
  • =:等于

说明

仅当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利用率平均值。

说明

仅当ScalingPolicyType取值为Alarm时有效且为必填项。

AlarmPolicy.Condition.MetricUnit
String

Percent

监控指标阈值的单位。取值:Percent。

说明

仅当ScalingPolicyType取值为Alarm时有效且为必填项。

AlarmPolicy.Condition.Threshold
String

10

监控指标的阈值,取值:

  • 当AlarmPolicy.Condition.MetricUnit取值为Percent时:1 ~ 100。

说明

仅当ScalingPolicyType取值为Alarm时有效且为必填项。

AlarmPolicy.EvaluationCount
Integer

3

当监控指标数据连续几次达到阈值时,即触发伸缩行为。取值:1 ~ 180。

说明

仅当ScalingPolicyType取值为Alarm时有效且为必填项。

AlarmPolicy.RuleType
String

Static

报警任务的类型,取值:

  • Static:表示由agent采集的静态监控。

说明

仅当ScalingPolicyType取值为Alarm时有效且为必填项。

Cooldown
Integer

60

伸缩规则的冷却时间。 取值:0~86400,单位:秒,不填则默认使用伸缩组的冷却时间。

说明

当伸缩规则的冷却时间和伸缩组的冷却时间冲突时,伸缩规则的冷却时间更为优先。

ScalingPolicyName
String

test-policy

伸缩规则的名称,取值:

  • 只能以中文、字母开头。
  • 只能包含中文、字母、数字、下划线和中划线。
  • 长度限制为1~ 128个字符。
  • 暂不支持特殊字符。
ScalingPolicyType
String

Scheduled

伸缩规则的类型,取值:

  • Scheduled:定时任务。
  • Recurrence:周期任务。
  • Alarm:报警任务。
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时有效且为必填项。

ClientToken
String

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。取值:
仅支持ASCII字符,且不能超过64个字符。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
ScalingPolicyId
String

sp-ybmvamf8uql8j1fl****

伸缩规则的ID。

请求示例

GET /?Action=CreateScalingPolicy&AdjustmentType=QuantityChangeInCapacity&AdjustmentValue=1&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&ScalingPolicyName=test-policy&ScalingPolicyType=Scheduled&ScheduledPolicy.LaunchTime=2022-04-01T16:00Z&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T095709Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240507175808056188004229EB35C3",
    "Version": "2020-01-01",
    "Service": "auto_scaling",
    "Region": "cn-beijing"
  },
  "Result": {
    "ScalingPolicyId": "sp-ybmvamf8uql8j1fl****"
  }
}

错误码

您可访问公共错误码,获取更多错误码信息。