文档首页/ 应用运维管理 AOM/ API参考（吉隆坡区域）/ API/ 告警/ 查询事件类告警规则列表
更新时间：2024-08-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询事件类告警规则列表

功能介绍

查询事件类告警规则列表。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/event2alarm-rule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

最小长度：32

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

最小长度：0

最大长度：40960

Content-Type

是

String

指定类型为application/json。

枚举值：

  • application/json

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of Event2alarmRuleBody objects

OK 请求响应成功。
表4 Event2alarmRuleBody

参数

参数类型

描述

user_id

String

用户项目id

最小长度：32

最大长度：32

name

String

规则名称。规则名称包含大小写字母，数字，特殊字符（_-）和汉字组成，不能以特殊字符开头或结尾，最大长度为100。

最小长度：1

最大长度：100

description

String

规则描述。描述包含大小写字母，数字，特殊字符（_-<>=,.）和汉字组成，不能以下划线、中划线开头结尾，最大长度为1024。

最小长度：0

最大长度：1024

create_time

Integer

创建时间

最小值：0

最大值：9999999999999

update_time

Integer

更新时间

最小值：0

最大值：9999999999999

resource_provider

String

事件源

最小长度：0

最大长度：64

metadata

metadata object

源数据

enable

Boolean

规则是否启用

trigger_policies

Array of trigger_policies objects

触发策略

数组长度：0 - 1024

alarm_type

String

告警类型。notification：直接告警。denoising：告警降噪。

最小长度：0

最大长度：32

枚举值：

  • notification

  • denoising

action_rule

String

告警行动规则

最小长度：0

最大长度：128

inhibit_rule

String

告警抑制规则

最小长度：0

最大长度：128

route_group_rule

String

告警分组规则

最小长度：0

最大长度：128

event_names

Array of strings

事件名称

migrated

Boolean

是否迁移到2.0

topics

Array of SmnTopics objects

smn信息
表5 metadata

参数

参数类型

描述

customField

Array of strings

用户自定义标签

最小长度：0

最大长度：1024

数组长度：0 - 1024
表6 trigger_policies

参数

参数类型

描述

id

Integer

自增编号

最小值：0

最大值：128

name

String

事件名称

最小长度：0

最大长度：128

trigger_type

String

触发类型。accumulative: 累计触发，immediately: 立即触发

最小长度：0

最大长度：128

枚举值：

  • accumulative

  • immediately

period

Integer

触发周期

最小值：1

最大值：86400

operator

String

比较符

最小长度：0

最大长度：8

count

Integer

触发次数

最小值：1

最大值：100

level

String

告警等级

最小长度：0

最大长度：32
表7 SmnTopics

参数

参数类型

描述

display_name

String

Topic的显示名，推送邮件消息时，作为邮件发件人显示。显示名的长度为192byte或64个中文。默认值为空。

最小长度：1

最大长度：64

name

String

创建topic的名字。Topic名称只能包含大写字母、小写字母、数字、-和_，且必须由大写字母、小写字母或数字开头，长度为1到255个字符。

最小长度：1

最大长度：255

push_policy

Integer

SMN消息推送策略。取值为0或1

最小值：0

最大值：1

status

Integer

topic中订阅者的状态。0:主题已删除或主题下订阅列表为空。1:主题下的订阅列表存在状态为“已订阅”的订阅信息。2:主题下的订阅信息状态处于“未订阅”或“已取消”。

枚举值：

  • 0

  • 1

  • 2

topic_urn

String

Topic的唯一的资源标识。

最小长度：1

最大长度：100

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：0

最大长度：1024

error_type

String

错误类型

最小长度：0

最大长度：128

trace_id

String

请求id

最小长度：32

最大长度：32

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：0

最大长度：1024

error_type

String

错误类型

最小长度：0

最大长度：128

trace_id

String

请求id

最小长度：32

最大长度：32

状态码： 500

表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}/event2alarm-rule

响应示例

状态码： 200

OK 请求响应成功。

[ {
  "action_rule" : "1",
  "alarm_type" : "notification",
  "create_time" : 1701442632968,
  "description" : "",
  "enable" : true,
  "event_names" : [ ],
  "inhibit_rule" : "",
  "metadata" : {
    "customField" : [ "xxx" ]
  },
  "migrated" : false,
  "name" : "1jB5h6GnbY",
  "resource_provider" : "AOM",
  "route_group_rule" : "",
  "topics" : [ ],
  "trigger_policies" : [ {
    "count" : 99,
    "id" : 0,
    "level" : "",
    "name" : "",
    "operator" : ">=",
    "period" : 300,
    "trigger_type" : "accumulative"
  } ],
  "update_time" : 0,
  "user_id" : "2a473356cca5487f8373be891bffc1cf"
} ]

状态码： 401

Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

{
  "error_code" : "SVCSTG.AMS.2000051",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED"
}

状态码： 403

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

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

状态码： 500

InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。

{
  "error_code" : "APM.00000500",
  "error_msg" : "Internal Server Error",
  "trace_id" : ""
}

状态码

状态码

描述

200

OK 请求响应成功。

401

Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

403

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

500

InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。

错误码

请参见错误码。

父主题： 告警