文档首页/ 云监控服务 CES/ API参考/ API/ 告警/ 告警规则管理/ 查询告警规则列表(V1)
更新时间:2025-09-23 GMT+08:00
分享

查询告警规则列表(V1)

功能介绍

查询告警规则列表,可以指定分页条件限制结果数量,可以指定排序规则。告警规则V1接口只支持配置单资源单策略规则,建议使用查询告警规则列表(推荐)与前端功能配套使用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /V1.0/{project_id}/alarms

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见“获取项目ID”。

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

start

String

参数解释

分页起始值,内容为alarm_id

约束限制

不涉及。

取值范围

以al开头,后跟22位字母或数字。字符长度为24

默认取值

不涉及。

limit

Integer

参数解释

用于限制结果数据条数。

约束限制

不涉及。

取值范围

取值范围(0,100]

默认取值

默认值为100

order

String

参数解释

用于标识结果排序方法,按时间戳排序。

约束限制

不涉及

取值范围

枚举值:

  • asc:升序

  • desc:降序

默认取值

desc

enterprise_project_id

String

参数解释

企业项目ID,当查询所有企业项目时,配置为:all_granted_eps。

当需要查询某个企业项目时,配置为对应的企业项目ID,请参考获取企业项目ID

约束限制

不涉及。

取值范围

只能包含小写字母、数字、“-”、“_”,长度为36个字符。也可取值0或all_granted_eps。0:代表默认企业项目ID,all_granted_eps:代表所有企业项目ID。

默认取值

all_granted_eps

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

长度为[1,64]个字符。

默认取值:

默认使用 application/json; charset=UTF-8,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

X-Auth-Token

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

长度为[1,16384]个字符。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

metric_alarms

Array of MetricAlarmsResp objects

参数解释

查询的告警对象列表。

meta_data

MetaDataResp object

参数解释

查询结果元数据信息,包括分页信息等。

表5 MetricAlarmsResp

参数

参数类型

描述

alarm_name

String

参数解释

告警名称。

取值范围

只能包含0-9/a-z/A-Z/_/-或汉字,字符长度为[1,128]。

alarm_description

String

参数解释

告警描述。

取值范围

长度[0,256]个字符。

metric

ListAlarmMetricResp object

参数解释

创建规则中的监控指标信息。

condition

ConditionResp object

参数解释

告警规则设置的告警策略。

alarm_enabled

Boolean

参数解释

是否启用该条告警。

取值范围

布尔值。

true:开启。

false:关闭。

alarm_level

Integer

参数解释

告警级别。

取值范围

级别为1、2、3、4。分别对应紧急、重要、次要、提示。

alarm_type

String

参数解释

告警类型。

取值范围

针对事件类型的告警时,告警类型为EVENT.SYS(系统事件)或EVENT.CUSTOM(自定义事件)。

针对资源分组的告警时,告警类型为RESOURCE_GROUP。

针对指定资源的告警时,告警类型为MULTI_INSTANCE。

  • EVENT.SYS:针对系统事件的告警类型

  • EVENT.CUSTOM:针对自定义事件的告警类型

  • RESOURCE_GROUP:针对资源分类的告警类型

  • MULTI_INSTANCE:指定资源的告警类型

alarm_action_enabled

Boolean

参数解释

该条告警触发时,是否开启告警通知。

取值范围

布尔值。

  • true:开启告警通知。

  • false:不开启告警通知。

alarm_actions

Array of AlarmActionsResp objects

参数解释

告警触发时,通知组/主题订阅的信息。结构如下:{ "type": "notification", "notificationList":["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

ok_actions

Array of AlarmActionsResp objects

参数解释

告警恢复时,通知组/主题订阅的信息。结构如下:{ "type": "notification", "notificationList":

["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

insufficientdata_actions

Array of AlarmActionsResp objects

参数解释

数据不足触发告警时,通知组/主题订阅的信息。结构如下:{ "type": "notification", "notificationList":["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

alarm_action_begin_time

String

参数解释

告警规则生效的开始时间,告警规则仅在生效时间内发送通知消息。例如alarm_action_begin_time为8:00,alarm_action_end_time为20:00时,则对应的告警规则仅在08:00-20:00发送通知消息。

取值范围

只能包含数字、“:”,长度为[1,64]个字符。

alarm_action_end_time

String

参数解释

告警规则生效的结束时间,告警规则仅在生效时间内发送通知消息。例如alarm_action_begin_time为8:00,alarm_action_end_time为20:00时,则对应的告警规则仅在08:00-20:00发送通知消息。

取值范围

只能包含数字、“:”,长度为[1,64]个字符。

effective_timezone

String

参数解释

时区,形如:"GMT-08:00"、"GMT+08:00"、"GMT+0:00"

取值范围

长度为[1,16]个字符。

alarm_id

String

参数解释

告警规则的ID。

取值范围

以al开头,后跟22个数字或字母。字符长度为24

update_time

Long

参数解释

告警状态变更的时间,UNIX时间戳,单位毫秒。

取值范围

0 - 9999999999999

alarm_state

String

参数解释

告警状态。

取值范围

只能为ok、alarm、insufficient_data。字符长度为[0,17]

  • ok:正常

  • alarm:告警

  • insufficient_data:数据不足

enterprise_project_id

String

参数解释

企业项目ID。

取值范围

只能包含小写字母、数字、“-”、“_”,长度为36个字符。也可取值0或all_granted_eps。0:代表默认企业项目ID,all_granted_eps:代表所有企业项目ID。

表6 ListAlarmMetricResp

参数

参数类型

描述

namespace

String

参数解释

服务指标命名空间。如:弹性云服务器的命名空间为SYS.ECS,文档数据库的命名空间为SYS.DDS,各服务的命名空间可查看:“服务命名空间”。

取值范围

格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_,字符总长度最短为3,最大为32。

dimensions

Array of DimensionResp objects

参数解释

指标维度,目前最大为4个维度。

metric_name

String

参数解释

资源的监控指标名称。如:弹性云服务器中的监控指标cpu_util,表示弹性服务器的CPU使用率;文档数据库中的指标mongo001_command_ps,表示command执行频率;各服务的指标名称可查看:“服务指标名称”。

取值范围

必须以字母开头,只能包含0-9/a-z/A-Z/_,长度为[1,96]个字符。

resource_group_id

String

参数解释

创建告警规则时选择的资源分组ID,如:rg1603786526428bWbVmk4rP

取值范围

只能包含字母、数字、“-”、“_”,字符长度为[1,64]

resource_group_name

String

参数解释

创建告警规则时选择的资源分组名称,如:Resource-Group-ECS-01

取值范围

字符长度为[0,128]

表7 DimensionResp

参数

参数类型

描述

name

String

参数解释

监控维度名称,如ECS的维度为instance_id。各服务资源的指标维度名称可查看:“服务维度名称”。

取值范围

以字母开头,只能包含字母、数字、“_”、“-”。长度[1,32]个字符。

value

String

参数解释

监控维度取值,例如ECS的ID。

取值范围

长度为[0,256]个字符。

表8 ConditionResp

参数

参数类型

描述

comparison_operator

String

参数解释

告警阈值的比较条件。

取值范围

只能是>、=、<、>=、<=、!=。

count

Integer

参数解释

触发告警的连续发生次数。

取值范围

取值范围[1, 5]。告警类型为事件告警时,取值范围为[1, 100]。

filter

String

参数解释

数据聚合的方式。

取值范围

支持 average、variance、min、max、sum。

  • average: 平均值

  • variance:方差

  • min:最小值

  • max:最大值

  • sum:求和

period

Integer

参数解释

指标周期,单位是秒。如想了解各个云服务的指标原始周期可以参考“支持服务列表

取值范围

枚举值。

  • 0代表立即触发,仅限事件场景使用。

  • 1代表指标的原始周期,比如RDS监控指标原始周期是60s,表示该RDS指标按60s周期为一个数据点参与告警计算。

  • 300代表指标按5分钟聚合周期为一个数据点参与告警计算。

  • 1200代表指标按20分钟聚合周期为一个数据点参与告警计算。

  • 3600代表指标按1小时聚合周期为一个数据点参与告警计算。

  • 14400代表指标按4小时聚合周期为一个数据点参与告警计算。

  • 86400代表指标按1天聚合周期为一个数据点参与告警计算。

unit

String

参数解释

数据的单位。

取值范围

长度为[0,32]个字符。

value

Number

参数解释

告警阈值。具体阈值取值请参见附录中各服务监控指标中取值范围,如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。

取值范围

最小值为-1.7976931348623157e+108,最大值为1.7976931348623157e+108。

suppress_duration

Integer

参数解释

告警抑制时间,单位为秒,对应页面上创建告警规则时告警策略最后一个字段,该字段主要为解决告警频繁的问题。

取值范围

枚举值,只能为0、300、600、900、1800、3600、10800、21600、43200、86400。

  • 0:对于指标类告警,0代表告警一次。对于事件类告警,在立即触发场景中,0代表不抑制;在累计触发场景,0代表只告警一次。

  • 300代表满足告警触发条件后每5分钟告警一次。

  • 600代表满足告警触发条件后每10分钟告警一次。

  • 900代表满足告警触发条件后每15分钟告警一次。

  • 1800代表满足告警触发条件后每30分钟告警一次。

  • 3600代表满足告警触发条件后每60分钟告警一次。

  • 10800代表满足告警触发条件后每3小时告警一次。

  • 21600代表满足告警触发条件后每6小时告警一次。

  • 43200代表满足告警触发条件后每12小时告警一次。

  • 86000代表满足告警触发条件后每一天告警一次。

表9 AlarmActionsResp

参数

参数类型

描述

[数组元素]

Array of NotificationResp objects

参数解释

告警触发时,通知组/主题订阅的信息。

表10 NotificationResp

参数

参数类型

描述

type

String

参数解释

告警通知类型。

取值范围

取值如下: notification:SMN通知; autoscaling:AS通知。

notificationList

Array of strings

参数解释

告警状态发生变化时,被通知对象的列表。

表11 MetaDataResp

参数

参数类型

描述

count

Integer

参数解释

当前返回结果条数。

取值范围:

0 - 2147483647

total

Integer

参数解释

结果总条数。

取值范围

0 - 2147483647

marker

String

参数解释

下一个开始的标记,用于分页。如本次查询10条数据,第十条为alarm_id为1441967036681YkazZ0deN,下次start配置为al1441967036681YkazZ0deN可从该alarm_id开始查询。

取值范围

1 - 9999

状态码:400

表12 响应Body参数

参数

参数类型

描述

-

String

请求错误。

状态码:401

表13 响应Body参数

参数

参数类型

描述

-

String

未提供认证信息,或认证信息错误。

状态码:403

表14 响应Body参数

参数

参数类型

描述

-

String

请求页面被禁止访问。

状态码:408

表15 响应Body参数

参数

参数类型

描述

-

String

请求超出了服务器的等待时间。

状态码:429

表16 响应Body参数

参数

参数类型

描述

-

String

前请求过多。

状态码:500

表17 响应Body参数

参数

参数类型

描述

-

String

请求未完成,服务异常。

状态码:503

表18 响应Body参数

参数

参数类型

描述

-

String

系统暂时不可用,请求受限。

请求示例

  • 请求样例一:查询当前告警规则列表。
    
    /V1.0/{project_id}/alarms?start=al1441967036681YkazZ0deN&limit=10&order=desc
  • 请求样例二:查询告警规则列表,从alarm_id为al1441967036681YkazZ0deN开始,结果按时间戳降序保留10条数据。
    
    GET https://{云监控的endpoint}/V1.0/{project_id}/alarms?start=al1441967036681YkazZ0deN&limit=10&order=desc
  • 请求样例三:查询所有企业项目下的告警规则列表,从alarm_id为al1441967036681YkazZ0deN开始,结果按时间戳降序保留10条数据。
    
    GET https://{云监控的endpoint}/V1.0/{project_id}/alarms?start=al1441967036681YkazZ0deN&limit=10&order=desc&enterprise_project_id=all_granted_eps

响应示例

状态码:200

OK

{
  "metric_alarms" : [ {
    "alarm_id" : "al1604473956229Ym1m1Wx6e",
    "alarm_name" : "alarm-rp0E",
    "alarm_description" : "",
    "metric" : {
      "namespace" : "SYS.ECS",
      "dimensions" : [ {
        "name" : "instance_id",
        "value" : "33328f02-3814-422e-b688-bfdba93d4051"
      } ],
      "metric_name" : "network_outgoing_bytes_rate_inband"
    },
    "condition" : {
      "period" : 300,
      "filter" : "average",
      "comparison_operator" : ">=",
      "value" : 6,
      "unit" : "B/s",
      "count" : 1
    },
    "alarm_level" : 2,
    "alarm_enabled" : true,
    "alarm_action_enabled" : true,
    "alarm_actions" : [ {
      "type" : "notification",
      "notificationList" : [ "urn:smn:southchina:68438a86d98e427e907e0097b7e35d48:sd" ]
    } ],
    "ok_actions" : [ {
      "type" : "notification",
      "notificationList" : [ "urn:smn:southchina:68438a86d98e427e907e0097b7e35d48:sd" ]
    } ],
    "insufficientdata_actions" : [ ],
    "update_time" : 1604473956000,
    "alarm_state" : "insufficient_data",
    "enterprise_project_id" : "0"
  }, {
    "alarm_id" : "al1604426791923xQaE8OEXx",
    "alarm_name" : "alarm-5348",
    "alarm_description" : "",
    "metric" : {
      "namespace" : "AGT.ECS",
      "dimensions" : [ {
        "name" : "instance_id",
        "value" : "22d98f6c-16d2-4c2d-b424-50e79d82838f"
      } ],
      "metric_name" : "disk_read_bytes_per_operation"
    },
    "condition" : {
      "period" : 1,
      "filter" : "average",
      "comparison_operator" : ">=",
      "value" : 30,
      "unit" : "KB/op",
      "count" : 3,
      "suppress_duration" : 86400
    },
    "alarm_level" : 2,
    "alarm_type" : "MULTI_INSTANCE",
    "alarm_enabled" : true,
    "alarm_action_enabled" : false,
    "alarm_actions" : [ ],
    "ok_actions" : [ ],
    "insufficientdata_actions" : [ ],
    "update_time" : 1604426791000,
    "alarm_state" : "insufficient_data",
    "enterprise_project_id" : "0"
  } ],
  "meta_data" : {
    "count" : 2,
    "marker" : "",
    "total" : 2
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

408

Request Timeout

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

错误码

请参见错误码

相关文档