Query Alert Rules with GetAlertRules API - ARMS - Alibaba Cloud - Application Real-Time Monitoring Service

Query the created alert rules.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

arms:GetAlertRules

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AlertIds	string	No	The unique IDs of alert rules. If you do not specify this parameter, the API operation does not filter alert rules based on their IDs. If you specify this parameter, the API operation returns only the information of the specified alert rules. Other filter conditions also take effect. Note When you call the GetAlertRules operation, you can specify other request parameters to obtain the AlertIds parameter from the response. Then, you can specify the AlertIds parameter to query the specified alert rules.	["12345"]
AlertNames	string	No	The names of alert rules. When you create alert rules of the new version, you cannot specify duplicate names. However, existing alert rules may have duplicate names. Therefore, the AlertName parameter does not uniquely identify an alert rule. If you do not specify this parameter, the API operation does not filter alert rules based on their names. If you specify this parameter, the API operation returns only the information of the specified alert rules. Other filter conditions also take effect.	["test"]
RegionId	string	Yes	The region ID.	cn-hangzhou
AlertType	string	No	The type of the alert rule. This parameter is required for the new version of Alert Management. Valid values: APPLICATION_MONITORING_ALERT_RULE: alert rule for Application Monitoring BROWSER_MONITORING_ALERT_RULE: alert rule for Browser Monitoring PROMETHEUS_MONITORING_ALERT_RULE: alert rule for Managed Service for Prometheus	APPLICATION_MONITORING_ALERT_RULE
AlertStatus	string	No	The status of the alert rule. Valid values: RUNNING STOPPED PAUSED Note The PAUSED state indicates an abnormal and paused alert rule. This may result from excessively large threshold values or deleted associated clusters.	RUNNING
ClusterId	string	No	The ID of the monitored cluster.	ceba9b9ea5b924dd0b6726d2de6******
ProductCode	string	No	You do not need to configure this parameter.	null
Page	integer	Yes	The number of the page to return.	1
Size	integer	Yes	The number of alert rules to return on each page.	20
Tags	array<object>	No	The list of tags.
	object	No
Key	string	No	The tag key.	type
Value	string	No	The tag value.	prod
BizRegionId	string	No	The area ID where the rule resides.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The returned struct.
RequestId	string	The request ID.	337B8F7E-0A64-5768-9225-E9B3CF******
PageBean	object	The returned pages.
Total	integer	The total number of queried alert rules.	1
Page	integer	The number of pages returned.	1
Size	integer	The number of alert rules returned per page.	20
AlertRules	array<object>	The alert rules.
	array<object>	The details of each alert rule.
AlertId	integer	The alert rule ID.	5730***
AlertName	string	The name of the alert rule.	arms-test
UserId	string	The ID of the Alibaba Cloud account.	1131971649******
RegionId	string	The region ID.	cn-hangzhou
AlertType	string	The type of the alert rule. Valid values: APPLICATION_MONITORING_ALERT_RULE: alert rule for Application Monitoring BROWSER_MONITORING_ALERT_RULE: alert rule for Browser Monitoring PROMETHEUS_MONITORING_ALERT_RULE: Prometheus alert rule	APPLICATION_MONITORING_ALERT_RULE
AlertStatus	string	The status of the alert rule. Valid values: RUNNING STOPPED PAUSED Note The PAUSED state indicates that the alert rule is abnormal and has been suspended. This may be because the specified threshold value is excessively large, or the associated cluster has been deleted.	RUNNING
CreatedTime	integer	The time when the alert rule was created. The value is a timestamp. Unit: milliseconds.	1640333981000
UpdatedTime	integer	The time when the alert rule was updated. The value is a timestamp. Unit: milliseconds.	1640333981000
Extend	string	The extended fields. Note For existing Application Monitoring alert rules, the fields contain information such as contacts, alert template, and notification content.	{\"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	The name of the notification policy.	ALERT_MANAGER
Pids	array	The process ID (PID) of the application to which the Application Monitoring or Browser Monitoring alert rule is applied.
	string	The PID of the application.	["b590lhguqs@40d8deedfa9******"]
AutoAddNewApplication	boolean	Indicates whether the alert rule is applied to new applications that are created in Application Monitoring or Browser Monitoring. Valid values: `true`: yes `false`: no	false
MetricsType	string	The metric type of the Application Monitoring or Browser Monitoring alert rule.	JVM
AlertRuleContent	object	The content of the Application Monitoring or Browser Monitoring alert rule.
Condition	string	The relationship between multiple alert conditions specified for the Application Monitoring or Browser Monitoring alert rule. Valid values: OR: The alert rule is triggered if one of the conditions is met. AND: The alert rule is triggered if all the conditions are met.	OR
AlertRuleItems	array<object>	The trigger conditions of the Application Monitoring or Browser Monitoring alert rule.
	object	The details of the alert condition.
N	integer	The last N minutes.	1
MetricKey	string	The metric of the alert condition.	appstat.jvm.non_heap_used
Aggregate	string	The aggregation method of the alert condition. Valid values: AVG: calculates the average value SUM: calculates the total value MAX: selects the maximum value MIN: selects the minimum value	AVG
Operator	string	The operator that is used to compare the metric value with the threshold. Valid values: CURRENT_GTE: greater than or equal to CURRENT_LTE: less than or equal to PREVIOUS_UP: increase in percentage compared with the previous period PREVIOUS_DOWN: decrease in percentage compared with the previous period HOH_UP: increase in percentage compared with the same period in the previous hour HOH_DOWN: decrease in percentage compared with the same period in the previous hour DOD_UP: increase in percentage compared with the same period in the previous day DOD_DOWN: decrease in percentage compared with the same period in the previous day	CURRENT_GTE
Value	string	The threshold of the alert condition.	1
Filters	object	The filter conditions of the Application Monitoring or Browser Monitoring alert rule.
DimFilters	array<object>	The information about each filter condition of the Application Monitoring or Browser Monitoring alert rule.
	object	The details of the filter condition.
FilterKey	string	The key of the filter condition.	rootIp
FilterOpt	string	The logical operator of the filter condition.	ALL
FilterValues	array	The details of the filter condition.
	string	The parameters of the filter condition.	null
CustomSLSFilters	array<object>	The custom filter condition of the Browser Monitoring alert rule.
	object	The details of the custom filter condition.
Key	string	The key of the filter condition.	username
Opt	string	The logical operator of the filter condition. Valid values: =: equal to not: not equal to	=
Value	string	The value of the filter condition.	test
T	string	The log type of Browser Monitoring. This field is not included in other filter conditions.	null
Show	boolean	Indicates whether this filter condition is displayed on the frontend.	false
CustomSLSGroupByDimensions	array	The information about the aggregation dimension.
	string	The value of the aggregation dimension.	["page"]
CustomSLSWheres	array	The details of the custom filter condition.
	string	The value of the custom filter condition.	["t like '%api%'"]
AlertCheckType	string	The alert check type of the Prometheus alert rule. STATIC: static threshold CUSTOM: custom PromQL	STATIC
ClusterId	string	The cluster ID of the Prometheus alert rule.	ceba9b9ea5b924dd0b6726d2de6******
AlertGroup	integer	The alert contact group ID of the Prometheus alert rule. -1: custom PromQL 1: Kubernetes load 15: Kubernetes node	1
PromQL	string	The PromQL statement of the Prometheus alert rule.	node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100
Duration	string	The duration of the Prometheus alert rule.	1
Level	string	The severity level of the Prometheus alert rule. P1: Alert notifications are sent for major issues that affect the availability of core business, have a huge impact, and may lead to serious consequences. P2: Alert notifications are sent for service errors that affect the system availability with relatively limited impact. P3: Alert notifications are sent for issues that may cause service errors or negative effects, or alert notifications for services that are relatively less important. P4: Alert notifications are sent for low-priority issues that do not affect your business. Default: Alert notifications are sent regardless of alert levels.	P2
Message	string	The alert message of the Prometheus alert rule.	命名空间: {{$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>	The tags of the Prometheus alert rule.
	object	The tag struct.
Name	string	The tag key.	123
Value	string	The tag value.	abc
Annotations	array<object>	The annotations of the Prometheus alert rule.
	object	The annotation struct.
Name	string	The key of the annotation.	123
Value	string	The value of the annotation.	abc
Tags	array<object>	The tags of the alert rule.
	object
Key	string	The tag key.	type
Value	string	The tag value.	prod

Examples

Success response

JSON format

{
  "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"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.