查询告警分组规则列表
功能介绍
该接口用于查询告警分组规则列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/alert/group-rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见:获取Token。 |
Content-Type |
是 |
String |
消息体的类型(格式)。指定类型为“application/json”。 |
Enterprise-Project-Id |
否 |
String |
企业项目id。
|
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of GroupRule objects |
查询告警分组规则列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
desc |
String |
告警分组规则描述。规则描述长度最大 1024 |
group_by |
Array of strings |
通知合并规则。(告警分组规则参数)
目前仅支持如下通知规则组合: 1.按告警源 ["resource_provider"] 2.按告警源+严重度 ["resource_provider","event_severity"] 3.按告警源+所有标签 ["resource_provider","分组条件里的标签值","event_severity","resource_type"] |
ai_group_by |
Array of strings |
智能通知合并规则。 数组为空时,表示不开启智能通知合并。
|
group_wait |
Integer |
首次等待时间。(告警分组规则参数) 取值范围为0s-10min 单位为秒,分钟需转为秒,当为1min时,需填写60s |
group_interval |
Integer |
变化等待时间。(告警分组规则参数) 取值范围为5s-30min,分钟需转为秒,当为1min时,需填写60s |
group_repeat_waiting |
String |
重复等待。(告警分组规则参数) 取值范围为0min-15day,分钟需转为秒,当为1min时,需填写60s |
create_time |
Long |
创建告警分组规则时间。 |
update_time |
Long |
更新告警分组规则时间。 |
type |
String |
规则类型: CUSTOM:自定义 |
detail |
Array of GroupRuleDetail objects |
告警分组规则的分组条件列表。(分组规则参数) |
user_id |
String |
告警分组规则所属projectid。 |
name |
String |
告警分组规则名称。 只能由大小写字母、数字、下划线组成,且不能以下划线开头和结尾,最多不能超过100个字符。 |
enterprise_project_id |
String |
告警分组规则所属企业项目id |
match_v3 |
GroupV3Tag object |
告警分组编排详情。(新版告警分组规则详情) |
parent |
String |
继承规则,默认值:aom-builtin-group。 |
参数 |
参数类型 |
描述 |
---|---|---|
match |
Array of MatchTag objects |
路由规则匹配条件列表。 |
bind_notification_rule_ids |
Array of strings |
绑定的告警通知规则名称。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
分组条件key取值范围:
|
value |
Array of strings |
分组条件value取值范围。当表达式为正则时,value的长度不能超过256
|
operate |
String |
操作符:
|
参数 |
参数类型 |
描述 |
---|---|---|
nodes |
Array of GroupConditionNode objects |
节点详情列表。 必须包含开始节点,结束节点,card节点。 |
edges |
Array of Edge objects |
边详情列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
节点id。命名规范为:flow-“8为随机字符串”。 随机字符串只能由字母、数字、下划线和中划线组成。 例如:flow-lvzgw9Td |
type |
String |
节点类型。
|
businessType |
String |
业务类型。(当nodeType为Card时,该参数必填)
|
value |
GroupConditionSubNode object |
告警分组规则节点详情。(当nodeType为Card时,该参数必填) |
参数 |
参数类型 |
描述 |
---|---|---|
nodes |
Array of GroupConditionSubNode objects |
子节点列表。(当businessType为GroupCondition时,该参数必填,当businessType为CombineConf,该参数为空) |
id |
String |
节点id。命名规范:{businessType}-"8位随机字符串"。 随机字符串只能由字母、数字、下划线和中划线组成 例如:GroupCondition-Lh0dTxyd |
type |
String |
节点类型。(当businessType为GroupCondition时,该参数必填,当businessType为CombineConf,该参数为空)
|
value |
String |
节点之间关系。(当businessType为GroupCondition时,该参数必填,当businessType为CombineConf,该参数为空)
|
match |
MatchTag object |
路由规则匹配条件列表。(当businessType为GroupCondition时,该参数必填,当businessType为CombineConf,该参数为空) |
combineConfig |
CombineConfig object |
通知合并节点详情。(当businessType为GroupCondition时,该参数为空,当businessType为CombineConf,该参数为必填) |
参数 |
参数类型 |
描述 |
---|---|---|
group_by |
Array of strings |
通知合并规则。
目前仅支持如下通知规则组合: 1.按告警源 ["resource_provider"] 2.按告警源+严重度 ["resource_provider","event_severity"] 3.按告警源+所有标签 ["resource_provider","tag","event_severity","resource_type"] |
ai_group_by |
String |
智能通知合并规则。 数组为空时,表示不开启智能通知合并。
|
group_wait |
Integer |
首次等待时间,取值范围为0s-10min 单位为秒,分钟需转为秒,当为1min时,需填写60s。 |
group_interval |
Integer |
变化等待时间,取值范围为5s-30min,分钟需转为秒,当为1min时,需填写60s。 |
group_repeat_waiting |
Integer |
重复等待,取值范围为0min-15day,分钟需转为秒,当为1min时,需填写60s。 |
bind_notification_rule_ids |
Array of strings |
绑定告警行动规则名称列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
边id。命名规范为:edge-"8位随机字符串”。 随机字符串只能由字母、数字、下划线和中划线组成。 例如:edge-M3pfK202 |
source |
String |
边起始节点id。取值于nodes列表里的id。 |
target |
String |
边终止节点id。取值于nodes列表里的id。 |
value |
String |
边value。节点之间的关系true或false。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
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
请求响应成功。
[ {
"ai_group_by" : [ ],
"create_time" : 1720600705978,
"desc" : "",
"detail" : [ {
"bind_notification_rule_ids" : [ "0001112223" ],
"match" : [ {
"key" : "resource_provider",
"operate" : "EQUALS",
"value" : [ "2222" ]
} ]
}, {
"bind_notification_rule_ids" : [ "0001112223" ],
"match" : [ {
"key" : "event_severity",
"operate" : "EQUALS",
"value" : [ "Major" ]
} ]
} ],
"enterprise_project_id" : "0",
"group_by" : [ "resource_provider" ],
"group_interval" : 5,
"group_repeat_waiting" : 60,
"group_wait" : 0,
"name" : "1212",
"parent" : "aom-builtin-group",
"type" : "CUSTOM",
"update_time" : 1720666840356,
"user_id" : "2a473356cca5487f8373be891bffc1cf"
} ]
状态码:403
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{
"error_code" : "AOM.0403",
"error_msg" : "auth failed.",
"error_type" : "AUTH_FAILED",
"trace_id" : null
}
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。