首页云监控云监控1.0开发参考API参考API目录报警服务阈值报警规则DescribeAlertingMetricRuleResources - 查询指定报警规则中正在发生报警的资源列表
输入文档关键字查找

DescribeAlertingMetricRuleResources - 查询指定报警规则中正在发生报警的资源列表

更新时间：2024-08-23 06:24
产品详情
社区

调用DescribeAlertingMetricRuleResources接口查询指定报警规则中正在发生报警的资源列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
RuleIdstring否

报警规则 ID。关于如何查询报警规则 ID，请参见 DescribeMetricRuleList 。

putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****
GroupIdstring否

应用分组 ID。关于如何查询应用分组 ID，请参见 DescribeMonitorGroups 。

7671****
Pageinteger否

分页页码。

默认值：1 。

1
PageSizeinteger否

分页大小。

默认值：10。

10
Namespacestring否

云产品的数据命名空间。

关于如何获取云产品的数据命名空间，请参见云产品监控项。

acs_mns_new
Dimensionsstring否

维度 Map，用于查询指定资源的监控数据。

{\"userId\":\"120886317861****\",\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\"}
AlertBeforeTimestring否

用于查询在这个时刻之前发生的报警。支持毫秒时间戳。

1698827400000

关于公共请求参数的详情，请参见公共参数。

返回参数

名称类型描述示例值
名称类型描述示例值
object

无。

Codeinteger

状态码。

说明
200 表示成功。
200
Messagestring

错误信息。

The request processing has failed due to some unknown error.
RequestIdstring

请求 ID。

0724011B-D9E0-4B2F-8C51-F17A894CC42C
Totalinteger

总记录条数。

2
Successboolean

操作是否成功。取值：

  • true：成功。

  • false：失败。

true
Resourcesarray<object>

报警规则的资源列表。

object

无。

MetricNamestring

监控项名称。

ActiveMessages
RetryTimesstring

报警重试次数。

3
MetricValuesstring

触发报警时监控项的值。格式为一个 JSON 字符串。

{\"timestamp\":1623727500000,\"Sum\":926,\"value\":463,\"Maximum\":463,\"Minimum\":463,\"Average\":463,\"SampleCount\":2,\"userId\":\"120886317861****\",\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\"}
Namespacestring

云产品的数据命名空间。

acs_mns_new
RuleNamestring

报警规则名称。

test123456789
RuleIdstring

报警规则 ID。

putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****
ProductCategorystring

云产品类型。

mns
StartTimestring

资源被关联到报警规则的时间戳。

单位：毫秒。

1622427900000
Resourcestring

报警的资源。

userId=120886317861****,region=cn-huhehaote,queue=test-0128
LastModifyTimestring

最后一次修改报警规则的时间戳。

单位：毫秒。

1622827900000
GroupIdstring

应用分组 ID。

说明
如果报警规则与指定应用分组关联，则显示该应用分组 ID。
7671****
Dimensionsstring

维度 Map，用于查询指定资源的监控数据。

{\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\",\"userId\":\"120886317861****\"}
LastAlertTimestring

最后一次触发报警的时间戳。

单位：毫秒。

1622427900000
Levelinteger

报警的级别和通知方式。取值：

  • 4：邮件+钉钉机器人。

  • OK：无报警。

3
Thresholdstring

报警阈值。

10
Statisticsstring

报警统计方法。

Average
Enablestring

是否启用报警规则。取值：

  • true：启用报警规则。

  • false：不启用报警规则。

true
Escalationarray<object>

触发报警的规则。

object

无。

ComparisonOperatorstring

阈值比较符。取值：

  • GreaterThanOrEqualToThreshold：大于等于。

  • GreaterThanThreshold：大于。

  • LessThanOrEqualToThreshold：小于等于。

  • LessThanThreshold：小于。

  • NotEqualToThreshold：不等于。

  • GreaterThanYesterday：同比昨天时间上涨。

  • LessThanYesterday：同比昨天时间下降。

  • GreaterThanLastWeek：同比上周同一时间上涨。

  • LessThanLastWeek：同比上周同一时间下降。

  • GreaterThanLastPeriod：环比上周期上涨。

  • LessThanLastPeriod：环比上周期下降。

GreaterThanOrEqualToThreshold
PreConditionstring

阈值比较符号。取值：

  • >=

  • =

  • <=

  • >

  • <

  • !=

>=
Expressionstring

触发报警的规则描述。

说明
报警规则的主体，当监控数据满足报警条件时，触发报警规则。
$Average>=10
Timesinteger

报警重试次数。

1
Tagstring

该参数已废弃，无需关注。

无
Thresholdstring

报警阈值。

10
Levelinteger

报警的级别和通知方式。取值：

  • 4：邮件+钉钉机器人。

  • OK：无报警。

3
ExpressionListJoinstring

多个监控项之间的关系。取值：

  • &&：当所有监控项都满足报警条件时，发送报警通知。
  • ||：当其中一个监控项满足报警条件时，发送报警通知。
&&
ExpressionListarray<object>

多指标报警规则描述。

object

无。

ComparisonOperatorstring

报警级别的阈值比较符。取值：

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

监控项名称。

cpu_total
Periodstring

监控项的统计周期。单位：秒。默认为监控项的原始上报周期。

60
Statisticsstring

报警级别的统计方法。取值：

  • Maximum：最大值。
  • Minimum：最小值。
  • Average：平均值。
Average
Thresholdstring

报警阈值。

90
ExpressionRawstring

表达式创建的报警条件。包括但不限于以下情况：

  • 为部分资源设置报警黑名单，例如：$instanceId != 'i-io8kfvcpp7x5****' ``&&`` $Average > 50，表示当报警规则中的实例i-io8kfvcpp7x5****的Average大于 50 时，也不会产生报警。
  • 对规则中的指定实例设置特殊报警阈值，例如：$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)，表示当报警规则中的实例i-io8kfvcpp7x5****的Average大于 80 时，才报警，其他实例的Average大于 50，即可报警。
  • 对规则中超过阈值的实例数量进行限制，例如：count($Average > 20) > 3，表示当报警规则中的Average大于 20 的实例数大于 3 个时，才进行报警。
$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "0724011B-D9E0-4B2F-8C51-F17A894CC42C",
  "Total": 2,
  "Success": true,
  "Resources": {
    "Resource": [
      {
        "MetricName": "ActiveMessages",
        "RetryTimes": "3",
        "MetricValues": "{\\\"timestamp\\\":1623727500000,\\\"Sum\\\":926,\\\"value\\\":463,\\\"Maximum\\\":463,\\\"Minimum\\\":463,\\\"Average\\\":463,\\\"SampleCount\\\":2,\\\"userId\\\":\\\"120886317861****\\\",\\\"region\\\":\\\"cn-huhehaote\\\",\\\"queue\\\":\\\"test-0128\\\"}",
        "Namespace": "acs_mns_new",
        "RuleName": "test123456789",
        "RuleId": "putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****",
        "ProductCategory": "mns",
        "StartTime": "1622427900000",
        "Resource": "userId=120886317861****,region=cn-huhehaote,queue=test-0128",
        "LastModifyTime": "1622827900000",
        "GroupId": "7671****",
        "Dimensions": "{\\\"region\\\":\\\"cn-huhehaote\\\",\\\"queue\\\":\\\"test-0128\\\",\\\"userId\\\":\\\"120886317861****\\\"}",
        "LastAlertTime": "1622427900000",
        "Level": 3,
        "Threshold": "10",
        "Statistics": "Average",
        "Enable": "true",
        "Escalation": {
          "Resource": [
            {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "PreCondition": ">=",
              "Expression": "$Average>=10",
              "Times": 1,
              "Tag": "无",
              "Threshold": "10",
              "Level": 3,
              "ExpressionListJoin": "&&",
              "ExpressionList": {
                "ExpressionList": [
                  {
                    "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                    "MetricName": "cpu_total",
                    "Period": "60",
                    "Statistics": "Average",
                    "Threshold": "90"
                  }
                ]
              },
              "ExpressionRaw": "$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
HTTP status code错误码错误信息
400%s%s
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2023-10-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
上一篇：DescribeMetricRuleCount - 获取各种状态报警规则的数量下一篇：PutMetricRuleTargets - 为指定报警规则添加或修改推送渠道
  • 本页导读 （1）
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
文档反馈
phone 联系我们

立即和Alibaba Cloud在线服务人员进行交谈，获取您想了解的产品信息以及最新折扣。

alicare alicarealicarealicare