# 获取告警规则详情 - GetAlarmRuleDetail #### 功能介绍 根据告警规则ID获取告警策略的完整配置信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-apm/apm_04_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-apm/apm_04_0021.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | apm：：getAdminInfo | Read | - | - | - | - | #### URI GET /v2/alarm-center/rule/get-alarm-rule-detail 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | alarm_rule_id | 是 | Long | **参数解释**： 告警规则ID。 **约束限制**： 不涉及。 **取值范围**： 大于0的整数。 **默认取值**： 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token。获取方式请参见：[获取Token](https://support.huaweicloud.com/api-apm/apm_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | **参数解释**： 告警规则ID，更新时必填。 **取值范围**： 大于0的整数。 | | name | String | **参数解释**： 告警策略名称。 **取值范围**： 字符串。 | | context | String | **参数解释**： 通知内容。 **取值范围**： 字符串。 | | monitor_item_id | Long | **参数解释**： 监控项ID。 **取值范围**： 大于0的整数。 | | collector_id | Integer | **参数解释**： 采集器类型ID，决定告警策略监控的数据采集器类型。 **取值范围**： 系统中支持的采集器ID。 | | level | String | **参数解释**： 告警级别。 **取值范围**： - COMMON：轻微。 - CRITICAL：严重。 | | metric_set_id | Integer | **参数解释**： 指标集ID。 **取值范围**： 大于0的整数。 | | send_interval | Integer | **参数解释**： 重复告警发送间隔（分钟）。 **取值范围**： 大于等于10的整数。 | | cycle_number | Integer | **参数解释**： 连续多少个周期满足条件才告警。 **取值范围**： 1\~10。 | | exception_number | Integer | **参数解释**： 连续多少次异常才告警。 **取值范围**： 1\~10。 | | data_type | String | **参数解释**： 数据聚合类型。 **取值范围**： - SINGLE：单机。 - AGGREGATE：聚合。 | | recover_notify | Boolean | **参数解释**： 是否发送恢复通知。 **取值范围**： - true：发送恢复通知。 - false：不发送恢复通知。 | | recover_interval | Integer | **参数解释**： 告警恢复阈值。 **取值范围**： 整数。 | | alarm_rule_expression_create_params | Array of [AlarmRuleExpressionCreateParam] objects | **参数解释**： 告警规则表达式列表。 **取值范围**： 对象数组。 | | alarm_rule_expressions | Array of [AlarmRuleExpressionCreateParam] objects | **参数解释**： 告警规则表达式列表（备用字段）。 **取值范围**： 对象数组。 | | multi_row_match | Boolean | **参数解释**： 是否启用多行匹配。 **取值范围**： - true：发送恢复通知。 - false：不发送恢复通知。 | | use_default_notifies | Boolean | **参数解释**： 是否使用默认通知方式。 **取值范围**： - true：发送恢复通知。 - false：不发送恢复通知。 | | alarm_rule_notify_models | Array of [TemplateAlarmRuleNotifyCreateParam] objects | **参数解释**： 告警通知配置列表。 | | notify_methods | Array of strings | **参数解释**： 通知方式列表。 | | http_notify_type | String | **参数解释**： HTTP通知类型。 **取值范围**： - SINGLE - AGGREGATE | | alarm_group_id | Long | **参数解释**： 关联的告警分组ID。 **取值范围**： 大于0的整数。 | | eps_id | String | **参数解释**： 企业项目ID。 **取值范围**： 字符串。 | | smn_notify_methods | Array of [SmnNotifyParam] objects | **参数解释**： SMN通知方式列表。 | | source | String | **参数解释**： 应用类型。 **取值范围**： - APM2 - TRACING - WEB - OTEL | 表4AlarmRuleExpressionCreateParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric_type | String | **参数解释**： 指标类型。 **取值范围**： - KEY - METRIC | | expression_operator | String | **参数解释**： 表达式运算符。 **取值范围**： 字符串。 | | order_number | Integer | **参数解释**： 序号，维度和指标都从1开始计数。 **取值范围**： 大于0的整数。 | | threshold_operator | String | **参数解释**： 阈值运算符。 **取值范围**： 字符串。 | | threshold | String | **参数解释**： 阈值。 **取值范围**： 字符串。 | | first_metric_id | Integer | **参数解释**： 第一个指标ID。 **取值范围**： 大于0的整数。 | | first_metric_function | String | **参数解释**： 第一个指标的聚合函数。 **取值范围**： 字符串。 | | advance | Boolean | **参数解释**： 是否为高级表达式。 **取值范围**： - true：是高级表达式。 - false：不是高级表达式。 | | multi_metrics | Boolean | **参数解释**： 是否是多指标。 **取值范围**： - true：是多指标。 - false：不是多指标。 | | second_metric_value | String | **参数解释**： 第二个指标的值。 **取值范围**： 字符串。 | | second_metric_function | String | **参数解释**： 第二个指标的聚合函数。 **取值范围**： 字符串。 | | second_metric_type | String | **参数解释**： 第二个指标类型。 **取值范围**： - METRIC - NUMBER | | metric_operator | String | **参数解释**： 两个指标的运算符。 **取值范围**： 字符串。 | | expression | String | **参数解释**： 高级表达式。 **取值范围**： 字符串。 | 表5TemplateAlarmRuleNotifyCreateParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | receiver_id | Integer | **参数解释**： 接收人ID。 **取值范围**： 大于0的整数。 | | notify_channel | String | **参数解释**： 通知渠道。 **取值范围**： 字符串。 | | region | String | **参数解释**： 区域。 **取值范围**： 字符串。 | 表6SmnNotifyParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | **参数解释**： SMN主题ID。 **取值范围**： 大于0的整数。 | | topic_name | String | **参数解释**： SMN主题名称。 **取值范围**： 字符串。 | | project_id | String | **参数解释**： 项目ID。 **取值范围**： 字符串。 | | topic_urn | String | **参数解释**： SMN主题URN。 **取值范围**： 字符串。 | | region | String | **参数解释**： 区域。 **取值范围**： 字符串。 | #### 请求示例 ``` /v2/alarm-center/rule/get-alarm-rule-detail?alarm_rule_id=1 ``` #### 响应示例 **状态码：200** 获取告警规则详情成功。 ``` { "name" ： "alarm-rule", "context" ： "${}", "collector_id" ： 1, "level" ： "CRITICAL", "metric_set_id" ： 1, "send_interval" ： 10, "cycle_number" ： 1, "exception_number" ： 1, "data_type" ： "SINGLE", "recover_notify" ： true, "recover_interval" ： 10, "alarm_rule_expressions" ： [ { "metric_type" ： "METRIC", "order_number" ： 1, "threshold_operator" ： "NEQ", "threshold" ： "0", "first_metric_id" ： 1, "advance" ： false, "multi_metrics" ： false } ], "multi_row_match" ： false, "http_notify_type" ： "HTML", "eps_id" ： "0", "smn_notify_methods" ： [ ], "source" ： "APM2", "id" ： 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 403 | Forbidden | | 429 | Too Many Requests | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-apm/ErrorCode.html)。