本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云监控服务 CES/ API参考/ API/ 告警/ 一键告警/ 创建一键告警

创建一键告警

更新时间：2025-04-25 GMT+08:00

查看PDF

功能介绍

创建一键告警

调试

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

URI

POST /v2/{project_id}/one-click-alarms

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	发送的实体的MIME类型。默认使用application/json; charset=UTF-8。缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64
X-Auth-Token	是	String	用户Token 最小长度：1 最大长度：16384

表3 请求Body参数
参数	是否必选	参数类型	描述
one_click_alarm_id	是	String	一键告警ID
dimension_names	是	DimensionNames object	启用一键告警关联告警规则的维度列表，包括指标告警&事件告警，且至少开启一个
notification_enabled	是	Boolean	是否开启告警通知
alarm_notifications	否	Array of Notification objects	告警触发的动作
ok_notifications	否	Array of Notification objects	告警恢复触发的动作
notification_begin_time	否	String	告警通知开启时间
notification_end_time	否	String	告警通知关闭时间
notification_manner	否	String	NOTIFICATION_GROUP(通知组)/TOPIC_SUBSCRIPTION(主题订阅)/NOTIFICATION_POLICY(通知策略) 最小长度：0 最大长度：64 枚举值： NOTIFICATION_GROUP TOPIC_SUBSCRIPTION NOTIFICATION_POLICY
notification_policy_ids	否	Array of strings	关联的通知策略ID列表最小长度：0 最大长度：64 数组长度：0 - 20
is_reset	否	Boolean	是否以默认一键告警规则重置创建缺省值：false
one_click_update_alarms	否	Array of one_click_update_alarms objects	打开一键告警需要同时修改告警策略及通知(当前仅支持通知策略修改)时传递的参数数组长度：0 - 100

表4 DimensionNames
参数	是否必选	参数类型	描述
metric	是	Array of strings	启用一键告警关联指标告警规则的维度列表，未指定的维度默认不开启
event	是	Array of strings	启用一键告警关联事件告警规则的维度列表，未指定的维度默认不开启，其中""代表全部资源

表5 Notification
参数	是否必选	参数类型	描述
type	是	String	通知类型。notification为SMN通知，contact为云账号联系人，contactGroup为通知组，autoscaling为AS通知。枚举值： notification autoscaling groupwatch ecsRecovery contact contactGroup iecAction
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值保持一致。数组长度：0 - 20

表6 one_click_update_alarms
参数	是否必选	参数类型	描述
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	告警策略数组长度：1 - 100
resources	否	Array of ResourcesInListResp objects	资源列表，关联资源需要使用查询告警规则资源接口获取数组长度：0 - 1000
type	否	String	告警规则类型，ALL_INSTANCE为全部资源指标告警，RESOURCE_GROUP为资源分组指标告警，MULTI_INSTANCE为指定资源指标告警，EVENT.SYS为系统事件告警，EVENT.CUSTOM自定义事件告警，DNSHealthCheck为健康检查告警；枚举值： EVENT.SYS EVENT.CUSTOM DNSHealthCheck RESOURCE_GROUP MULTI_INSTANCE ALL_INSTANCE
enabled	否	Boolean	告警开关
notification_enabled	否	Boolean	是否开启告警通知
alarm_notifications	否	Array of Notification objects	告警触发的动作
ok_notifications	否	Array of Notification objects	告警恢复触发的动作
notification_begin_time	否	String	告警通知开启时间
notification_end_time	否	String	告警通知关闭时间
notification_manner	否	String	NOTIFICATION_POLICY(通知策略) 最小长度：0 最大长度：64 枚举值： NOTIFICATION_POLICY
notification_policy_ids	否	Array of strings	关联的通知策略ID列表最小长度：1 最大长度：64 数组长度：0 - 20

表7 Policy
参数	是否必选	参数类型	描述
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 枚举值： 0 1 300 1200 3600 14400 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。](tag: dt,g42,dt_test,hk_g42,hk_sbc,hws,hws_hk,ocb,sbc,tm)
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 枚举值： 0 300 600 900 1800 3600 10800 21600 43200 86400
level	否	Integer	告警级别, 1为紧急，2为重要，3为次要，4为提示。默认值为2。
namespace	否	String	产品层级规则增加namespace（服务命名空间）和dimension_name（服务维度名称）指明生效策略归属。各服务命名空间请参考“服务命名空间” 最小长度：0 最大长度：32
dimension_name	否	String	产品层级规则增加namespace（服务命名空间）和dimension_name（服务维度名称）指明生效策略归属，目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务维度名称” 最小长度：0 最大长度：32

表8 HierarchicalValue
参数	是否必选	参数类型	描述
critical	否	Double	紧急级别的阈值最小值：0 最大值：1.7976931348623156E108
major	否	Double	重要级别的阈值最小值：0 最大值：1.7976931348623156E108
minor	否	Double	次要级别的阈值最小值：0 最大值：1.7976931348623156E108
info	否	Double	提示级别的阈值最小值：0 最大值：1.7976931348623156E108

表9 ResourcesInListResp
参数	是否必选	参数类型	描述
resource_group_id	否	String	资源分组ID，监控范围为资源分组时存在该值正则匹配：^rg([a-z]\|[A-Z]\|[0-9]){22}$
resource_group_name	否	String	资源分组名称，监控范围为资源分组时存在该值最小长度：1 最大长度：128
dimensions	否	Array of MetricDimension objects	维度信息数组长度：0 - 10000

**表10** MetricDimension
参数	是否必选	参数类型	描述
name	是	String	指标维度名称最小长度：1 最大长度：32 正则匹配：^([a-z]\|[A-Z]){1}([a-z]\|[A-Z]\|[0-9]\|_\|-){1,32}$
value	否	String	指标维度值最小长度：0 最大长度：256 正则匹配：^((([a-z]\|[A-Z]\|[0-9]){1}([a-z]\|[A-Z]\|[0-9]\|_\|-)*)\|){0,256}$

响应参数

状态码：201

**表11** 响应Body参数
参数	参数类型	描述
one_click_alarm_id	String	一键告警ID

状态码：400

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码：401

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码：403

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码：500

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

请求示例

/v2/{project_id}/one-click-alarms

{
  "one_click_alarm_id" : "o1234567890123456789012",
  "dimension_names" : {
    "metric" : [ "disk", "instance_id" ],
    "event" : [ "resource_id" ]
  },
  "notification_enabled" : true,
  "alarm_notifications" : [ {
    "type" : "notification",
    "notification_list" : [ "urn:smn:123" ]
  } ],
  "ok_notifications" : [ {
    "type" : "notification",
    "notification_list" : [ "urn:smn:123" ]
  } ],
  "notification_begin_time" : "00:00",
  "notification_end_time" : "23:59",
  "notification_manner" : "NOTIFICATION_POLICY",
  "notification_policy_ids" : [ "np15563156337845e8A2Wv63" ]
}

响应示例

状态码：201

Created

{
  "one_click_alarm_id" : "o1234567890123456789012"
}

状态码


状态码	描述
201	Created
400	参数校验失败
401	未认证
403	认证鉴权失败
500	系统内部错误

错误码

请参见错误码。

父主题： 一键告警

上一篇：一键告警

下一篇：查询一键告警列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建一键告警

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈