文档首页/ 应用运维管理 AOM/ API参考/ API/ 告警/ 查询告警抑制规则列表
更新时间:2025-07-01 GMT+08:00
分享

查询告警抑制规则列表

功能介绍

该接口用于查询告警抑制规则列表。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/alert/inhibit-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。获取方式请参见:获取Token

Content-Type

String

消息体的类型(格式)。指定类型为“application/json”。

Enterprise-Project-Id

String

企业项目id。

  • 查询单个企业项目下告警抑制规则,填写企业项目id。

  • 不填,则查询默认企业项目下告警抑制规则。

  • all_granted_eps 查询所有企业项目下告警抑制规则

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of InhibitRule objects

查询告警抑制规则列表。

表4 InhibitRule

参数

参数类型

描述

create_time

Long

告警抑制规则创建时间。

update_time

String

告警抑制规则更新时间。

name

String

告警抑制规则名称。

user_id

String

告警抑制规则所属projectid。

enterprise_project_id

String

告警抑制规则所属企业项目id。

match_v3

InhibitMatchV3Tag object

告警抑制规则编排详情。(新版告警抑制规则参数)

desc

String

告警抑制规则描述。规则描述长度最大 1024。

source_match

Array<Array<InhibitMatchTag>>

根源告警。(告警抑制规则参数)

根源告警最多可设置10个并行条件,每个并行条件下最多可设置10个串行条件。

target_match

Array<Array<InhibitMatchTag>>

抑制告警。(告警抑制规则参数)

抑制告警最多可设置10个并行条件,每个并行条件下最多可设置10个串行条件。

binding_group_rule

String

告警抑制规则绑定的告警分组规则名称。(新版告警抑制规则参数)

表5 InhibitMatchV3Tag

参数

参数类型

描述

nodes

Array of InhibitRuleNode objects

节点详情列表。

edges

Array of Edge objects

边详情列表。

表6 InhibitRuleNode

参数

参数类型

描述

id

String

节点id。命名规范为:flow-“8位随机字符串”。

随机字符串只能由字母、数字、下划线和中划线组成。

例如:flow-M3pfK020

type

String

节点类型。

Start:开始节点。

End:结束节点。

Card:卡片节点。

businessType

String

卡片类型。(当type为Card时,该参数必填)

  • InhibitSourceCondition:根源告警卡片。

  • InhibitTargetCondition:抑制告警卡片。

value

InhibitConditionSubNode object

告警抑制规则节点详情。(当type为Card时,该参数必填)

表7 InhibitConditionSubNode

参数

参数类型

描述

nodes

Array of InhibitConditionSubNode objects

子节点列表。

id

String

节点id。命名规范为:{businessType}-“8位随机字符串”。

随机字符串只能由字母、数字、下划线和中划线组成

例如:InhibitSourceCondition-M3pfK020

type

String

节点类型:

  • bool:布尔。

  • text:文本。

  • numerical:数字。

value

String

节点之间关系:

  • and:且。

  • or:或。

match

InhibitMatchTag object

路由规则匹配条件列表。

表8 InhibitMatchTag

参数

参数类型

描述

key

String

告警抑制规则下根源告警或抑制告警key取值范围:

  • 具体标签名称:标签只能包含中文、字母、数字和下划线

  • event_severity:告警级别

  • resource_provider:告警源

  • resource_type:资源类型

value

Array of strings

告警抑制规则下根源告警或抑制告警value取值范围。当表达式为正则时,value的长度不能超过256

  • 当key为告警级别且表达式为等于时,value取值范围为:Critical,Major,Minor,Info。

  • 当key为资源类型,value取值范围为:创建告警规则或自定义上报告警时选定的资源类型。可以设置为:host、container、process等类型。

  • 当key为告警源,value取值范围为:触发告警或事件的服务名称。可以设置为AOM 、LTS、CCE等服务名称。

  • 当key为标签,value取值范围为:标签名对应的标签值,标签值只能包含中文、字母、数字和下划线。

operate

String

操作符:

  • EQUALS :等于

  • REGEX :正则

  • EXIST :存在

表9 Edge

参数

参数类型

描述

id

String

边id。命名规范为:edge-"8位随机字符串”。

随机字符串只能由字母、数字、下划线和中划线组成。

例如:edge-M3pfK202

source

String

边起始节点id。取值于nodes列表里的id。

target

String

边终止节点id。取值于nodes列表里的id。

value

String

边value。节点之间的关系true或false。

状态码:403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误信息。

最小长度:0

最大长度:1024

error_type

String

错误类型。

最小长度:0

最大长度:128

trace_id

String

请求id。

最小长度:32

最大长度:32

请求示例

查询告警抑制规则列表

https://{Endpoint}/v2/{project_id}/alert/group-rules

响应示例

状态码:200

请求响应成功。

[ {
  "create_time" : 1750493441163,
  "desc" : "",
  "enterprise_project_id" : "0",
  "name" : "aomtest2",
  "source_match" : [ [ {
    "key" : "event_severity",
    "operate" : "EQUALS",
    "value" : [ "Critical", "Info", "Major", "Minor" ]
  } ] ],
  "target_match" : [ [ {
    "key" : "event_severity",
    "operate" : "EQUALS",
    "value" : [ "Info" ]
  } ] ],
  "update_time" : 1750493441163,
  "user_id" : "2a47****cca5****8373****1bff****"
}, {
  "binding_group_rule" : "FZGZCES",
  "create_time" : 1744456159302,
  "enterprise_project_id" : "0",
  "match_v3" : {
    "edges" : [ {
      "id" : "edge-VR5kq_vT",
      "source" : "flow-ftiNLSaK",
      "target" : "flow-IsJgzpNb"
    }, {
      "id" : "edge-eGjCMdHl",
      "source" : "flow-IsJgzpNb",
      "target" : "flow-rLV_tnA5",
      "value" : "true"
    }, {
      "id" : "edge-iykd5MUA",
      "source" : "flow-IsJgzpNb",
      "target" : "flow-v1dRA0ny",
      "value" : "false"
    } ],
    "nodes" : [ {
      "id" : "flow-ftiNLSaK",
      "type" : "Start"
    }, {
      "businessType" : "InhibitSourceCondition",
      "id" : "flow-IsJgzpNb",
      "type" : "Card",
      "value" : {
        "id" : "InhibitSourceCondition-cFsoS9Cp",
        "nodes" : [ {
          "id" : "InhibitSourceCondition-qkjISO0E",
          "match" : {
            "key" : "event_severity",
            "operate" : "EQUALS",
            "value" : [ "Critical" ]
          },
          "type" : "text"
        } ],
        "type" : "bool",
        "value" : "and"
      }
    }, {
      "businessType" : "InhibitTargetCondition",
      "id" : "flow-rLV_tnA5",
      "type" : "Card",
      "value" : {
        "id" : "InhibitSourceCondition-BSCX1l_x",
        "nodes" : [ {
          "id" : "InhibitSourceCondition-ad5xOzID",
          "match" : {
            "key" : "event_severity",
            "operate" : "EQUALS",
            "value" : [ "Critical" ]
          },
          "type" : "text"
        } ],
        "type" : "bool",
        "value" : "and"
      }
    }, {
      "id" : "flow-v1dRA0ny",
      "type" : "End"
    } ]
  },
  "name" : "123",
  "update_time" : 1744456159302,
  "user_id" : "2a47****cca5****8373****1bff****"
} ]

状态码:403

Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

{
  "error_code" : "AOM.0403",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED",
  "trace_id" : null
}

状态码

状态码

描述

200

请求响应成功。

403

Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

错误码

请参见错误码

相关文档