# 查询指标类或者事件类告警规则列表 - ListMetricOrEventAlarmRule #### 功能介绍 查询AOM2.0指标类或者事件类告警规则列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-aom/aom_04_0057.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-aom/aom_04_0031.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | aom:alarmRule:list | List | - | - | - | - | #### URI GET /v4/{project_id}/alarm-rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-aom/aom_04_0024.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 告警规则名称。 | | limit | 否 | String | 用于限制本次返回的结果数据条数。 | | offset | 否 | String | 分页查询起始位置，为非负整数。 | | sort_by | 否 | String | 根据告警规则名称或者告警创建时间排序。 - alarm_rule_name.asc - alarm_create_time.desc | | event_source | 否 | String | 事件告警规则事件来源。 - "RDS" - "EVS" - "CCE" - "LTS" - "AOM" | | event_severity | 否 | String | 事件告警级别。 - "Critical" - "Major" - "Minor" - "Info" | | alarm_rule_status | 否 | String | 告警规则状态。 - "OK"：正常 - "alarm"：超限阈值 - "Effective"：生效中 - "Invalid"：停用中 | | alarm_rule_type | 否 | String | 告警规则类型。 - "metric"：指标告警规则 - "event"：事件告警规则 | | prom_instance_id | 否 | String | Prometheus实例id。 | | bind_notification_rule_id | 否 | String | 绑定的告警行动规则名称。 | | related_cce_clusters | 否 | String | CCE集群id。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。获取方式请参见：[获取Token](https://support.huaweicloud.com/api-aom/aom_04_0059.html)。 | | Content-Type | 是 | String | 消息体的类型（格式）。指定类型为"application/json"。 | | Enterprise-Project-Id | 否 | String | 企业项目id。获取方式请参见：[获取企业项目ID](https://support.huaweicloud.com/api-aom/aom_04_0024.html)。 - 查询单个企业项目下实例，填写企业项目id。 - 查询所有企业项目下实例，填写"all_granted_eps"。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_rules | Array of [AlarmParamForV4Db] objects | 告警规则列表。 | | metadata | Object | 元数据信息。 | | count | Integer | 告警规则数量。 | 表5AlarmParamForV4Db | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_create_time | Long | 告警规则创建时间。仅支持UTC毫秒级时间戳。例如：2024-10-16 16:03:01需要通过工具转换成UTC毫秒级时间戳：1702759381000 | | alarm_update_time | Long | 告警规则修改时间。仅支持UTC毫秒级时间戳。例如：2024-10-16 16:03:01需要通过工具转换成UTC毫秒级时间戳：1702759381000 | | alarm_rule_name | String | 告警规则名称。 | | alarm_rule_id | Long | 告警规则id。 | | enterprise_project_id | String | 企业项目id。获取方式请参见：[获取企业项目ID](https://support.huaweicloud.com/api-aom/aom_04_0024.html)。 | | prom_instance_id | String | Prometheus实例id。 | | alarm_rule_description | String | 告警规则描述。 | | alarm_rule_enable | Boolean | 是否启用。 | | alarm_rule_status | String | 告警状态。 - "OK"：正常 - "alarm"：超限阈值 - "Effective"：生效中 - "Invalid"：停用中 | | alarm_rule_type | String | 规则类型。 - "metric"：指标告警规则 - "event"：事件告警规则 | | metric_alarm_spec | [MetricAlarmSpec] object | 指标类告警结构。 | | event_alarm_spec | [EventAlarmSpec] object | 事件类告警结构。 | | alarm_notifications | [AlarmNotification] object | 告警规则通知模块。 | | user_id | String | 用户id。 | 表6MetricAlarmSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | monitor_type | String | 监控类型。 - "all_metric"：全量指标 - "promql"：PromQL - "resource"：（日落）资源类型 | | no_data_conditions | Array of [NoDataCondition] objects | 无数据处理。 | | alarm_tags | Array of [AlarmTags] objects | 告警标签。 | | monitor_objects | Array of Map\ objects | 监控对象列表。 | | recovery_conditions | [RecoveryCondition] object | 告警恢复条件。 | | trigger_conditions | Array of [TriggerCondition] objects | 触发条件。 | | alarm_rule_template_bind_enable | Boolean | 是否绑定告警模板（废弃）。 | | alarm_rule_template_id | String | 告警模板id（废弃）。 | 表7NoDataCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | no_data_timeframe | Integer | 无数据处理连续周期。取值范围为1\~5。（当"notify_no_data"为true时，该参数必填，当"notify_no_data"为false时，该参数为空） | | no_data_alert_state | String | 数据不足时，阈值规则的状态。（当"notify_no_data"为true时，该参数必填，当"notify_no_data"为false时，该参数为空） - "no_data"：数据不足并发送通知 - "alerting"：告警 - "ok"：正常 - "pre_state"：保持上一个状态 | | notify_no_data | Boolean | 无数据处理开关。true表示启用无数据处理，false表示关闭无数据处理。 | 表8AlarmTags | 参数 | 参数类型 | 描述 | |:---|:---|:---| | auto_tags | Array of strings | 自动标签。 | | custom_tags | Array of strings | 自定义标签。 | | custom_annotations | Array of strings | 告警标注。 | 表9RecoveryCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | recovery_timeframe | Integer | 告警恢复周期的个数。取值范围为1\~3 (如果recovery_timeframe 参数不为空，该参数必填） | 表10TriggerCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric_query_mode | String | 指标查询模式。 - "AOM"：AOM原生 - "PROM"：AOM Prometheus - "NATIVE_PROM"：原生Prometheus | | metric_namespace | String | 指标命名空间。 | | metric_name | String | 指标名称。 | | metric_unit | String | 指标单位。 | | metric_labels | Array of strings | 指标维度。 | | promql | String | Prometheus语句。 | | promql_expr | String | Prometheus语句模板。 | | trigger_times | Integer | 连续周期个数。 | | trigger_interval | String | 检查频率周期。 - 当trigger_type 为"HOURLY"时，填""。 - 当trigger_type为"DAILY"时，格式为："小时" 。例如每天凌晨三点"03:00"。 - 当trigger_type为"WEEKLY"时，格式为："星期 小时"。例如每周一凌晨三点 "1 03:00"。 - 当trigger_type为"CRON"时，格式为标准CRON表达式。 - 当trigger_type为"FIXED_RATE"时，秒的取值为15s，30s，分钟为 1\~59，小时为 1\~24。例如"15s"，"30s"，"1min"，"1h"。 | | trigger_type | String | 触发频率的类型： - "FIXED_RATE"：固定间隔 - "HOURLY"：每小时 - "DAILY"：每天 - "WEEKLY"：每周 - "CRON"：Cron表达式 | | promql_for | String | Prometheus原生监控时长。 | | aggregation_type | String | **参数解释**： 统计方式： **取值范围**： average：平均值。 minimum：最小值。 maximum：最大值。 sum：总计。 sampleCount：样本个数。 | | operator | String | 判断条件："\>","\<","=","\>=","\<="。 | | thresholds | Map\ | 键值对形式，键为告警级别，值为告警阈值。 | | aggregation_window | String | 统计周期。 - "15s"：15秒 - "30s"：30秒 - "1m"：1分钟 - "5m"：5分钟 - "15m"：15分钟 - "1h"：1小时 | | cmdb | [CmdbInfo] object | cmdb信息。 | | query_match | String | 查询筛选条件 | | query_param | Object | 查询参数。 | | aom_monitor_level | String | 监控层级。 | | aggregate_type | String | 聚合方式。 - "by"：不分组 - "avg"：平均值分组 - "max"：最大值分组 - "min"：最小值分组 - "sum"：求和分组 | | metric_statistic_method | String | 当配置方式为全量指标时可选择的指标运算方式。 - "single"：单个指标进行运算 - "mix"：多个指标进行混合运算 | | expression | String | 混合运算的表达式。 | | mix_promql | String | 混合运算的promQL。 | 表11CmdbInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app_id | String | 应用id。 | | node_ids | Array of [NodeInfo] objects | 节点信息列表。 | 表12NodeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | node_type | String | 节点类型。 | | node_id | String | 节点id。 | 表13EventAlarmSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_source | String | 告警规则来源。 - "systemEvent"：系统事件 - "customEvent"：自定义事件 | | event_source | String | 告警来源。 - "RDS" - "EVS" - "CCE" - "LTS" - "AOM" | | monitor_objects | Array of Map\ objects | 监控对象列表。键值对形式，键值为： - "event_type"：通知类型 - "event_severity"：告警级别 - "event_name"：事件名称 - "namespace"：命名空间 - "clusterId"：集群id - "customField"：用户自定义字段 | | trigger_conditions | Array of [EventTriggerCondition] objects | 触发条件。 | | alarm_rule_template_bind_enable | Boolean | 是否绑定告警模板（废弃）。 | | alarm_rule_template_id | String | 告警模板id（废弃）。 | 表14EventTriggerCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | event_name | String | 事件名称。 | | trigger_type | String | 触发方式： - "immediately"：立即触发 - "accumulative"：累计触发 | | aggregation_window | Long | 监控周期。单位为秒，例如 1小时 填"3600"，当trigger_type为"immediately"时 该参数为空，当trigger_type为"accumulative"时 该参数必填。 监控周期范围： 5分钟，20分钟，1小时，4小时，24小时。 | | operator | String | 判断条件："\>","\<","=","\>=","\<="，当trigger_type为"immediately"时 该参数为空。当trigger_type为"accumulative"时 该参数必填。 | | thresholds | Map\ | 键值对形式，键为告警级别，值为累计次数，当trigger_type为"immediately"时 累计次数为1。当当trigger_type为"accumulative"时 累计次数范围为1\~100 （如果trigger_conditions参数不为空，该参数必填） | | frequency | String | 事件类告警频率。当trigger_type为"immediately"时 值为-1。 - "-1"：N/A - "0"：只告警一次 - "300"：每5分钟 - "600"：每10分钟： - "900"：每15分钟： - "1800"：每30分钟： - "3600"：每1小时： - "10800"：每3小时： - "21600"：每6小时： - "43200"：每12小时： - "86400"：每天： | 表15AlarmNotification | 参数 | 参数类型 | 描述 | |:---|:---|:---| | notification_type | String | 通知类型。 - "direct"：直接告警 - "alarm_policy"：告警降噪 | | route_group_enable | Boolean | 启用告警分组规则。 - 当通知类型为"alarm_policy"时：true - 当通知类型为"direct"时：false 如果告警触发"notify_triggered"或告警恢复"notify_resolved"都设置为false（即都不进行告警通知），则route_group_enable需设置为false。 | | route_group_rule | String | 告警分组规则名称。 - 当route_group_enable 为true时，填告警分组规则名称 - 当route_group_enable 为false时，填"" | | notification_enable | Boolean | 是否启用告警通知规则。 - 当通知类型为"direct"时，填true - 当通知类型为"alarm_policy"时，填false 如果告警触发"notify_triggered"或告警恢复"notify_resolved"都设置为false（即都不进行告警通知），则notification_enable需设置为false。 | | bind_notification_rule_id | String | 告警行动策略id。 - 当notification_enable为true时，填告警行动策略id - 当notification_enable为false时，填"" | | notify_resolved | Boolean | 告警解决是否通知。 - true：通知 - false：不通知 | | notify_triggered | Boolean | 告警触发是否通知。 - true：通知 - false：不通知 | | notify_frequency | Integer | 通知频率 - 当通知类型为"alarm_policy"时，填"-1" - 当通知类型为"direct"时， - "0"：只告警一次 - "300"：每5分钟 - "600"：每10分钟 - "900"：每15分钟 - "1800"：每30分钟 - "3600"：每1小时 - "10800"：每3小时 - "21600"：每6小时 - "43200"：每12小时 - "86400"：每天 | **状态码：500** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 非法请求错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 | | error_type | String | **参数解释：** 错误类型。 **取值范围：** 不涉及。 | | trace_id | String | **参数解释：** 请求id。 **取值范围：** 不涉及。 | #### 请求示例 分页查询指标类或者事件类告警规则 ``` https://{Endpoint}/v4/{project_id}/alarm-rules?limit=100&offset=0 ``` #### 响应示例 **状态码：200** OK 请求响应成功。 ``` { "alarm_rules" : [ { "alarm_create_time" : 1713929265429, "alarm_notifications" : { "bind_notification_rule_id" : "aom_notification_rule", "notification_enable" : true, "notification_type" : "direct", "notify_frequency" : -1, "notify_resolved" : false, "notify_triggered" : false, "route_group_enable" : false, "route_group_rule" : "" }, "alarm_rule_description" : "", "alarm_rule_enable" : true, "alarm_rule_id" : 0, "alarm_rule_name" : "aom_alarm_rule", "alarm_rule_status" : "Effective", "alarm_rule_type" : "event", "alarm_update_time" : 0, "enterprise_project_id" : "0", "event_alarm_spec" : { "alarm_rule_template_bind_enable" : false, "alarm_rule_template_id" : "", "alarm_source" : "systemEvent", "event_source" : "CCE", "monitor_objects" : [ { "clusterId" : "a4****6b-f**9-1**e-a**d-02****10***a", "event_type" : "event" } ], "trigger_conditions" : [ { "aggregation_window" : 300, "event_name" : "", "frequency" : "-1", "operator" : ">=", "thresholds" : { "Critical" : 2 }, "trigger_type" : "immediately" } ] }, "user_id" : "2a****56****48****73****1b****cf" }, { "alarm_create_time" : 1711458243395, "alarm_notifications" : { "bind_notification_rule_id" : "", "notification_enable" : false, "notification_type" : "direct", "notify_frequency" : 0, "notify_resolved" : false, "notify_triggered" : false, "route_group_enable" : false, "route_group_rule" : "" }, "alarm_rule_description" : "", "alarm_rule_enable" : false, "alarm_rule_id" : 1, "alarm_rule_name" : "aom_alarm_rule_1", "alarm_rule_status" : "Invalid", "alarm_rule_type" : "metric", "alarm_update_time" : 0, "enterprise_project_id" : "0", "metric_alarm_spec" : { "alarm_rule_template_bind_enable" : false, "alarm_rule_template_id" : "", "alarm_tags" : [ { "auto_tags" : [ ], "custom_annotations" : [ ], "custom_tags" : [ ] } ], "monitor_objects" : [ ], "monitor_type" : "all_metric", "no_data_conditions" : [ { "no_data_timeframe" : 0, "notify_no_data" : false } ], "recovery_conditions" : { "recovery_timeframe" : 1 }, "trigger_conditions" : [ { "aggregate_type" : "by", "aggregation_type" : "average", "aggregation_window" : "30s", "aom_monitor_level" : "", "cmdb" : { "app_id" : "", "node_ids" : [ ] }, "expression" : "", "metric_labels" : [ ], "metric_name" : "container_memory_rss", "metric_namespace" : "", "metric_query_mode" : "PROM", "metric_statistic_method" : "single", "metric_unit" : "", "mix_promql" : "", "operator" : ">", "promql" : "label_replace(container_memory_rss{node=\"172.**.**.206\"},\"__name__\",\"container_memory_rss\",\"\",\"\") or label_replace(avg_over_time(container_memory_rss{node=\"172.**.**.206\"}[29999ms]),\"__name__\",\"container_memory_rss\",\"\",\"\")", "promql_for" : "1m", "query_match" : "[{\"conditionList\":[{\"name\":\"172.**.**.206\"},{\"name\":\"172.**.**.133\"}],\"addMode\":\"first\",\"conditionValue\":[{\"name\":\"172.**.**.206\"}],\"id\":\"first\",\"conditionCompare\":\"=\",\"dimension\":\"node\"}]", "query_param" : { "apmMetricReg" : "", "code" : "a" }, "thresholds" : { "Critical" : "1" }, "trigger_interval" : "15s", "trigger_times" : 1, "trigger_type" : "FIXED_RATE" } ] }, "prom_instance_id" : "90e***88-1**4-4**9-9**3-1f*******cd3", "user_id" : "2a****56****48****73****1b****cf" } ], "count" : 29, "metadata" : { "alarm_rule_template_id" : [ ], "bind_notification_rule_id" : [ "aom_notification_rule", "1", "00********qq", "00*****3", "m***m" ], "event_source" : [ "CCE", "DCS", "ES", "AOM" ], "prom_instance_id" : [ "0", "796***7d-1**8-4**9-a**0-99*******ca0", "6cc***c8-f**f-4**4-9**2-90*******fcf", "90e***88-1**4-4**9-9**3-1f*******cd3" ], "resource_kind" : [ "HC:DCS:REDIS_3.0", "CCE", "HC:ES:METRICS", "AOM" ] } } ``` **状态码：500** InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 ``` { "error_code" : "AOM.02022500", "error_msg" : "internal server error", "error_type" : "INTERNAL_SERVER_ERROR", "trace_id" : "" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aom.v2.region.AomRegion; import com.huaweicloud.sdk.aom.v2.*; import com.huaweicloud.sdk.aom.v2.model.*; public class ListMetricOrEventAlarmRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("")) .build(); ListMetricOrEventAlarmRuleRequest request = new ListMetricOrEventAlarmRuleRequest(); try { ListMetricOrEventAlarmRuleResponse response = client.listMetricOrEventAlarmRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v2.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("")) \ .build() try: request = ListMetricOrEventAlarmRuleRequest() response = client.list_metric_or_event_alarm_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := aom.AomClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := aom.NewAomClient(hcClient) request := &model.ListMetricOrEventAlarmRuleRequest{} response, err := client.ListMetricOrEventAlarmRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/AOM/sdk?api=ListMetricOrEventAlarmRule)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK 请求响应成功。 | | 500 | InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-aom/ErrorCode.html)。