Modifies a scaling rule.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ess:ModifyScalingRule |
update |
*ScalingGroup
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ScalingRuleId |
string |
Yes |
The ID of the scaling rule that you want to modify. |
asr-bp1dvirgwkoowxk7**** |
| ScalingRuleName |
string |
No |
The name of the scaling rule. The name must be 2 to 64 characters in length and can contain digits, uppercase letters, lowercase letters, Chinese characters, underscores (_), hyphens (-), and periods (.). It must start with a digit, letter, or Chinese character. Note
The name of a scaling rule must be unique within the same scaling group under the same Alibaba Cloud account in the same region. |
scalingrule**** |
| Cooldown |
integer |
No |
The cooldown time of the scaling rule. This parameter is applicable only to simple scaling rules. Valid values: 0 to 86400. Unit: seconds. |
60 |
| MinAdjustmentMagnitude |
integer |
No |
The minimum number of instances to adjust in a scaling rule. This parameter takes effect only when the scaling rule type is |
1 |
| AdjustmentType |
string |
No |
The adjustment method of the scaling rule. This parameter is applicable to simple scaling rules and step scaling rules, and is required in this case. Valid values:
|
QuantityChangeInCapacity |
| AdjustmentValue |
integer |
No |
The adjustment value of the scaling rule. This parameter is applicable to simple scaling rules and step scaling rules, and is required in this case. The number of ECS instances adjusted in a single scaling activity cannot exceed 1,000. Valid values vary based on the adjustment method:
|
100 |
| EstimatedInstanceWarmup |
integer |
No |
The warm-up period of an instance. This parameter is applicable to target tracking scaling rules and step scaling rules. An ECS instance in the warm-up state is added to the scaling group as expected, but CloudMonitor does not report monitoring data for the instance during this period. Note
When the number of ECS instances to scale is dynamically calculated, instances in the warm-up state are not counted toward the existing instance count. Valid values: 0 to 86400. Unit: seconds. |
60 |
| MetricName |
string |
No |
The predefined metric. This parameter is applicable to target tracking scaling rules and predictive scaling rules, and is required in this case. Valid values for target tracking scaling rules:
Valid values for predictive scaling rules:
For more information, see Event-triggered tasks for system monitoring. |
CpuUtilization |
| TargetValue |
number |
No |
The target value. This parameter is applicable to target tracking scaling rules and predictive scaling rules. The value of TargetValue can have up to three decimal places and must be greater than 0. |
0.125 |
| DisableScaleIn |
boolean |
No |
Specifies whether to disable scale-in. This parameter is applicable only to target tracking scaling rules. |
true |
| ScaleInEvaluationCount |
integer |
No |
After a target tracking scaling rule is created, an event-triggered task is automatically created. This parameter specifies the number of consecutive times that the threshold condition must be met before the corresponding scale-in event-triggered task triggers an alert. |
15 |
| ScaleOutEvaluationCount |
integer |
No |
After a target tracking scaling rule is created, an event-triggered task is automatically created. This parameter specifies the number of consecutive times that the threshold condition must be met before the corresponding scale-out event-triggered task triggers an alert. |
3 |
| PredictiveScalingMode |
string |
No |
The mode of the predictive scaling rule. Valid values:
|
PredictAndScale |
| PredictiveValueBehavior |
string |
No |
The method used to handle the maximum value of the predictive scaling rule. Valid values:
|
MaxOverridePredictiveValue |
| PredictiveValueBuffer |
integer |
No |
This parameter takes effect when |
50 |
| PredictiveTaskBufferTime |
integer |
No |
Prediction tasks automatically created by a predictive scaling rule execute on the hour by default. You can configure a buffer time to execute prediction tasks ahead of schedule and prepare resources in advance. Valid values: 0 to 60. |
30 |
| InitialMaxSize |
integer |
No |
The maximum number of instances in the scaling group. This parameter is used together with PredictiveValueBehavior. |
100 |
| StepAdjustment |
array<object> |
No |
The collection of step adjustment information for step scaling. |
|
|
object |
No |
The collection of step adjustment information for step scaling. |
||
| MetricIntervalUpperBound |
number |
No |
The upper bound of a step adjustment. This parameter is applicable only to step scaling rules. Valid values: -9.999999E18 to 9.999999E18. |
5.0 |
| ScalingAdjustment |
integer |
No |
The number of instances to scale in a step adjustment. This parameter is applicable only to step scaling rules. |
1 |
| MetricIntervalLowerBound |
number |
No |
The lower bound of a step adjustment. This parameter is applicable only to step scaling rules. Valid values: -9.999999E18 to 9.999999E18. |
1.0 |
| AlarmDimension |
array<object> |
No |
The dimension information associated with the metric. This parameter is applicable to target tracking scaling rules. Set this parameter when the metric requires additional dimension information. For example, the |
|
|
object |
No |
The dimension information associated with the metric. This parameter is applicable to target tracking scaling rules. Set this parameter when the metric requires additional dimension information. For example, the |
||
| DimensionKey |
string |
No |
The key of the dimension associated with the metric. |
rulePool |
| DimensionValue |
string |
No |
The value of the dimension associated with the metric. |
sgp-l1cbirz451yxu2**** |
| MetricType |
string |
No |
The type of the metric. Valid values:
|
system |
| HybridMonitorNamespace |
string |
No |
The ID of the Hybrid Cloud Monitoring monitoring metrics repository. To manage monitoring metrics repositories, see Manage monitoring metrics repositories. |
aliyun-test |
| HybridMetrics |
array<object> |
No |
The Hybrid Cloud Monitoring monitoring metrics settings. For more information about how to configure this parameter, see Use formula-based custom target tracking scaling rules. |
|
|
array<object> |
No |
|||
| Id |
string |
No |
The reference ID of the metric in the formula expression. |
a |
| Expression |
string |
No |
The formula expression for multiple Hybrid Cloud Monitoring metrics. The calculation result of the expression is used to trigger scaling activities. The expression must comply with the Reverse Polish Notation (RPN) specification, and only the |
(a+b)/2 |
| MetricName |
string |
No |
The name of the monitoring metrics in the Hybrid Cloud Monitoring monitoring metrics repository. |
AliyunSmq_NumberOfMessagesVisible |
| Statistic |
string |
No |
The statistical method of the metric. Valid values:
|
Average |
| Dimensions |
array<object> |
No |
The metric dimensions. Specifies the resources to monitor for the metric. |
|
|
object |
No |
|||
| DimensionKey |
string |
No |
The key of the metric dimension. |
queue |
| DimensionValue |
string |
No |
The value of the metric dimension. |
testQueue |
| AlarmOptions |
object |
No |
The alert property definitions. |
|
| Period |
integer |
No |
The statistical period for monitoring data in the target tracking scaling rule. Unit: seconds. Valid values: Note
Default value: 60. |
60 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
Examples
Success response
JSON format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.