调用PutGroupMetricRule接口创建或修改指定应用分组中的报警规则。
本文将提供一个示例,为应用分组17285****
中的云服务器ECS的监控项cpu_total
创建一条报警规则,其中报警规则的ID为123456
,报警规则名称为Rule_test
,报警级别为Critical
,报警统计方法为Average
,报警阈值比较符为GreaterThanOrEqualToThreshold
,报警阈值为90
,报警重试次数为3
。返回结果显示,创建报警规则成功,报警规则ID为123456
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | PutGroupMetricRule |
要执行的操作,取值:PutGroupMetricRule。 |
GroupId | String | 是 | 17285**** |
应用分组ID。 关于如何获取应用分组ID,请参见DescribeMonitorGroups。 |
RuleId | String | 是 | 123456 |
报警规则ID。
|
Category | String | 否 | ECS |
云产品名称。取值:
|
RuleName | String | 是 | Rule_01 |
报警规则名称。
|
Namespace | String | 是 | acs_ecs_dashboard |
云产品的命名空间。 关于如何获取云产品的命名空间,请参见DescribeMetricMetaList或云产品监控项。 |
MetricName | String | 是 | cpu_total |
监控项名称。 关于如何获取监控项名称,请参见DescribeMetricMetaList或云产品监控项。 |
Dimensions | String | 否 | [{"instanceId":"i-m5e1qg6uo38rztr4****"}] |
应用分组中报警规则的第一级维度。 格式:key-value键值对形式的集合,例如: |
ExtraDimensionJson | String | 否 | {"/dev/xvda":"d-m5e6yphgzn3aprwu****"} |
应用分组中报警规则的第二级或第三级维度。 格式:key-value键值对形式的集合,例如: 当报警规则的第一级维度为 |
EffectiveInterval | String | 否 | 05:31-23:59 |
报警规则的生效时间范围。 |
NoEffectiveInterval | String | 否 | 00:00-05:30 |
报警规则的失效时间范围。 |
SilenceTime | Integer | 否 | 86400 |
通道沉默周期。 单位:秒。默认值:86400。 |
Period | String | 否 | 60 |
监控数据的上报周期。
|
Interval | String | 否 | 60 |
报警规则的探测周期。单位:秒。 说明 建议报警规则的探测周期和数据上报周期保持一致。如果报警规则的探测周期小于数据上报周期,会因为数据不足而不能触发报警。
|
Webhook | String | 否 | https://www.aliyun.com |
报警发生回调时的URL地址。 填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。 |
EmailSubject | String | 否 | ECS实例 |
报警邮件主题。 |
ContactGroups | String | 否 | ECS_Group |
报警联系组。 |
Escalations.Critical.Statistics | String | 否 | Average |
Critical级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。取值:
|
Escalations.Critical.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold |
Critical级别阈值比较符。取值:
|
Escalations.Critical.Threshold | String | 否 | 90 |
Critical级别报警阈值。 |
Escalations.Critical.Times | Integer | 否 | 3 |
Critical级别报警重试次数。 |
Escalations.Warn.Statistics | String | 否 | Average |
Warn级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。取值:
|
Escalations.Warn.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold |
Warn级别阈值比较符。取值:
|
Escalations.Warn.Threshold | String | 否 | 90 |
Warn级别报警阈值。 |
Escalations.Warn.Times | Integer | 否 | 3 |
Warn级别报警重试次数。 |
Escalations.Info.Statistics | String | 否 | Average |
Info级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。取值:
|
Escalations.Info.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold |
Info级别阈值比较符。取值:
|
Escalations.Info.Threshold | String | 否 | 90 |
Info级别报警阈值。 |
Escalations.Info.Times | Integer | 否 | 3 |
Info级别报警重试次数。 |
NoDataPolicy | String | 否 | KEEP_LAST_STATE |
无监控数据时报警的处理方式。取值:
|
Labels.N.Key | String | 否 | key1 |
报警规则的标签键。 |
Labels.N.Value | String | 否 | value1 |
报警规则的标签值。 |
关于公共请求参数的详情,请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 |
状态码。 说明 200表示成功。
|
Message | String | The Request is not authorization. |
报错信息。 |
RequestId | String | 461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D |
请求ID。 |
Success | Boolean | true |
操作是否成功。取值:
|
Result | Object |
创建或修改报警规则的结果。 |
|
RuleId | String | 123456 |
报警规则ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=PutGroupMetricRule
&Category=ECS
&GroupId=17285****
&MetricName=cpu_total
&Namespace=acs_ecs_dashboard
&RuleId=123456
&RuleName=`Rule_test
&Escalations.Critical.Statistics=Average
&Escalations.Critical.ComparisonOperator=GreaterThanOrEqualToThreshold
&Escalations.Critical.Threshold=90
&Escalations.Critical.Times=3
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<PutGroupMetricRuleResponse>
<Message></Message>
<RequestId>461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D</RequestId>
<Code>200</Code>
<Success>true</Success>
<Result>
<RuleId>123456</RuleId>
</Result>
</PutGroupMetricRuleResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "",
"RequestId" : "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
"Code" : 200,
"Success" : true,
"Result" : {
"RuleId" : "123456"
}
}
错误码
访问错误中心查看更多错误码。