GetAlertRules - 获取已经创建的告警规则 - 应用实时监控服务ARMS

查询已经创建的告警规则。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

arms:GetAlertRules

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AlertIds	string	否	告警规则 ID 列表，告警规则 ID 是识别告警规则的唯一标志，不会重复。如果不指定，API 请求将不会根据告警规则 ID 对告警规则进行筛选。如果指定了告警规则 ID 列表，那么此次请求将只会返回在列表中的告警规则的子集，其它筛选条件也会同时生效。说明您可以通过其他请求参数调用 GetAlertRules 接口，从返回信息中获取 AlertIds，后续您可以直接通过 AlertIds 查询指定的告警规则。	["12345"]
AlertNames	string	否	告警规则名称列表。新版告警规则创建时不允许出现重名，但是存量告警规则可能存在重名告警，因此 AlertName 不是告警规则的唯一标志。如果不指定，将不会对告警规则进行过滤。如果指定告警规则名称列表，本次请求将只返回在列表中的告警的子集，其它的筛选条件也会生效。	["test"]
RegionId	string	是	地域 ID。	cn-hangzhou
AlertType	string	否	告警规则类型。新版告警必传。 APPLICATION_MONITORING_ALERT_RULE：应用监控告警规则。 BROWSER_MONITORING_ALERT_RULE：前端监控告警规则。 PROMETHEUS_MONITORING_ALERT_RULE：Prometheus 监控告警规则。	APPLICATION_MONITORING_ALERT_RULE
AlertStatus	string	否	告警规则运行状态。 RUNNING：运行中 STOPPED：已停止 PAUSED：被暂停说明 PAUSED 状态说明告警规则状态异常，被系统主动暂停，可能原因有告警规则唯独值过大或者关联集群已经被删除等。	RUNNING
ClusterId	string	否	Prometheus 监控告警规则的集群 ID。	ceba9b9ea5b924dd0b6726d2de6******
ProductCode	string	否	无需填写。	null
Page	integer	是	查询第 N 页告警。	1
Size	integer	是	每一页告警规则数量。	20
Tags	array<object>	否	标签列表。
	object	否
Key	string	否	标签键。	type
Value	string	否	标签值。	prod
BizRegionId	string	否	规则所在的区域 ID	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	337B8F7E-0A64-5768-9225-E9B3CF******
PageBean	object	分页对象。
Total	integer	查询到的告警规则总数。	1
Page	integer	查询的页数。	1
Size	integer	每一页告警规则数量。	20
AlertRules	array<object>	告警规则列表。
	array<object>	告警规则列表结构体。
AlertId	integer	告警规则 ID。	5730***
AlertName	string	告警规则名称。	arms-test
UserId	string	阿里云账号 ID。	1131971649******
RegionId	string	地域 ID。	cn-hangzhou
AlertType	string	告警规则类型。 APPLICATION_ MONITORING_ ALERT_RULE：应用监控告警规则。 BROWSER_ MONITORING_ ALERT_RULE：前端监控告警规则。 PROMETHEUS_ MONITORING_ ALERT_RULE：Prometheus 监控告警规则。	APPLICATION_MONITORING_ALERT_RULE
AlertStatus	string	告警规则运行状态。 RUNNING：运行中 STOPPED：已停止 PAUSED：被暂停说明 PAUSED 状态说明告警规则状态异常，被系统主动暂停，可能原因有告警规则唯独值过大或者关联集群已经被删除等。	RUNNING
CreatedTime	integer	告警规则创建时间的时间戳，单位为毫秒。	1640333981000
UpdatedTime	integer	告警规则更新时间的时间戳，单位为毫秒。	1640333981000
Extend	string	扩展字段。说明如果是存量应用监控告警规则，字段会包含联系人、告警模板、通知内容等信息。	{\"alarmContext\":\"{\\\"content\\\":\\\"报警名称:$报警名称\\\\n筛选条件: $筛选\\\\n报警时间: $报警时间\\\\n报警内容: $报警内容\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\",\\\"subTitle\\\":\\\"\\\"}\",\"alertWays\":\"[0,1]\",\"contactGroupIds\":\"381,5075\",\"notice\":\"{\\\"endTime\\\":1480607940000,\\\"noticeEndTime\\\":1480607940000,\\\"noticeStartTime\\\":1480521600000,\\\"startTime\\\":1480521600000}\"}
NotifyStrategy	string	通知策略名称。	ALERT_MANAGER
Pids	array	应用监控或前端监控告警关联应用的 PID。
	string	应用的 PID。	["b590lhguqs@40d8deedfa9******"]
AutoAddNewApplication	boolean	应用监控或前端监控是否开启新创建应用追加到此告警规则功能。 `true`：开启 `false`：不开启	false
MetricsType	string	应用监控或前端监控告警规则的告警指标类型。	JVM
AlertRuleContent	object	应用监控或前端监控的告警规则内容。
Condition	string	应用监控或前端监控多个告警条件之间的触发逻辑。 OR：满足下述任何一个条件。 AND：同时满足下述条件。	OR
AlertRuleItems	array<object>	应用监控或前端监控告警规则的告警条件。
	object	告警条件对象。
N	integer	最近 N 分钟。	1
MetricKey	string	具体告警条件的指标。	appstat.jvm.non_heap_used
Aggregate	string	告警条件聚合方式。 AVG：平均 SUM：求和 MAX：最大值 MIN：最小值	AVG
Operator	string	告警条件的判断条件。 CURRENT_GTE：大于或等于 CURRENT_LTE：小于或等于 PREVIOUS_UP：环比上升百分比 PREVIOUS_DOWN：环比下降百分比 HOH_UP：与上小时同比上升百分比 HOH_DOWN：与上小时同比下降百分比 DOD_UP：与昨日同比上升百分比 DOD_DOWN：与昨日同比下降百分比	CURRENT_GTE
Value	string	告警条件阈值。	1
Filters	object	应用监控或前端监控告警规则的过滤项。
DimFilters	array<object>	应用监控或前端监控告警规则的过滤项信息。
	object	应用监控或前端监控告警规则的过滤条件对象。
FilterKey	string	过滤条件 Key。	rootIp
FilterOpt	string	过滤条件操作关系。	ALL
FilterValues	array	过滤条件参数信息。
	string	过滤条件参数。	null
CustomSLSFilters	array<object>	前端监控告警规则的自定义过滤条件。
	object	自定义过滤条件对象。
Key	string	过滤条件 Key。	username
Opt	string	过滤条件操作关系。 =：等于 not：不等于	=
Value	string	过滤条件参数值。	test
T	string	仅用于区分前端监控日志类型，其它过滤条件不包含此字段。	null
Show	boolean	此筛选条件是否在前端展示。	false
CustomSLSGroupByDimensions	array	聚合维度信息。
	string	聚合维度参数值。	["page"]
CustomSLSWheres	array	设置筛选条件信息。
	string	设置筛选条件参数值。	["t like '%api%'"]
AlertCheckType	string	Prometheus 监控告警规则的告警检查类型。 STATIC：静态阈值类型。 CUSTOM：自定义 PromQL 类型。	STATIC
ClusterId	string	Prometheus 监控告警规则的集群 ID。	ceba9b9ea5b924dd0b6726d2de6******
AlertGroup	integer	Prometheus 告警规则的告警分组 ID。 -1：自定义 PromQL 1：Kubernetes 负载 15：Kubernetes 节点	1
PromQL	string	Prometheus 告警规则的 PromQL 语句。	node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100
Duration	string	Prometheus 告警规则的持续时间。	1
Level	string	Prometheus 告警规则的等级。 P1：一般用于影响核心业务可用性，影响范围很大，可能导致严重后果的重大问题的告警通知。 P2：一般用于部分业务出错，会对系统可用性造成一定影响，但是影响范围相对有限的问题的告警通知。 P3：一般用于对可能导致业务出错或者受影响的问题的告警通知，或者在相对重要程度较低的业务发送的告警通知。 P4：用于需要通知，但是优先级较低，也不会对业务造成影响的场景发送告警通知。默认：如果不需要区分告警等级，可以使用默认级别。	P2
Message	string	Prometheus 告警规则的告警内容。	命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 当前值{{ printf "%.2f" $value }}%
Labels	array<object>	Prometheus 告警规则的标签。
	object	标签结构体。
Name	string	标签键。	123
Value	string	标签值。	abc
Annotations	array<object>	Prometheus 告警规则的注释。
	object	注释结构体。
Name	string	注释键。	123
Value	string	注释值。	abc
Tags	array<object>	告警规则标签。
	object
Key	string	标签键。	type
Value	string	标签值。	prod

示例

正常返回示例

JSON格式

{
  "RequestId": "337B8F7E-0A64-5768-9225-E9B3CF******",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "AlertRules": [
      {
        "AlertId": 0,
        "AlertName": "arms-test",
        "UserId": "1131971649******",
        "RegionId": "cn-hangzhou",
        "AlertType": "APPLICATION_MONITORING_ALERT_RULE",
        "AlertStatus": "RUNNING",
        "CreatedTime": 1640333981000,
        "UpdatedTime": 1640333981000,
        "Extend": "{\\\"alarmContext\\\":\\\"{\\\\\\\"content\\\\\\\":\\\\\\\"报警名称:$报警名称\\\\\\\\n筛选条件: $筛选\\\\\\\\n报警时间: $报警时间\\\\\\\\n报警内容: $报警内容\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\\",\\\\\\\"subTitle\\\\\\\":\\\\\\\"\\\\\\\"}\\\",\\\"alertWays\\\":\\\"[0,1]\\\",\\\"contactGroupIds\\\":\\\"381,5075\\\",\\\"notice\\\":\\\"{\\\\\\\"endTime\\\\\\\":1480607940000,\\\\\\\"noticeEndTime\\\\\\\":1480607940000,\\\\\\\"noticeStartTime\\\\\\\":1480521600000,\\\\\\\"startTime\\\\\\\":1480521600000}\\\"}",
        "NotifyStrategy": "ALERT_MANAGER",
        "Pids": [
          "[\"b590lhguqs@40d8deedfa9******\"]"
        ],
        "AutoAddNewApplication": false,
        "MetricsType": "JVM",
        "AlertRuleContent": {
          "Condition": "OR",
          "AlertRuleItems": [
            {
              "N": 1,
              "MetricKey": "appstat.jvm.non_heap_used",
              "Aggregate": "AVG",
              "Operator": "CURRENT_GTE",
              "Value": "1"
            }
          ]
        },
        "Filters": {
          "DimFilters": [
            {
              "FilterKey": "rootIp",
              "FilterOpt": "ALL",
              "FilterValues": [
                "null"
              ]
            }
          ],
          "CustomSLSFilters": [
            {
              "Key": "username",
              "Opt": "=",
              "Value": "test",
              "T": "null",
              "Show": false
            }
          ],
          "CustomSLSGroupByDimensions": [
            "[\"page\"]"
          ],
          "CustomSLSWheres": [
            "[\"t like '%api%'\"]"
          ]
        },
        "AlertCheckType": "STATIC",
        "ClusterId": "ceba9b9ea5b924dd0b6726d2de6******",
        "AlertGroup": 1,
        "PromQL": "node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100",
        "Duration": "1",
        "Level": "P2",
        "Message": "命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 当前值{{ printf \"%.2f\" $value }}%",
        "Labels": [
          {
            "Name": "123",
            "Value": "abc"
          }
        ],
        "Annotations": [
          {
            "Name": "123",
            "Value": "abc"
          }
        ],
        "Tags": [
          {
            "Key": "type",
            "Value": "prod"
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。