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

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cms:DescribeAlertingMetricRuleResources	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RuleId	string	否	报警规则 ID。关于如何查询报警规则 ID，请参见 DescribeMetricRuleList 。	putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****
GroupId	string	否	应用分组 ID。关于如何查询应用分组 ID，请参见 DescribeMonitorGroups 。	7671****
Page	integer	否	分页页码。默认值：1 。	1
PageSize	integer	否	分页大小。默认值：10。	10
Namespace	string	否	云产品的数据命名空间。关于如何获取云产品的数据命名空间，请参见云产品监控项。	acs_mns_new
Dimensions	string	否	维度 Map，用于查询指定资源的监控数据。	{\"userId\":\"120886317861****\",\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\"}
AlertBeforeTime	string	否	用于查询在这个时刻之前发生的报警。支持毫秒时间戳。	1698827400000

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

返回参数

名称	类型	描述	示例值
	object	无。
Code	integer	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The request processing has failed due to some unknown error.
RequestId	string	请求 ID。	0724011B-D9E0-4B2F-8C51-F17A894CC42C
Total	integer	总记录条数。	2
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
Resources	array<object>	报警规则的资源列表。
	object	无。
MetricName	string	监控项名称。	ActiveMessages
RetryTimes	string	报警重试次数。	3
MetricValues	string	触发报警时监控项的值。格式为一个 JSON 字符串。	{\"timestamp\":1623727500000,\"Sum\":926,\"value\":463,\"Maximum\":463,\"Minimum\":463,\"Average\":463,\"SampleCount\":2,\"userId\":\"120886317861****\",\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\"}
Namespace	string	云产品的数据命名空间。	acs_mns_new
RuleName	string	报警规则名称。	test123456789
RuleId	string	报警规则 ID。	putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****
ProductCategory	string	云产品类型。	mns
StartTime	string	资源被关联到报警规则的时间戳。单位：毫秒。	1622427900000
Resource	string	报警的资源。	userId=120886317861****,region=cn-huhehaote,queue=test-0128
LastModifyTime	string	最后一次修改报警规则的时间戳。单位：毫秒。	1622827900000
GroupId	string	应用分组 ID。说明如果报警规则与指定应用分组关联，则显示该应用分组 ID。	7671****
Dimensions	string	维度 Map，用于查询指定资源的监控数据。	{\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\",\"userId\":\"120886317861****\"}
LastAlertTime	string	最后一次触发报警的时间戳。单位：毫秒。	1622427900000
Level	integer	报警的级别和通知方式。取值： 4：邮件+钉钉机器人。 OK：无报警。	3
Threshold	string	报警阈值。	10
Statistics	string	报警统计方法。	Average
Enable	string	是否启用报警规则。取值： true：启用报警规则。 false：不启用报警规则。	true
Escalation	array<object>	触发报警的规则。
	object	无。
ComparisonOperator	string	阈值比较符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天时间上涨。 LessThanYesterday：同比昨天时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。	GreaterThanOrEqualToThreshold
PreCondition	string	阈值比较符号。取值： `>=` `=` `<=` `>` `<` `!=`	>=
Expression	string	触发报警的规则描述。说明报警规则的主体，当监控数据满足报警条件时，触发报警规则。	$Average>=10
Times	integer	报警重试次数。	1
Tag	string	该参数已废弃，无需关注。	无
Threshold	string	报警阈值。	10
Level	integer	报警的级别和通知方式。取值： 4：邮件+钉钉机器人。 OK：无报警。	3
ExpressionListJoin	string	多个监控项之间的关系。取值： &&：当所有监控项都满足报警条件时，发送报警通知。 \|\|：当其中一个监控项满足报警条件时，发送报警通知。	&&
ExpressionList	array<object>	多指标报警规则描述。
	object	无。
ComparisonOperator	string	报警级别的阈值比较符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天时间上涨。 LessThanYesterday：同比昨天时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。	GreaterThanOrEqualToThreshold
MetricName	string	监控项名称。	cpu_total
Period	string	监控项的统计周期。单位：秒。默认为监控项的原始上报周期。	60
Statistics	string	报警级别的统计方法。取值： Maximum：最大值。 Minimum：最小值。 Average：平均值。	Average
Threshold	string	报警阈值。	90
ExpressionRaw	string	表达式创建的报警条件。包括但不限于以下情况：为部分资源设置报警黑名单，例如：$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	错误码	错误信息
400	%s	%s
500	InternalError	The request processing has failed due to some unknown error.

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

变更历史

变更时间	变更内容概要	操作
2023-10-20	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情