调用CreateGroupMetricRules接口批量为指定应用分组创建报警规则。
本文将提供一个示例,为应用分组123456
中的云服务器ECS的监控项cpu_total
创建一条报警规则,其中报警规则ID为456789
,报警规则名称为ECS_Rule1
,报警级别为Critical
,报警统计方法为Average
,报警阈值比较符为GreaterThanOrEqualToThreshold
,报警阈值为90
,报警重试次数为3
。返回结果显示,报警规则ECS_Rule1
创建成功。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateGroupMetricRules | 要执行的操作,取值:CreateGroupMetricRules。 |
GroupId | Long | 是 | 3607**** | 应用分组ID。 关于如何获取应用分组ID,请参见DescribeMonitorGroups。 |
GroupMetricRules.N.Escalations.Info.Threshold | String | 否 | 10 | 普通级别报警阈值。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.MetricName | String | 是 | cpu_total | 监控项名称。 N的取值范围:1~200。 关于如何获取监控项名称,请参见DescribeMetricMetaList或云产品监控项。 |
GroupMetricRules.N.Escalations.Warn.Threshold | String | 否 | 20 | 警告级别报警阈值。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.EffectiveInterval | String | 否 | 05:31-23:59 | 报警规则的生效时间范围。N的取值范围:1~200。 |
GroupMetricRules.N.NoEffectiveInterval | String | 否 | 00:00-05:30 | 报警规则的失效时间范围。N的取值范围:1~200。 |
GroupMetricRules.N.RuleId | String | 是 | 456789 | 报警规则ID。 N的取值范围:1~200。 |
GroupMetricRules.N.Escalations.Critical.Times | Integer | 否 | 3 | 发送紧急报警通知需要监控指标达到报警阈值的次数。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.Dimensions | String | 否 | [{"instanceId":"i-m5e1qg6uo38rztr4****"}] | 指定资源的监控维度。 格式: |
GroupMetricRules.N.Escalations.Critical.Threshold | String | 否 | 90 | 触发紧急级别报警通知的阈值。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.Escalations.Critical.Statistics | String | 否 | Average | 紧急级别报警统计方法。 N的取值范围:1~200。 该参数的取值由指定云产品的 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.Escalations.Warn.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold | 警告级别阈值比较符。取值:
N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.Escalations.Info.Times | Integer | 否 | 1 | 发送普通报警通知需要监控指标达到报警阈值的次数。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.SilenceTime | Integer | 否 | 86400 | 报警通知的沉默周期。N的取值范围:1~200。 单位:秒。默认值:86400。最小值:3600。 |
GroupMetricRules.N.Webhook | String | 否 | https://www.aliyun.com | 报警发生回调时的URL地址。N的取值范围:1~200。 填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。 |
GroupMetricRules.N.Namespace | String | 是 | acs_ecs_dashboard | 云产品的数据命名空间。 N的取值范围:1~200。 关于如何获取云产品的数据命名空间,请参见DescribeMetricMetaList或云产品监控项。 |
GroupMetricRules.N.EmailSubject | String | 否 | ECS实例 | 报警邮件主题。 N的取值范围:1~200。 |
GroupMetricRules.N.Period | String | 否 | 60 | 监控数据的上报周期。 N的取值范围:1~200。
|
GroupMetricRules.N.RuleName | String | 是 | ECS_Rule1 | 报警规则名称。 N的取值范围:1~200。 |
GroupMetricRules.N.Escalations.Info.Statistics | String | 否 | Average | 普通级别报警统计方法。 N的取值范围:1~200。 该参数的取值由指定云产品的 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.Escalations.Warn.Times | Integer | 否 | 3 | 发送警告报警通知需要监控指标达到报警阈值的次数。 N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.Escalations.Info.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold | 普通级别阈值比较符。取值:
N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.Interval | String | 否 | 60 | 报警规则的探测周期。 N的取值范围:1~200。 单位:秒。秒默认为监控项的最小频率。 说明 建议报警规则的探测周期和数据上报周期保持一致。如果报警规则的探测周期小于数据上报周期,会因为数据不足而不能触发报警。 |
GroupMetricRules.N.Category | String | 是 | ECS | 云产品名称缩写。 N的取值范围:1~200。 关于如何获取云产品名称缩写,请参见DescribeProjectMeta接口的返回参数 |
GroupMetricRules.N.Escalations.Critical.ComparisonOperator | String | 否 | GreaterThanOrEqualToThreshold | 紧急级别阈值比较符。取值:
N的取值范围:1~200。 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.Escalations.Warn.Statistics | String | 否 | Average | 警告级别报警统计方法。 N的取值范围:1~200。 该参数的取值由指定云产品的 说明 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。 |
GroupMetricRules.N.NoDataPolicy | String | 否 | KEEP_LAST_STATE | 无监控数据时报警的处理方式。取值:
N的取值范围:1~200。 |
GroupMetricRules.N.ContactGroups | String | 否 | ECS_Group | 报警联系人组。 N的取值范围:1~200。 关于如何获取报警联系人组,请参见DescribeContactGroupList。 |
GroupMetricRules.N.Labels.N.Key | String | 否 | key1 | 报警规则的标签键。报警通知中会包含标签。 N的取值范围:1~200。 |
GroupMetricRules.N.Labels.N.Value | String | 否 | value1 | 报警规则的标签值。报警通知中会包含标签。 N的取值范围:1~200。 |
关于公共请求参数的详情,请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | Integer | 200 | 状态码。 说明 200表示成功。 |
Message | String | The Request is not authorization. | 报错信息。 |
RequestId | String | 461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D | 请求ID。 |
Success | Boolean | true | 操作是否成功。取值:
|
Resources | Array of AlertResult | 报警规则列表。 |
|
AlertResult | |||
Code | Integer | 200 | 新创建报警规则的状态码。 说明 200表示成功。 |
Message | String | Metric not found. | 新创建报警规则的错误信息。 |
Success | Boolean | true | 新创建报警规则是否成功。取值:
|
RuleName | String | ECS_Rule1 | 新创建报警规则的名称。 |
RuleId | String | 456789 | 新创建报警规则的ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateGroupMetricRules
&GroupId=123456
&GroupMetricRules.1.Category=ECS
&GroupMetricRules.1.MetricName=cpu_total
&GroupMetricRules.1.1amespace=acs_ecs_dashboard
&GroupMetricRules.1.RuleId=456789
&GroupMetricRules.1.RuleName=ECS_Rule1
&GroupMetricRules.1.Escalations.Critical.Statistics=Average
&GroupMetricRules.1.Escalations.Critical.ComparisonOperator=GreaterThanOrEqualToThreshold
&GroupMetricRules.1.Escalations.Critical.Threshold=90
&GroupMetricRules.1.Escalations.Critical.Times=3
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateGroupMetricRulesResponse>
<RequestId>CED22B00-CFD8-5BDF-A645-CAF7B81FAE45</RequestId>
<Resources>
<AlertResult>
<RuleId>456789</RuleId>
<Code>200</Code>
<Success>true</Success>
<RuleName>ECS_Rule1</RuleName>
</AlertResult>
</Resources>
<Code>200</Code>
<Success>true</Success>
</CreateGroupMetricRulesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "CED22B00-CFD8-5BDF-A645-CAF7B81FAE45",
"Resources" : {
"AlertResult" : [ {
"RuleId" : "456789",
"Code" : 200,
"Success" : true,
"RuleName" : "ECS_Rule1"
} ]
},
"Code" : 200,
"Success" : true
}
错误码
访问错误中心查看更多错误码。