文档

DescribeActiveMetricRuleList - 查询一键报警规则的列表详情

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:DescribeActiveMetricRuleListRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Productstring

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

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

ecs

返回参数

名称类型描述示例值
object

无。

Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

F82E6667-7811-4BA0-842F-5B2DC42BBAAD
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Datapointsobject []

报警规则列表。

SilenceTimestring

通道沉默时间。

单位:秒。

86400
MetricNamestring

监控指标名称。

cpu_total
EvaluationCountstring

报警重试次数。

3
Webhookstring

URL 回调地址。

https://www.aliyun.com
Statestring

报警规则的启用状态。

Enable
ContactGroupsstring

报警联系人组。

ECS_Group
Namespacestring

云产品的命名空间。

acs_ecs_dashboard
RuleNamestring

报警规则名称。

SystemDefault_acs_rds_dashboard_CpuUsage
RuleIdstring

报警规则 ID。

a151cd6023eacee2f0978e03863cc1697c89508****
Periodstring

监控数据的聚合周期。

单位:秒。

60
ComparisonOperatorstring

报警规则比较符。取值:

  • >

  • <

  • >=

  • <=

  • =

  • =

>
EndTimestring

报警规则失效时间。

单位:小时。例如:23 表示23:59:59

24
StartTimestring

报警规则生效起始时间。

单位:小时。例如:00 表示00:00:00

00
Thresholdstring

报警阈值。

90
Statisticsstring

统计方法。

Average
Enablestring

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

  • true:启用。

  • false:禁用。

true
AlertListobject []

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

SilenceTimestring

通道沉默时间。

单位:秒。

86400
MetricNamestring

监控项的名称。

cpu_total
Webhookstring

URL 回调地址。

http://www.aliyun.com
ContactGroupsstring

报警联系人组。

ECS_Group
Namespacestring

云服务的命名空间。

acs_ecs_dashboard
EffectiveIntervalstring

报警规则的生效时间段。

00:00-23:59
NoEffectiveIntervalstring

报警不生效的时间段。

00:00-06:00
MailSubjectstring

发送邮件的主题。

ECS_Bucket
RuleNamestring

报警规则名称。

myAlert
RuleIdstring

报警规则 ID。

ruleIdxxxx
Periodstring

监控数据的聚合周期。

单位:秒。

60
AlertStatestring

报警规则状态。取值:

  • OK:正常。

  • ALARM:报警。

  • INSUFFICIENT_DATA:无数据。

OK
Dimensionsstring

指定资源的监控数据。

""
EnableStateboolean

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

  • true:启用。

  • false:禁用。

true
Resourcesstring

报警规则关联的资源。

[{"resource":"_ALL"}]
Escalationsobject

报警分级别触发条件。

Infoobject

Info 级别报警触发条件。

ComparisonOperatorstring

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

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

Info 级别连续出现次数。

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

3
Thresholdstring

Info 级别阈值。

95
Statisticsstring

Info 级别报警统计方法。

Average
Warnobject

Warn 级别报警触发条件。

ComparisonOperatorstring

Warn 级别阈值比较符。取值:

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

Warn 级别连续出现次数。

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

3
Thresholdstring

Warn 级别阈值。

80
Statisticsstring

Warn 级别报警统计方法。

Average
Criticalobject

Critical 级别报警触发条件。

ComparisonOperatorstring

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

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

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

3
Thresholdstring

Critical 级别阈值。

99
Statisticsstring

Critical 级别报警统计方法。

Average

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "F82E6667-7811-4BA0-842F-5B2DC42BBAAD",
  "Success": true,
  "Datapoints": {
    "Alarm": [
      {
        "SilenceTime": "86400",
        "MetricName": "cpu_total",
        "EvaluationCount": "3",
        "Webhook": "https://www.aliyun.com",
        "State": "Enable",
        "ContactGroups": "ECS_Group",
        "Namespace": "acs_ecs_dashboard",
        "RuleName": "SystemDefault_acs_rds_dashboard_CpuUsage",
        "RuleId": "a151cd6023eacee2f0978e03863cc1697c89508****",
        "Period": "60",
        "ComparisonOperator": ">",
        "EndTime": "24",
        "StartTime": "00",
        "Threshold": "90",
        "Statistics": "Average",
        "Enable": "true"
      }
    ]
  },
  "AlertList": {
    "Alert": [
      {
        "SilenceTime": "86400",
        "MetricName": "cpu_total",
        "Webhook": "http://www.aliyun.com",
        "ContactGroups": "ECS_Group",
        "Namespace": "acs_ecs_dashboard",
        "EffectiveInterval": "00:00-23:59",
        "NoEffectiveInterval": "00:00-06:00",
        "MailSubject": "ECS_Bucket",
        "RuleName": "myAlert",
        "RuleId": "ruleIdxxxx",
        "Period": "60",
        "AlertState": "OK",
        "Dimensions": "\"\"",
        "EnableState": true,
        "Resources": "[{\"resource\":\"_ALL\"}]",
        "Escalations": {
          "Info": {
            "ComparisonOperator": "GreaterThanThreshold",
            "Times": "3",
            "Threshold": "95",
            "Statistics": "Average"
          },
          "Warn": {
            "ComparisonOperator": "GreaterThanThreshold",
            "Times": "3",
            "Threshold": "80",
            "Statistics": "Average"
          },
          "Critical": {
            "ComparisonOperator": "GreaterThanThreshold",
            "Times": "3",
            "Threshold": "99",
            "Statistics": "Average"
          }
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalid%s-
401AccessDeniedExceptionYou donot have sufficient access to perform this action.-
402LimitExceededThe quota for this customer had been reached.-
403AccessForbiddenThe X.509 certificate or cms access key ID provided does not exist in our records.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。

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

变更历史

变更时间变更内容概要操作
暂无变更历史