查询告警规则列表(推荐)
功能介绍
查询告警规则列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/alarms
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户ID 正则匹配:^[a-zA-Z0-9-]{1,64}$ |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
alarm_id |
否 |
String |
告警规则ID 正则匹配:^al([0-9A-Za-z]){22}$ |
name |
否 |
String |
告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字,长度1-128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ |
namespace |
否 |
String |
查询服务的命名空间,各服务命名空间请参考“服务命名空间” 正则匹配:^((([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*)|)$ |
resource_id |
否 |
String |
告警资源ID,多维度情况按字母升序排列并使用逗号分隔 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|:|,|\.|)+$ |
enterprise_project_id |
否 |
String |
企业项目ID 正则匹配:^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ |
product_name |
否 |
String |
产品层级跨纬规则查询时支持产品名称查询,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.ECS,instance_id" |
resource_level |
否 |
String |
产品层级跨纬规则查询时支持规则所属类型查询,resource_level取值为product即为产品层级跨纬规则,不填或者取值为dimension则为旧的规则类型 枚举值:
|
offset |
否 |
Integer |
分页偏移量 取值范围: 0-10000 默认取值: 0 正则匹配:^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$ |
limit |
否 |
Integer |
分页大小 取值范围: 1-100 默认取值: 10 正则匹配:^([1-9]|[1-9][0-9]|100)$ |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 默认取值: application/json; charset=UTF-8 |
X-Auth-Token |
是 |
String |
用户Token |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
alarms |
Array of alarms objects |
告警规则列表 |
count |
Integer |
告警规则总数 取值范围: 0-10000 |
参数 |
参数类型 |
描述 |
---|---|---|
alarm_id |
String |
告警规则id,以al开头,包含22个数字或字母 |
name |
String |
告警名称, 只能包含0-9/a-z/A-Z/_/-或汉字,长度1-128 |
description |
String |
告警描述,长度0-256 |
namespace |
String |
查询服务的命名空间,各服务命名空间请参考服务命名空间 |
policies |
Array of Policy objects |
告警策略 |
resources |
Array of ResourcesInListResp objects |
资源列表,关联资源需要使用查询告警规则资源接口获取 |
type |
String |
告警规则类型,ALL_INSTANCE为全部资源指标告警,RESOURCE_GROUP为资源分组指标告警,MULTI_INSTANCE为指定资源指标告警,EVENT.SYS为系统事件告警,EVENT.CUSTOM自定义事件告警,DNSHealthCheck为健康检查告警; 枚举值:
|
enabled |
Boolean |
是否开启告警规则。true:开启,false:关闭。 |
notification_enabled |
Boolean |
是否开启告警通知。true:开启,false:关闭。 |
alarm_notifications |
Array of Notification objects |
告警触发的动作 |
ok_notifications |
Array of Notification objects |
告警恢复触发的动作 |
notification_begin_time |
String |
告警通知开启时间 |
notification_end_time |
String |
告警通知关闭时间 |
effective_timezone |
String |
时区,形如:"GMT-08:00"、"GMT+08:00"、"GMT+0:00" |
enterprise_project_id |
String |
企业项目ID |
alarm_template_id |
String |
告警规则关联告警模板ID,如果传了,告警规则关联的策略会和告警模板策略联动变化 |
product_name |
String |
产品层级跨纬规则需要指明的规则产品名称,一般由"服务命名空间,服务首层维度名称"组成,如"SYS.ECS,instance_id" |
resource_level |
String |
产品层级跨纬规则需要指明为产品层级规则,resource_level取值为product即为产品层级跨纬规则,不填或者取值为dimension则为旧的规则类型 枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
metric_name |
String |
资源的监控指标名称,必须以字母开头,只能包含0-9/a-z/A-Z/_,字符长度最短为1,最大为64;如:弹性云服务器中的监控指标cpu_util,表示弹性服务器的CPU使用率;文档数据库中的指标mongo001_command_ps,表示command执行频率;各服务的指标名称可查看:“服务指标名称”。 |
period |
Integer |
指标周期,单位是秒; 0是默认值,例如事件类告警该字段就用0即可; 1代表指标的原始周期,比如RDS监控指标原始周期是60s,表示该RDS指标按60s周期为一个数据点参与告警计算;如想了解各个云服务的指标原始周期可以参考“支持服务列表”,300代表指标按5分钟聚合周期为一个数据点参与告警计算。 取值范围: 0-86400 枚举值:
|
filter |
String |
聚合方式, 支持的值为(average|min|max|sum) |
comparison_operator |
String |
阈值符号, 支持的值为(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动; 指标告警可以使用的阈值符号有>、>=、<、<=、=、!=、cycle_decrease、cycle_increase、cycle_wave; 事件告警可以使用的阈值符号为>、>=、<、<=、=、!=; |
value |
Number |
告警阈值。单一阈值时value和alarm_level配对使用,当hierarchical_value和value同时使用时以hierarchical_value为准。 具体阈值取值请参见附录中各服务监控指标中取值范围,如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。 [具体阈值取值请参见附录中各服务监控指标中取值范围,如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。] |
hierarchical_value |
HierarchicalValue object |
多层级告警阈值。当hierarchical_value和value同时使用时以hierarchical_value为准。 创建或修改告警规则以下2种场景只支持设置一个阈值: 1.告警类型为指标告警且告警策略为所有策略都满足才告警的场景。 2.告警类型为事件告警的场景。 |
unit |
String |
数据的单位。 |
count |
Integer |
告警连续触发次数,事件告警时参数值为1~180(包括1和180);指标告警和站点告警时,次数采用枚举值,枚举值分别为:1、2、3、4、5、10、15、30、60、90、120、180 |
suppress_duration |
Integer |
告警抑制时间,单位为秒,对应页面上创建告警规则时告警策略最后一个字段,该字段主要为解决告警频繁的问题,0代表不抑制,满足条件即告警;300代表满足告警触发条件后每5分钟告警一次; 取值范围: 0-86400 枚举值:
|
level |
Integer |
告警级别, 1为紧急,2为重要,3为次要,4为提示。默认值为2。 |
namespace |
String |
产品层级规则增加namespace(服务命名空间)和dimension_name(服务维度名称)指明生效策略归属。各服务命名空间请参考“服务命名空间” |
dimension_name |
String |
产品层级规则增加namespace(服务命名空间)和dimension_name(服务维度名称)指明生效策略归属。目前最大支持4个维度,各服务资源的指标维度名称可查看:“服务维度名称”。 举例:单维度场景:instance_id;多维度场景:instance_id,disk |
参数 |
参数类型 |
描述 |
---|---|---|
critical |
Double |
紧急级别的阈值 取值范围: 0-1.7976931348623156E108 |
major |
Double |
重要级别的阈值 取值范围: 0-1.7976931348623156E108 |
minor |
Double |
次要级别的阈值 取值范围: 0-1.7976931348623156E108 |
info |
Double |
提示级别的阈值 取值范围: 0-1.7976931348623156E108 |
参数 |
参数类型 |
描述 |
---|---|---|
resource_group_id |
String |
资源分组ID,监控范围为资源分组时存在该值 正则匹配:^rg([a-z]|[A-Z]|[0-9]){22}$ |
resource_group_name |
String |
资源分组名称,监控范围为资源分组时存在该值 |
dimensions |
Array of MetricDimension objects |
维度信息 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
指标维度名称 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ |
value |
String |
指标维度值 正则匹配:^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-)*)|){0,256}$ |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
通知类型。notification为SMN通知,contact为云账号联系人,contactGroup为通知组,autoscaling为AS通知。 枚举值:
|
notification_list |
Array of strings |
告警状态发生变化时,被通知对象的列表。topicUrn可从SMN获取,具体操作请参考查询Topic列表。当type为notification时,notification_list列表不能为空;当type为autoscaling时,列表必须为[]。 说明:若alarm_action_enabled为true,对应的alarm_actions、ok_actions至少有一个不能为空。若alarm_actions、ok_actions同时存在时,notification_list值保持一致。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
请求异常内部业务状态码 |
error_msg |
String |
请求异常信息 |
request_id |
String |
请求ID |
请求示例
查询告警规则列表
/v2/{project_id}/alarms?offset=0&limit=10
响应示例
状态码:200
查询成功
{
"alarms" : [ {
"alarm_id" : "al16558829757444BVVxr999",
"name" : "alarm01",
"description" : "",
"namespace" : "SYS.ECS",
"policies" : [ {
"metric_name" : "disk_device_read_bytes_rate",
"period" : 1,
"filter" : "average",
"comparison_operator" : ">",
"value" : 75,
"unit" : "byte/s",
"count" : 3,
"suppress_duration" : 10800,
"level" : 2
} ],
"resources" : [ {
"dimensions" : [ {
"name" : "disk_name"
} ]
} ],
"type" : "ALL_INSTANCE",
"enabled" : true,
"notification_enabled" : true,
"alarm_notifications" : [ {
"type" : "notification",
"notification_list" : [ "urn:smn:xxx:xxx70e7359:topic_xxx" ]
} ],
"ok_notifications" : [ {
"type" : "notification",
"notification_list" : [ "urn:smn:xxx:xxx70e7359:topic_xxx" ]
} ],
"notification_begin_time" : "00:00",
"notification_end_time" : "23:59",
"enterprise_project_id" : "0"
} ],
"count" : 1
}
状态码
状态码 |
描述 |
---|---|
200 |
查询成功 |
400 |
参数校验失败 |
500 |
系统内部错误 |
错误码
请参见错误码。