All Products
Search
Document Center

Auto Scaling:ModifyAlarm

Last Updated:Jun 06, 2024

Modifies an event-triggered task.

Operation description

  • If you set the MetricType parameter to custom, you must report your custom metrics to CloudMonitor before you can create event-triggered tasks by using the custom metrics. For more information, see Custom monitoring event-triggered tasks.

  • When you create an event-triggered task, you must specify the MetricName, DimensionKey, and DimensionValue parameters to determine the range of statistics that you want to aggregate for the metrics of the scaling group. For example, you can specify the user_id and scaling_group dimensions for an event-triggered task to aggregate monitoring data of all Elastic Compute Service (ECS) instances or elastic container instances in a scaling group within an Alibaba Cloud account.

    • If you set the MetricType parameter to custom, the valid values are your custom metrics.
    • For information about the metrics that are supported if you set the MetricType parameter to system, see Event-triggered task for system monitoring.
Note The user_id and scaling_group dimensions are automatically populated. You need to only specify the device and state dimensions. For more information, see the DimensionKey and DimensionValue parameters in the "Request parameters" section of this topic.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the event-triggered task.

cn-qingdao
AlarmTaskIdstringYes

The ID of the event-triggered task.

asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****
NamestringNo

The name of the event-triggered task.

alarmtask****
DescriptionstringNo

The description of the event-triggered task.

Test alarm task.
MetricNamestringNo

The name of the metric. The valid values vary based on the metric type.

  • If you set the MetricType parameter to custom, the valid values are your custom metrics.

  • If you set the MetricType parameter to system, the MetricName parameter has the following valid values:

    • CpuUtilization: the CPU utilization of an ECS instance. Unit: %.
    • IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.
    • IntranetRx: the inbound traffic over the Internet to an ECS instance that resides in a virtual private cloud (VPC). Unit: KB/min.
    • VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a VPC. Unit: KB/min.
    • VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.
    • SystemDiskReadBps: the number of bytes read from the system disk used by an ECS instance per second.
    • SystemDiskWriteBps: the number of bytes written to the system disk used by an ECS instance per second.
    • SystemDiskReadOps: the number of read operations on the system disk used by an ECS instance per second.
    • SystemDiskWriteOps: the number of write operations on the system disk used by an ECS instance per second.
    • CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.
    • GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.
    • GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.
    • MemoryUtilization: the memory usage of an agent. Unit: %.
    • LoadAverage: the average system load of an agent.
    • TcpConnection: the total number of TCP connections of an agent.
    • TcpConnection: the number of established TCP connections of an agent.
    • PackagesNetOut: the number of packets that are sent by the internal network interface controller (NIC) used by an agent.
    • PackagesNetIn: the number of packets that are received by the internal NIC used by an agent.
    • EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.
    • EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.

For more information, see Event-triggered task for system monitoring.

MemoryUtilization
MetricTypestringNo

The type of the metric. Valid values:

  • system: system metrics of CloudMonitor
  • custom: custom metrics that are reported to CloudMonitor
system
PeriodintegerNo

The period of time during which statistics about the metric is collected. Unit: seconds. Valid values:

  • 15
  • 60
  • 120
  • 300
  • 900
Note If your scaling group is of the ECS type and uses CloudMonitor metrics, you can set the Period parameter to 15. In other cases, you can set the Period parameter to 60, 120, 300, or 900. In most cases, the name of a CloudMonitor metric contains Agent.
300
StatisticsstringNo

The method that is used to aggregate statistics for the metric. Valid values:

  • Average
  • Minimum
  • Maximum
Average
ThresholdfloatNo

The thresholds of the metric values in the multi-metric alert rule. If the thresholds are reached the specified number of times within the specified period, a scaling rule is executed.

80
ComparisonOperatorstringNo

The operator that is used to compare the metric value and the threshold. Valid values:

  • If the metric value is greater than or equal to the threshold, set the value to >=.
  • If the metric value is less than or equal to the threshold, set the value to <=.
  • If the metric value is greater than the threshold, set the value to >.
  • If the metric value is less than the threshold, set the value to <.
>=
EvaluationCountintegerNo

The number of times that the threshold must be reached before a scaling rule can be executed. For example, if you set this parameter to 3, the average CPU utilization must reach or exceed 80% three times in a row before a scaling rule is triggered.

3
GroupIdintegerNo

The ID of the application group to which the custom metric belongs. If you set the MetricType parameter to custom, you must specify this parameter.

4055401
EffectivestringNo

The effective period of the event-triggered task.

This parameter follows the cron expression format. The default format is X X X X X ?, in which:

  • X: a placeholder for a field, which represents seconds, minutes, hours, days, and months in sequence. X can be a definite value or a special character that has logical meaning. For information about the valid values of X, see Cron expression.
  • ?: No value is specified.
Note By default, the value of this parameter is specified in UTC+8. You can specify the time zone in the TZ=+yy format before a cron expression. y indicates the time zone. For example, TZ=+00 * * 1-2 * * ? specifies that the event-triggered task is in effect between 01:00 and 02:59 (UTC+0) every day.

Examples:

  • * * * * * ? : The event-triggered task is in effect all the time.
  • * * 17-18 * * ? : The event-triggered task is in effect between 17:00 and 18:59 (UTC+8) every day.
  • TZ=+00 * * 1-2 * * ?: The event-triggered task is in effect between 01:00 and 02:59 (UTC+0) every day.
TZ=+00 * * 1-2 * * ?
AlarmActionsarrayNo

The list of unique identifiers of the scaling rules that are associated with the event-triggered task.

stringNo

The list of unique identifiers of the scaling rules that are associated with the event-triggered task.

ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp163l21e07uhn****
Dimensionsobject []No

Details of the dimensions.

DimensionKeystringNo

The key of the dimension. The valid values vary based on the metric type.

  • If you set the MetricType parameter to custom, you can specify this parameter based on your business requirements.

  • If you set the MetricType parameter to system, this parameter has the following valid values:

    • user_id: the ID of your Alibaba Cloud account
    • scaling_group: the scaling group that you want to monitor
    • device: the type of the NIC
    • state: the status of the TCP connection
device
DimensionValuestringNo

The value of the dimension. The valid values vary based on the value of the DimensionKey parameter.

  • If you set the MetricType parameter to custom, you can specify this parameter based on your business requirements.

  • If you set the MetricType parameter to system, this parameter has the following valid values:

    • If you set the DimensionKey parameter to user_id, the system specifies the value

    • scaling_group: The system specifies the value of the DimensionValue parameter.

    • If you set the DimensionKey parameter to device, you can set the DimensionValue parameter to eth0 or eth1.

      • For instances that reside in the classic network type, eth0 specifies the internal NIC. Only one eth0 NIC exists on each instance that resides in a VPC.
      • For instances that reside in the classic network, eth1 specifies the public NIC.
    • If you set the DimensionKey parameter to state, you can set the DimensionValue parameter to TCP_TOTAL or ESTABLISHED.

      • TCP_TOTAL specifies the total number of TCP connections.
      • ESTABLISHED specifies the number of established TCP connections.
eth0
Expressionsobject []No

The expressions that are specified in the multi-metric alert rule.

MetricNamestringNo

The name of the metric that is specified in the multi-metric alert rule. The valid values vary based on the metric type.

  • If you set the MetricType parameter to custom, the valid values are your custom metrics.

  • If you set the MetricType parameter to system, the MetricName parameter has the following valid values:

    • CpuUtilization: the CPU utilization of an ECS instance. Unit: %.
    • IntranetTx: the outbound traffic over the internal network from an ECS instance. Unit: KB/min.
    • IntranetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.
    • VpcInternetTx: the outbound traffic over the Internet from an ECS instance that resides in a VPC. Unit: KB/min.
    • VpcInternetRx: the inbound traffic over the Internet to an ECS instance that resides in a VPC. Unit: KB/min.
    • SystemDiskReadBps: the number of bytes read from the system disk used by an ECS instance per second.
    • SystemDiskWriteBps: the number of bytes written to the system disk used by an ECS instance per second.
    • SystemDiskReadOps: the number of read operations on the system disk used by an ECS instance per second.
    • SystemDiskWriteOps: the number of write operations on the system disk used by an ECS instance per second.
    • CpuUtilizationAgent: the CPU utilization of an agent. Unit: %.
    • GpuUtilizationAgent: the GPU utilization of an agent. Unit: %.
    • GpuMemoryFreeUtilizationAgent: the percentage of idle GPU memory of an agent.
    • GpuMemoryUtilizationAgent: the GPU memory usage of an agent. Unit: %.
    • MemoryUtilization: the memory usage of an agent. Unit: %.
    • LoadAverage: the average system load of an agent.
    • TcpConnection: the total number of TCP connections of an agent.
    • TcpConnection: the number of established TCP connections of an agent.
    • PackagesNetOut: the number of packets that are sent by the internal NIC used by an agent.
    • PackagesNetIn: the number of packets that are received by the internal NIC used by an agent.
    • EciPodCpuUtilization: the CPU utilization of an elastic container instance. Unit: %.
    • EciPodMemoryUtilization: the memory usage of an elastic container instance. Unit: %.

For more information, see Event-triggered task for system monitoring.

CpuUtilization
ComparisonOperatorstringNo

The operator that is used to compare the metric value and the threshold. Valid values:

  • If the metric value is greater than or equal to the threshold, set the value to >=.
  • If the metric value is less than or equal to the threshold, set the value to <=.
  • If the metric value is greater than the threshold, set the value to >.
  • If the metric value is less than the threshold, set the value to <.

Default value: >=.

>=
PeriodintegerNo

The period of time during which statistics about the metrics in the multi-metric alert rule is collected. Unit: seconds. Valid values:

  • 15
  • 60
  • 120
  • 300
  • 900
Note If your scaling group is of the ECS type and the event-triggered task associated with your scaling group monitors CloudMonitor metrics, you can set the Period parameter to 15. In other cases, you can set the Period parameter to 60, 120, 300, or 900. In most cases, the name of a CloudMonitor metric contains Agent.

Default value: 300.

300
StatisticsstringNo

The method that is used to aggregate statistics about the metrics that are specified in the multi-metric alert rule. Valid values:

  • Average
  • Minimum
  • Maximum
Average
ThresholdfloatNo

The thresholds of the metric values in the multi-metric alert rule. If the thresholds are reached the specified number of times within the specified period, a scaling rule is executed.

40.0
ExpressionsLogicOperatorstringNo

The relationship between the trigger conditions in the multi-metric alert rule. Valid values:

  • &&: An alert is triggered only if all metrics in the multi-metric alert rule meet the trigger conditions. In this case, an alert is triggered only if the results of all trigger conditions that are specified in the multi-metric alert rule are true.
  • ||: An alert is triggered if one of the metrics in the multi-metric alert rule meets the trigger condition.

Default value: &&.

&&

Response parameters

ParameterTypeDescriptionExample
object
AlarmTaskIdstring

The ID of the event-triggered task.

asg-bp1hvbnmkl10vll5****_83948190-acdd-483f-98f7-b77f4778****
RequestIdstring

The ID of the request.

BACACF83-7070-4953-A8FD-D81F89F1****

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history