如果伸缩组当前的报警任务不再满足需求,您可以调用API ModifyAlarm修改一项或者多项报警任务属性,而无需重新创建新的报警任务,避免不必要的重复操作,节约时间和资源成本。
接口说明
- 如果您创建自定义监控类型的报警任务(MetricType=custom),您需要先将自定义监控项指标上报到云监控。具体操作,请参见自定义监控报警任务。
- 创建报警任务时,您需要指定监控项(MetricName),并配合维度信息(
Dimension.N.DimensionKey
和Dimension.N.DimensionValue
),来确定伸缩组中该监控项数据的聚合范围。例如,指定user_id
和scaling_group
来确定聚合该用户、该伸缩组下所有ECS实例或ECI实例的监控项数据。- 自定义监控报警任务(MetricType=custom)的监控项取决于您自有的监控指标。
- 系统监控报警任务(MetricType=system)支持的监控项的更多信息,请参见系统监控报警任务。
user_id
和scaling_group
由系统自动填充,device
、
state
需要您手动指定。更多信息,请参见参数Dimension.N.DimensionKey
和Dimension.N.DimensionValue
。调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ModifyAlarm | 系统规定参数。取值:ModifyAlarm。 |
RegionId | String | 是 | cn-qingdao | 报警任务所属地域的ID。 |
AlarmTaskId | String | 是 | asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1**** | 报警任务的ID。 |
Name | String | 否 | alarmtask**** | 报警任务的名称。 |
Description | String | 否 | Test alarm task. | 报警任务的描述。 |
MetricName | String | 否 | MemoryUtilization | 监控项名称。取值范围与报警任务的监控类型有关:
更多信息,请参见系统监控报警任务。 |
MetricType | String | 否 | system | 监控项类型。取值范围:
|
Period | Integer | 否 | 300 | 统计监控项数据的周期,单位:秒。取值范围:
|
Statistics | String | 否 | Average | 统计监控项数据的方法。取值范围:
|
Threshold | Float | 否 | 80 | 监控指标的阈值,满足阈值表达式达到指定次数即触发执行伸缩规则。 |
ComparisonOperator | String | 否 | >= | 监控项统计值与阈值的比较符,用于指定监控项统计值与阈值在什么关系下满足条件。取值范围:
|
EvaluationCount | Integer | 否 | 3 | 触发执行伸缩规则需要满足阈值表达式的次数。 例如,CPU使用率平均值3次的统计结果均大于等于80%。 |
GroupId | Integer | 否 | 4055401 | 自定义监控项所属云监控应用分组的ID,仅在监控项类型为custom时需要指定该参数。 |
Effective | String | 否 | TZ=+00 * * 1-2 * * ? | 指定报警任务的生效时间段。 该参数遵循Cron表达式,默认格式为
说明 该参数指定值默认为UTC+8时区,支持在Cron表达式之前添加时区信息 TZ=+yy 来指定时区,其中y表示时区的数值。例如,TZ=+00 * * 1-2 * * ? 表示报警任务在UTC+0时区每天01:00~02:59之间生效。取值示例及含义如下:
|
AlarmAction.N | String | 否 | ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp163l21e07uhn**** | 报警任务关联伸缩规则的唯一标识符。 |
Dimension.N.DimensionKey | String | 否 | device | 监控项关联的维度信息键。取值范围与报警任务的监控类型有关:
|
Dimension.N.DimensionValue | String | 否 | eth0 | 监控项关联的维度信息值,取值范围由Dimension.N.DimensionKey决定:
|
Expression.N.MetricName | String | 否 | CpuUtilization | 多指标报警规则的监控指标名称。取值范围与报警任务的监控类型有关:
更多信息,请参见系统监控报警任务。 |
Expression.N.ComparisonOperator | String | 否 | >= | 多指标报警规则的监控项统计值与阈值的比较符,用于指定监控项统计值与阈值在什么关系下满足条件。取值范围:
默认值: |
Expression.N.Period | Integer | 否 | 300 | 多指标报警规则中统计监控项数据的周期,单位:秒。取值范围:
默认值:300。 |
Expression.N.Statistics | String | 否 | Average | 多指标报警规则中统计监控项数据的方法。取值范围:
|
Expression.N.Threshold | Float | 否 | 40.0 | 多指标报警规则中监控指标的阈值,满足阈值表达式达到指定次数即触发执行伸缩规则。 |
ExpressionsLogicOperator | String | 否 | && | 多指标报警条件之间的关系。取值范围:
默认值: |
返回数据
名称 |
类型 |
示例值 |
描述 |
AlarmTaskId | String | asg-bp1hvbnmkl10vll5**** | 报警任务ID。 |
RequestId | String | BACACF83-7070-4953-A8FD-D81F89F1**** | 请求ID。 |
示例
请求示例
http(s)://ess.aliyuncs.com/?Action=ModifyAlarm
&RegionId=cn-qingdao
&AlarmTaskId=asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****
&Name=alarmtask****
&Description=Test alarm task.
&MetricName=MemoryUtilization
&MetricType=system
&Period=300
&Statistics=Average
&Threshold=80.0
&ComparisonOperator=>=
&EvaluationCount=3
&GroupId=4055401
&Effective=TZ=+00 * * 1-2 * * ?
&AlarmAction=["ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp163l21e07uhn****"]
&Dimension=[{"DimensionKey":"device","DimensionValue":"eth0"}]
&Expression=[{"MetricName":"CpuUtilization","ComparisonOperator":">=","Period":300,"Statistics":"Average","Threshold":40.0}]
&ExpressionsLogicOperator=&&
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyAlarmResponse>
<AlarmTaskId>asg-bp1hvbnmkl10vll5****</AlarmTaskId>
<RequestId>BACACF83-7070-4953-A8FD-D81F89F1****</RequestId>
</ModifyAlarmResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"AlarmTaskId" : "asg-bp1hvbnmkl10vll5****",
"RequestId" : "BACACF83-7070-4953-A8FD-D81F89F1****"
}
错误码
访问错误中心查看更多错误码。