创建一个伸缩规则。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateScalingPolicy | 要执行的操作,取值:CreateScalingPolicy。 |
Version | String | 是 | 2020-01-01 | API的版本,取值:2020-01-01。 |
ScalingGroupId | String | 是 | scg-ybmssdnnhn5pkgyd**** | 伸缩规则所属的伸缩组的ID。您可以调用DescribeScalingGroups查询伸缩组ID。 |
ScalingPolicyName | String | 是 | test-policy | 伸缩规则的名称,取值:
|
ScalingPolicyType | String | 是 | Scheduled | 伸缩规则的类型,取值:
|
AdjustmentType | String | 否 | QuantityChangeInCapacity | 伸缩规则的伸缩行为, 适用于简单规则和步进规则,取值:
|
AdjustmentValue | Integer | 否 | 1 | 伸缩行为的调整数值, 适用于简单规则和步进规则,取值:
说明 单次调用本接口最多可以调整的实例个数不允许超过300个。 |
Cooldown | Integer | 否 | 60 | 伸缩规则的冷却时间。 取值:0~86400,单位:秒,不填则默认使用伸缩组的冷却时间。 说明 当伸缩规则的冷却时间和伸缩组的冷却时间冲突时,伸缩规则的冷却时间更为优先。 |
ScheduledPolicy.LaunchTime | String | 否 | 2022-04-01T16:00Z | 表示任务的触发时间。
|
ScheduledPolicy.RecurrenceEndTime | String | 否 | 2022-04-02T16:00Z | 表示周期任务的结束时间。仅支持选择自创建当日起365日内的时间。若不配置,则根据重复周期(ScheduledPolicy.RecurrenceType)默认为此刻后的一天/周/月。 说明 当ScalingPolicyType取值为Recurrence时有效且为必填项。 |
ScheduledPolicy.RecurrenceType | String | 否 | Daily | 表示周期任务的重复周期,取值:
说明 当ScalingPolicyType取值为Recurrence时有效且为必填项。 |
ScheduledPolicy.RecurrenceValue | String | 否 | 3 | 表示重复执行周期任务的数值。
说明 当ScalingPolicyType取值为Recurrence时有效且为必填项。 |
AlarmPolicy.RuleType | String | 否 | Static | 报警任务的类型,取值:
说明 仅当ScalingPolicyType取值为Alarm时有效且为必填项。 |
AlarmPolicy.EvaluationCount | Integer | 否 | 3 | 当监控指标数据连续几次达到阈值时,即触发伸缩行为。取值:1 ~ 180。 说明 仅当ScalingPolicyType取值为Alarm时有效且为必填项。 |
AlarmPolicy.Condition.MetricName | String | 否 | CpuTotal_Max | 单指标告警时的监控指标名称,取值:
说明 仅当 |
AlarmPolicy.Condition.MetricUnit | String | 否 | Percent | 单指标告警时的监控指标阈值的单位。取值:
说明 仅当 |
AlarmPolicy.Condition.Threshold | String | 否 | 10 | 单指标告警时的监控指标的阈值,取值:
说明 仅当 |
AlarmPolicy.Condition.ComparisonOperator | String | 否 | 单指标告警时的规则表达式对象。
说明 仅当 | |
AlarmPolicy.Conditions.N.MetricName | Array of String | 否 | CpuTotal_Max | 多指标告警时的监控指标名称。
说明 仅当 |
AlarmPolicy.Conditions.N.MetricUnit | Array of String | 否 | Percent | 多指标告警时的监控指标阈值的单位。
说明 仅当 |
AlarmPolicy.Conditions.N.Threshold | Array of String | 是 | 10 | 多指标告警时的监控指标的阈值。
说明 仅当 |
AlarmPolicy.Conditions.N.ComparisonOperator | Array of String | 否 | 多指标告警时的规则表达式对象。
说明 仅当 | |
AlarmPolicy.ConditionOperator | String | 否 | || | 多指标告警时的判定条件。
说明 仅当 |
ClientToken | String | 否 | 333456899ff**** | 保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。取值: |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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****" } }
您可访问公共错误码,获取更多错误码信息。