调用CreateAlarm创建一个报警任务。
接口说明
如果您创建自定义监控类型的报警任务(MetricType=custom),您需要先将自定义监控项指标上报到云监控。具体操作,请参见自定义监控报警任务。
创建报警任务时,您需要指定监控项(MetricName),并配合维度信息(Dimension.N.DimensionKey和Dimension.N.DimensionValue),来确定伸缩组中该监控项数据的聚合范围。例如,指定user_id和scaling_group来确定聚合该用户、该伸缩组下所有ECS实例的监控项数据。系统监控报警任务(MetricType=system)支持的监控项,如下表所示。
- 维度信息中,user_id和scaling_group由系统自动填充,device、state需要您手动指定。更多信息,请参见参数Dimension.N.DimensionKey和Dimension.N.DimensionValue。
- 自定义监控报警任务(MetricType=custom)的监控项取决于您自有的监控指标。
采集来源 |
监控项 |
描述 |
维度信息 |
适用网络 |
---|---|---|---|---|
ECS实例 |
CpuUtilization |
(ECS)CPU使用率(%) |
user_id、scaling_group |
专有网络、经典网络 |
ECS实例 |
IntranetTx |
(ECS)内网出流量(KByte/min) |
user_id、scaling_group |
专有网络、经典网络 |
ECS实例 |
IntranetRx |
(ECS)内网入流量(KByte/min) |
user_id、scaling_group |
专有网络、经典网络 |
ECS实例 |
VpcInternetTx |
(ECS)VPC网络外网出流量(KByte/min) |
user_id、scaling_group |
专有网络 |
ECS实例 |
VpcInternetRx |
(ECS)VPC网络外网入流量(KByte/min) |
user_id、scaling_group |
专有网络 |
ECS实例 |
ClassicInternetTx |
(ECS)经典网络外网出流量(KByte/min) |
user_id、scaling_group |
经典网络 |
ECS实例 |
ClassicInternetRx |
(ECS)经典网络外网入流量(KByte/min) |
user_id、scaling_group |
经典网络 |
ECS实例 |
SystemDiskReadBps |
(ECS)系统盘读BPS(Byte/s) |
user_id、scaling_group |
专有网络、经典网络 |
ECS实例 |
SystemDiskWriteBps |
(ECS)系统盘写BPS(Byte/s) |
user_id、scaling_group |
专有网络、经典网络 |
ECS实例 |
SystemDiskReadOps |
(ECS)系统盘读IOPS(次/s) |
user_id、scaling_group |
专有网络、经典网络 |
ECS实例 |
SystemDiskWriteOps |
(ECS)系统盘写IOPS(次/s) |
user_id、scaling_group |
专有网络、经典网络 |
云监控客户端 |
CpuUtilizationAgent |
(Agent)CPU使用率 (%) |
user_id、scaling_group |
专有网络、经典网络 |
云监控客户端 |
GpuUtilizationAgent |
(Agent)GPU使用率 (%) |
user_id、scaling_group |
专有网络 |
云监控客户端 |
GpuMemoryFreeUtilizationAgent |
(Agent)GPU内存空闲率(%) |
user_id、scaling_group |
专有网络 |
云监控客户端 |
GpuMemoryUtilizationAgent |
(Agent)GPU内存使用率(%) |
user_id、scaling_group |
专有网络 |
云监控客户端 |
MemoryUtilization |
(Agent)内存(%) |
user_id、scaling_group |
专有网络、经典网络 |
云监控客户端 |
LoadAverage |
(Agent)系统平均负载 |
user_id、scaling_group |
专有网络、经典网络 |
云监控客户端 |
TcpConnection |
(Agent)TCP总连接数(个) |
user_id、scaling_group、state |
专有网络、经典网络 |
云监控客户端 |
PackagesNetOut |
(Agent)网卡发包数(个) |
user_id、scaling_group、device |
专有网络、经典网络 |
云监控客户端 |
PackagesNetIn |
(Agent)网卡收包数(个) |
user_id、scaling_group、device |
专有网络、经典网络 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateAlarm |
系统规定参数。取值:CreateAlarm。 |
RegionId | String | 是 | cn-hangzhou |
伸缩组所属的地域ID。 |
Name | String | 否 | TestAlarmTask |
报警任务的名称。 |
Description | String | 否 | Test alarm task. |
报警任务的描述。 |
ScalingGroupId | String | 是 | asg-bp18p2yfxow2dloq**** |
报警任务关联的伸缩组的ID。 |
MetricName | String | 是 | CpuUtilization |
监控项名称。取值范围与报警任务的监控类型有关:
更多信息,请参见本文的接口说明。 |
MetricType | String | 否 | system |
监控项类型。取值范围:
|
Period | Integer | 否 | 300 |
统计监控项数据的周期,单位:秒。取值范围:
默认值:300。 |
Statistics | String | 否 | Average |
统计监控项数据的方法。取值范围:
默认值:Average。 |
Threshold | Float | 是 | 80 |
监控指标的阈值,满足阈值表达式达到指定次数即触发执行伸缩规则。 |
ComparisonOperator | String | 否 | >= |
监控项统计值与阈值的比较符,用于指定监控项统计值与阈值在什么关系下满足条件。取值范围:
默认值:>=。 |
EvaluationCount | Integer | 否 | 3 |
触发执行伸缩规则需要满足阈值表达式的次数,例如,CPU使用率平均值3次的统计结果均大于等于80%。 默认值:3。 |
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:1406926****:scalingrule/asr-bp163l21e07uhn**** |
报警任务关联伸缩规则的唯一标识符。 |
Dimension.N.DimensionKey | String | 否 | device |
监控项关联的维度信息键。取值范围与报警任务的监控类型有关:
|
Dimension.N.DimensionValue | String | 否 | eth0 |
监控项关联的维度信息值,取值范围由Dimension.N.DimensionKey决定:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AlarmTaskId | String | asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1**** |
报警任务ID。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
请求ID。 |
示例
请求示例
http(s)://ess.aliyuncs.com/?Action=CreateAlarm
&RegionId=cn-hangzhou
&Name=TestAlarmTask
&Description=Test alarm task.
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&MetricName=CpuUtilization
&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:1406926****:scalingrule/asr-bp163l21e07uhn****"]
&Dimension=[{"DimensionKey":"device","DimensionValue":"eth0"}]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateAlarmResponse>
<AlarmTaskId>asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****</AlarmTaskId>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</CreateAlarmResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"AlarmTaskId" : "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
访问错误中心查看更多错误码。
HttpCode |
错误码 |
错误信息 |
描述 |
---|---|---|---|
404 |
InvalidParameter |
The specified value of parameter "%s" is not valid. |
指定参数“%s”不合法。 |