调用DescribeActiveMetricRuleList接口查询一键报警规则的列表详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeActiveMetricRuleList

要执行的操作，取值：DescribeActiveMetricRuleList。
Product String 是 ecs

支持一键报警规则的云产品名称缩写。

关于如何获取云产品名称，请参见DescribeProductsOfActiveMetricRule。

返回数据

名称 类型 示例值 描述
Code String 200

状态码。

说明 200表示成功。
Message String The Request is not authorization.

错误信息。
RequestId String F82E6667-7811-4BA0-842F-5B2DC42BBAAD

请求ID。
Success Boolean true

操作是否成功。取值：

  • true：成功。
  • false：失败。
Datapoints Array of Alarm

报警规则列表。
Alarm
SilenceTime String 86400

通道沉默时间。

单位：秒。
MetricName String cpu_total

监控指标名称。
EvaluationCount String 3

报警重试次数。
Webhook String https://www.aliyun.com

URL回调地址。
State String Enable

报警规则的启用状态。
ContactGroups String ECS_Group

报警联系人组。
Namespace String acs_ecs_dashboard

云产品的命名空间。
RuleName String SystemDefault_acs_rds_dashboard_CpuUsage

报警规则名称。
RuleId String a151cd6023eacee2f0978e03863cc1697c89508****

报警规则ID。
Period String 60

监控数据的聚合周期。

单位：秒。
ComparisonOperator String >

报警规则比较符。取值：

  • >
  • <
  • >=
  • <=
  • =
  • =
EndTime String 24

报警规则失效时间。

单位：小时。例如：23表示23:59:59。
StartTime String 00

报警规则生效起始时间。

单位：小时。例如：00表示00：00：00。
Threshold String 90

报警阈值。
Statistics String Average

统计方法。
Enable String true

报警规则的启用状态。取值：

  • true：启用。
  • false：禁用。
AlertList Array of Alert

报警规则列表。该列表的结构和获取报警规则列表保持统一。
Alert
SilenceTime String 86400

通道沉默时间。

单位：秒。
MetricName String cpu_total

监控项的名称。
Webhook String http://www.aliyun.com

URL回调地址。
ContactGroups String ECS_Group

报警联系人组。
Namespace String acs_ecs_dashboard

云服务的命名空间。
EffectiveInterval String 00:00-23:59

报警规则的生效时间段。
NoEffectiveInterval String 00:00-06:00

报警不生效的时间段。
MailSubject String ECS_Bucket

发送邮件的主题。
RuleName String myAlert

报警规则名称。
RuleId String ruleIdxxxx

报警规则ID。
Period String 60

监控数据的聚合周期。

单位：秒。
AlertState String OK

报警规则状态。取值：

  • OK：正常。
  • ALARM：报警。
  • INSUFFICIENT_DATA：无数据。
Dimensions String ""

指定资源的监控数据。
EnableState Boolean true

报警规则的启用状态。取值：

  • true：启用。
  • false：禁用。
Resources String [{"resource":"_ALL"}]

报警规则关联的资源。

Escalations Object

报警分级别触发条件。
Info Object

Info级别报警触发条件。
ComparisonOperator String GreaterThanThreshold

Info级别阈值比较符。取值：

  • GreaterThanOrEqualToThreshold：大于等于。
  • GreaterThanThreshold：大于。
  • LessThanOrEqualToThreshold：小于等于。
  • LessThanThreshold：小于。
  • NotEqualToThreshold：不等。
  • GreaterThanYesterday：同比昨天时间上涨。
  • LessThanYesterday：同比昨天时间下降。
  • GreaterThanLastWeek：同比上周同一时间上涨。
  • LessThanLastWeek：同比上周同一时间下降。
  • GreaterThanLastPeriod：环比上周期上涨。
  • LessThanLastPeriod：环比上周期下降。
Times String 3

Info级别连续出现次数。

Info级别连续出现达到该值且超过阈值才会触发报警。
Threshold String 95

Info级别阈值。
Statistics String Average

Info级别报警统计方法。
Warn Object

Wan级别报警触发条件。
ComparisonOperator String GreaterThanThreshold

Critical级别阈值比较符。取值：

  • GreaterThanOrEqualToThreshold：大于等于。
  • GreaterThanThreshold：大于。
  • LessThanOrEqualToThreshold：小于等于。
  • LessThanThreshold：小于。
  • NotEqualToThreshold：不等。
  • GreaterThanYesterday：同比昨天时间上涨。
  • LessThanYesterday：同比昨天时间下降。
  • GreaterThanLastWeek：同比上周同一时间上涨。
  • LessThanLastWeek：同比上周同一时间下降。
  • GreaterThanLastPeriod：环比上周期上涨。
  • LessThanLastPeriod：环比上周期下降。
Times String 3

Wan级别连续出现次数。Wan级别连续出现达到该值且超过阈值才会触发报警。
Threshold String 80

Warn级别阈值。
Statistics String Average

Warn级别报警统计方法。
Critical Object

Critical级别报警触发条件。
ComparisonOperator String GreaterThanThreshold

Critical级别阈值比较符。取值：

  • GreaterThanOrEqualToThreshold：大于等于。
  • GreaterThanThreshold：大于。
  • LessThanOrEqualToThreshold：小于等于。
  • LessThanThreshold：小于。
  • NotEqualToThreshold：不等。
  • GreaterThanYesterday：同比昨天时间上涨。
  • LessThanYesterday：同比昨天时间下降。
  • GreaterThanLastWeek：同比上周同一时间上涨。
  • LessThanLastWeek：同比上周同一时间下降。
  • GreaterThanLastPeriod：环比上周期上涨。
  • LessThanLastPeriod：环比上周期下降。
Times String 3

Critical级别连续出现次数。Critical级别连续出现达到该值且超过阈值才会触发报警。
Threshold String 99

Critical级别阈值。
Statistics String Average

Critical级别报警统计方法。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeActiveMetricRuleList
&Product=ecs
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeActiveMetricRuleListResponse>
		<AlertList>
			<Alert>
				<SilenceTime>86400</SilenceTime>
				<ContactGroups>ECS_Group</ContactGroups>
				<NoEffectiveInterval></NoEffectiveInterval>
				<MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>
				<RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>
				<Period>300</Period>
				<Dimensions></Dimensions>
				<EffectiveInterval></EffectiveInterval>
				<Namespace>acs_rds_dashboard</Namespace>
				<AlertState>INSUFFICIENT_DATA</AlertState>
				<MetricName>IOPSUsage</MetricName>
				<EnableState>true</EnableState>
				<Escalations>
					<Critical />
					<Info>
						<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
						<Times>5</Times>
						<Statistics>Average</Statistics>
						<Threshold>80</Threshold>
					</Info>
					<Warn />
				</Escalations>
				<Webhook></Webhook>
				<Resources>[{\"resource\":\"_ALL\"}]</Resources>
				<RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>
			</Alert>
			<Alert>
				<SilenceTime>86400</SilenceTime>
				<ContactGroups>ECS_Group</ContactGroups>
				<NoEffectiveInterval></NoEffectiveInterval>
				<MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>
				<RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>
				<Period>300</Period>
				<Dimensions></Dimensions>
				<EffectiveInterval></EffectiveInterval>
				<Namespace>acs_rds_dashboard</Namespace>
				<AlertState>INSUFFICIENT_DATA</AlertState>
				<MetricName>CpuUsage</MetricName>
				<EnableState>true</EnableState>
				<Escalations>
					<Critical />
					<Info>
						<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
						<Times>5</Times>
						<Statistics>Average</Statistics>
						<Threshold>80</Threshold>
					</Info>
					<Warn />
				</Escalations>
				<Webhook></Webhook>
				<Resources>[{\"resource\":\"_ALL\"}]</Resources>
				<RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>
			</Alert>
		</AlertList>
		<Datapoints>
			<Alarm>
				<SilenceTime>86400</SilenceTime>
				<ContactGroups>[\"Alice\"]</ContactGroups>
				<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
				<EndTime></EndTime>
				<RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>
				<StartTime></StartTime>
				<Period>300</Period>
				<EvaluationCount>5</EvaluationCount>
				<Statistics>Average</Statistics>
				<Namespace>acs_rds_dashboard</Namespace>
				<MetricName>IOPSUsage</MetricName>
				<State>INSUFFICIENT_DATA</State>
				<Enable>true</Enable>
				<Webhook></Webhook>
				<RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>
				<Threshold>80</Threshold>
			</Alarm>
			<Alarm>
				<SilenceTime>86400</SilenceTime>
				<ContactGroups>[\"Jim\"]</ContactGroups>
				<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
				<EndTime></EndTime>
				<RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>
				<StartTime></StartTime>
				<Period>300</Period>
				<EvaluationCount>5</EvaluationCount>
				<Statistics>Average</Statistics>
				<Namespace>acs_rds_dashboard</Namespace>
				<MetricName>CpuUsage</MetricName>
				<State>INSUFFICIENT_DATA</State>
				<Enable>true</Enable>
				<Webhook></Webhook>
				<RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>
				<Threshold>80</Threshold>
			</Alarm>
		</Datapoints>
		<Code>200</Code>
		<Success>true</Success>
</DescribeActiveMetricRuleListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AlertList" : {
    "Alert" : [ {
      "SilenceTime" : 86400,
      "ContactGroups" : "ECS_Group",
      "NoEffectiveInterval" : "",
      "MailSubject" : "${serviceType}-${metricName}-${levelDescription}",
      "RuleId" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "Period" : 300,
      "Dimensions" : "",
      "EffectiveInterval" : "",
      "Namespace" : "acs_rds_dashboard",
      "AlertState" : "INSUFFICIENT_DATA",
      "MetricName" : "IOPSUsage",
      "EnableState" : true,
      "Escalations" : {
        "Critical" : { },
        "Info" : {
          "ComparisonOperator" : "GreaterThanThreshold",
          "Times" : 5,
          "Statistics" : "Average",
          "Threshold" : "80"
        },
        "Warn" : { }
      },
      "Webhook" : "",
      "Resources" : "[{\"resource\":\"_ALL\"}]",
      "RuleName" : "SystemDefault_acs_rds_dashboard_IOPSUsage"
    }, {
      "SilenceTime" : 86400,
      "ContactGroups" : "ECS_Group",
      "NoEffectiveInterval" : "",
      "MailSubject" : "${serviceType}-${metricName}-${levelDescription}",
      "RuleId" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "Period" : 300,
      "Dimensions" : "",
      "EffectiveInterval" : "",
      "Namespace" : "acs_rds_dashboard",
      "AlertState" : "INSUFFICIENT_DATA",
      "MetricName" : "CpuUsage",
      "EnableState" : true,
      "Escalations" : {
        "Critical" : { },
        "Info" : {
          "ComparisonOperator" : "GreaterThanThreshold",
          "Times" : 5,
          "Statistics" : "Average",
          "Threshold" : "80"
        },
        "Warn" : { }
      },
      "Webhook" : "",
      "Resources" : "[{\"resource\":\"_ALL\"}]",
      "RuleName" : "SystemDefault_acs_rds_dashboard_CpuUsage"
    } ]
  },
  "Datapoints" : {
    "Alarm" : [ {
      "SilenceTime" : 86400,
      "ContactGroups" : "[\"Alice\"]",
      "ComparisonOperator" : "GreaterThanThreshold",
      "EndTime" : "",
      "RuleId" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "StartTime" : "",
      "Period" : 300,
      "EvaluationCount" : 5,
      "Statistics" : "Average",
      "Namespace" : "acs_rds_dashboard",
      "MetricName" : "IOPSUsage",
      "State" : "INSUFFICIENT_DATA",
      "Enable" : true,
      "Webhook" : "",
      "RuleName" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "Threshold" : "80"
    }, {
      "SilenceTime" : 86400,
      "ContactGroups" : "[\"Jim\"]",
      "ComparisonOperator" : "GreaterThanThreshold",
      "EndTime" : "",
      "RuleId" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "StartTime" : "",
      "Period" : 300,
      "EvaluationCount" : 5,
      "Statistics" : "Average",
      "Namespace" : "acs_rds_dashboard",
      "MetricName" : "CpuUsage",
      "State" : "INSUFFICIENT_DATA",
      "Enable" : true,
      "Webhook" : "",
      "RuleName" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "Threshold" : "80"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

访问错误中心查看更多错误码。