Use ModifyAlarm to change an event-triggered task - Auto Scaling - Alibaba Cloud - Auto Scaling

Modifies an event-triggered task.

Operation description

If you create an event-triggered task of the custom monitoring type (MetricType=custom), you must first report custom monitoring metrics to CloudMonitor. For more information, see Event-triggered tasks for custom monitoring.
When you create an event-triggered task, you must specify a metric (MetricName) and configure dimension information (Dimension.N.DimensionKey and Dimension.N.DimensionValue) to determine the aggregation scope of the metric data in the scaling group. For example, you can specify user_id and scaling_group to aggregate the metric data of all ECS instances or elastic container instances in the scaling group of the specified user.
- The metrics of a custom monitoring event-triggered task (MetricType=custom) depend on your custom monitoring metrics.
- For more information about the metrics supported by system monitoring event-triggered tasks (MetricType=system), see Event-triggered tasks for system monitoring.

Note

In the dimension information, user_id and scaling_group are automatically populated by the system. You must manually specify device and state. For more information, see the Dimension.N.DimensionKey and Dimension.N.DimensionValue parameters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:ModifyAlarm

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the event-triggered task.	cn-qingdao
AlarmTaskId	string	Yes	The ID of the event-triggered task.	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
Name	string	No	The name of the event-triggered task.	alarmtask****
Description	string	No	The description of the event-triggered task.	Test alarm task.
MetricName	string	No	The name of the metric. Valid values vary based on the monitoring type of the event-triggered task: If the event-triggered task is of the custom monitoring type (MetricType=custom), valid values are your custom metrics. If the event-triggered task is of the system monitoring type (MetricType=system), valid values: CpuUtilization: (ECS) CPU utilization (%). IntranetTx: (ECS) outbound traffic over the internal network (KByte/min). IntranetRx: (ECS) inbound traffic over the internal network (KByte/min). VpcInternetTx: (ECS) outbound traffic over the Internet (KByte/min). VpcInternetRx: (ECS) inbound traffic over the Internet (KByte/min). SystemDiskReadBps: (ECS) system cloud disk read BPS (Byte/s). SystemDiskWriteBps: (ECS) system cloud disk write BPS (Byte/s). SystemDiskReadOps: (ECS) system cloud disk read IOPS (count/s). SystemDiskWriteOps: (ECS) system cloud disk write IOPS (count/s). CpuUtilizationAgent: (Agent) CPU utilization (%). GpuMemoryFreeUtilizationAgent: (Agent) GPU memory idle rate (%). GpuMemoryUtilizationAgent: (Agent) GPU memory utilization (%). MemoryUtilization: (Agent) memory utilization (%). LoadAverage: (Agent) average system load. TcpConnection: (Agent) total number of TCP connections. TcpConnection: (Agent) number of established TCP connections. PackagesNetOut: (Agent) number of packets sent by the NIC. PackagesNetIn: (Agent) number of packets received by the NIC. EciPodCpuUtilization: CPU utilization (%). EciPodMemoryUtilization: memory utilization (%). For more information, see Event-triggered tasks for system monitoring.	MemoryUtilization
MetricType	string	No	The type of the metric. Valid values: system: uses CloudMonitor system metrics. custom: uses custom metrics reported to CloudMonitor.	system
Period	integer	No	The statistical period for the metric data, in seconds. Valid values: Note A statistical period of 15 seconds is applicable only to metrics collected by the CloudMonitor agent (metrics that start with Agent) when monitoring ECS-type scaling groups. For all other metrics, the statistical period can be set to 60, 120, 300, or 900 seconds.	300
Statistics	string	No	The method used to aggregate the metric data. Valid values: Average: average value. Minimum: minimum value. Maximum: maximum value.	Average
Threshold	number	No	The threshold of the monitoring metrics in a multi-metric event-triggered task. The scaling rule is executed when the threshold expression is met the specified number of times.	80
ComparisonOperator	string	No	The comparison operator between the statistical value and the threshold of the metric. The comparison operator indicates the relationship in which the statistical value and the threshold can satisfy the condition. Valid values: The statistical value is greater than or equal to the threshold. Value: `>=`. The statistical value is less than or equal to the threshold. Value: `<=`. The statistical value is greater than the threshold. Value: `>`. The statistical value is less than the threshold. Value: `<`.	>=
EvaluationCount	integer	No	The number of times that the threshold expression must be met before the scaling rule is triggered. For example, the average CPU utilization must be greater than or equal to 80% in three consecutive statistical results.	3
GroupId	integer	No	The ID of the CloudMonitor application group to which the custom metric belongs. This parameter is required only when MetricType is set to custom.	4055401
Effective	string	No	Specifies the effective period of the event-triggered task. This parameter follows cron expressions. The default format is `X X X X X ?`, where: X: a placeholder for a field, which sequentially represents seconds, minutes, hours, day, and month. X can be a specific value or a special character with logical meaning. For more information about the valid values of X, see Cron expression. ?: specifies no value. Note The value of this parameter is in the UTC+8 time zone by default. You can add time zone information `TZ=+yy` before the cron expression to specify a time zone, where y represents the numeric value of the time zone. For example, `TZ=+00 * * 1-2 * * ?` indicates that the event-triggered task takes effect between 01:00 and 02:59 every day in the UTC+0 time zone. Examples and descriptions: `* * * * * ?` : takes effect at all times. `* * 17-18 * * ?` : takes effect between 17:00 and 18:59 every day in the UTC+8 time zone. `TZ=+00 * * 1-2 * * ?`: takes effect between 01:00 and 02:59 every day in the UTC+0 time zone.	TZ=+00 * * 1-2 * * ?
AlarmActions	array	No	The list of unique identifiers of the scaling rules associated with the event-triggered task.
	string	No	The list of unique identifiers of the scaling rules associated with the event-triggered task.	ari:acs:ess:cn-hangzhou:140692647**:scalingrule/asr-bp163l21e07uhn**
Dimensions	array<object>	No	The dimension information associated with the metric.
	object	No	The dimension information associated with the metric.
DimensionKey	string	No	The key of the dimension information associated with the metric. Valid values vary based on the monitoring type of the event-triggered node: If the event-triggered task is of the custom monitoring type (MetricType=custom), valid values are not restricted. You can specify custom values. If the event-triggered task is of the system monitoring type (MetricType=system), valid values: user_id: your account ID. scaling_group: the scaling group to be monitored. device: the type of the network interface controller (NIC) device. state: the state of the TCP connection. rulePool: the server group specified for the ALB QPS monitoring metrics.	device
DimensionValue	string	No	The value of the dimension information associated with the metric. Valid values are determined by Dimension.N.DimensionKey: If Dimension.N.DimensionKey is set to a custom value, which means the event-triggered task is of the custom monitoring type (MetricType=custom), valid values are not restricted. You can specify custom values. If Dimension.N.DimensionKey is set to a system-specified value, which means the event-triggered task is of the system monitoring type (MetricType=system), valid values: user_id: automatically populated by the system. scaling_group: automatically populated by the system. device: eth0: for classic network instances, eth0 represents the internal NIC. For VPC-connected instances, only the eth0 NIC exists. eth1: for classic network instances, eth1 represents the public NIC. state: TCP_TOTAL: the total number of TCP connections. ESTABLISHED: the number of established TCP connections.	eth0
Expressions	array<object>	No	The monitoring metrics of the multi-metric event-triggered task.
	object	No	The monitoring metrics of the multi-metric event-triggered task.
ComparisonOperator	string	No	The comparison operator between the statistical value and the threshold of the metric. The comparison operator indicates the relationship in which the statistical value and the threshold can satisfy the condition. Valid values: The statistical value is greater than or equal to the threshold. Value: `>=`. The statistical value is less than or equal to the threshold. Value: `<=`. The statistical value is greater than the threshold. Value: `>`. The statistical value is less than the threshold. Value: `<`. Default value: >=.	>=
MetricName	string	No	The name of the monitoring metric in the multi-metric event-triggered node. Valid values vary based on the monitoring type of the event-triggered task: If the event-triggered task is of the custom monitoring type (MetricType=custom), valid values are your custom monitoring metrics. If the event-triggered task is of the system monitoring type (MetricType=system), valid values: CpuUtilization: (ECS) CPU utilization (%). IntranetTx: (ECS) outbound traffic over the internal network (KByte/min). IntranetRx: (ECS) inbound traffic over the internal network (KByte/min). VpcInternetTx: (ECS) outbound traffic over the Internet (KByte/min). VpcInternetRx: (ECS) inbound traffic over the Internet (KByte/min). SystemDiskReadBps: (ECS) system cloud disk read BPS (Byte/s). SystemDiskWriteBps: (ECS) system cloud disk write BPS (Byte/s). SystemDiskReadOps: (ECS) system cloud disk read IOPS (count/s). SystemDiskWriteOps: (ECS) system cloud disk write IOPS (count/s). CpuUtilizationAgent: (Agent) CPU utilization (%). GpuUtilizationAgent: (Agent) GPU utilization (%). GpuMemoryFreeUtilizationAgent: (Agent) GPU memory idle rate (%). GpuMemoryUtilizationAgent: (Agent) GPU memory utilization (%). MemoryUtilization: (Agent) memory utilization (%). LoadAverage: (Agent) average system load. TcpConnection: (Agent) total number of TCP connections. TcpConnection: (Agent) number of established TCP connections. PackagesNetOut: (Agent) number of packets sent by the network interface controller (NIC). PackagesNetIn: (Agent) number of packets received by the network interface controller (NIC). EciPodCpuUtilization: CPU utilization (%). EciPodMemoryUtilization: memory utilization (%). For more information, see Event-triggered tasks for system monitoring.	CpuUtilization
Period	integer	No	The statistical period for the metric data in the multi-metric event-triggered task, in seconds. Valid values: Note A statistical period of 15 seconds is applicable only to metrics collected by the CloudMonitor agent (metrics that start with Agent) when monitoring ECS-type scaling groups. For all other metrics, the statistical period can be set to 60, 120, 300, or 900 seconds. Default value: 300.	300
Statistics	string	No	The method used to aggregate the metric data in the multi-metric event-triggered task. Valid values: Average: average value. Minimum: minimum value. Maximum: maximum value.	Average
Threshold	number	No	The threshold of the monitoring metrics in a multi-metric event-triggered task. The scaling rule is executed when the threshold expression is met the specified number of times.	40.0
ExpressionsLogicOperator	string	No	The relationship between multiple monitoring metrics conditions. Valid values: `&&`: An alert is triggered only when all monitoring metrics meet the alert conditions. An alert is triggered only when all expressions in the multi-metric event-triggered task evaluate to `true`. `\|\|`: An alert is triggered when any monitoring metric meets the alert condition. Default value: `&&`.	&&

Response elements

Element	Type	Description	Example
	object
AlarmTaskId	string	The ID of the event-triggered task.	asg-bp1hvbnmkl10vll5**_83948190-acdd-483f-98f7-b77f4778**
RequestId	string	The request ID.	BACACF83-7070-4953-A8FD-D81F89F1****

Examples

Success response

JSON format

{
  "AlarmTaskId": "asg-bp1hvbnmkl10vll5****_83948190-acdd-483f-98f7-b77f4778****",
  "RequestId": "BACACF83-7070-4953-A8FD-D81F89F1****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.