文档中心

云监控

事件规则

CreateEventRule

CreateEventRule

创建事件规则。

请求说明

请求方式：POST

请求地址：https://cloudmonitor.cn-beijing.volcengineapi.com?Action=CreateEventRule&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateEventRule	接口名称。当前 API 的名称为 CreateEventRule。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 2018-01-01。
RuleName	String	否	rule-01	规则名称。长度限制在 1～128 字符之间。不能以数字、中划线-开头。
Description	String	否	This is test rule 01	规则描述。不能以数字、中划线-、中文符号开头。只能包含中文，字母，数字，下划线_，中划线-、中文符号。长度限制在 0～255 字符之间。
EventBusName	String	是	default	事件总线名称。目前仅支持填写为default。
EventSource	String	是	ecs	事件源。
EventType	Array of String	是	["ecs:Disk:DiskError.Redeploy.Executing", "ecs:Disk:DiskError.Redeploy.Inquiring", "ecs:Disk:DiskError.Redeploy.Succeeded"]	事件类型。
Status	String	否	enable	规则状态。 enable：启用规则。 disable：禁用规则。
Level	String	是	warning	告警规则的严重程度。 notice：通知 warning：警告 critical：严重
FilterPattern	JSON Map	否	-	过滤模式，也叫事件匹配规则。暂时不支持自定义匹配规则。
EffectiveTime	Object of EffectiveTime	是	-	规则生效时间，规则只会在这段时间内生效。
ContactMethods	Array of String	是	["Webhook", "Email", "SMS"]	告警通知方式。 Phone：电话 Email：邮件 SMS：短信 Webhook：告警回调 TLS：日志服务 MQ：消息队列 Kafka
ContactGroupIds	Array of String	否	["157284119688196****"]	告警通知组 ID 列表。最多选择 5 个联系组。当ContactMethods参数为Email，Phone，SMS时，该参数不能为空。
Endpoint	String	否	http://example.com/alert	当ContactMethods参数为Webhook时，触发的回调地址。注意 WebhookIds和Endpoint参数仅支持二选一，不能同时填写。
TLSTarget	Array of TLSTarget	否	-	当ContactMethods参数为TLS时，触发的日志服务的配置。
MessageQueue	Array of MQTarget	否	-	当ContactMethods参数为MQ时，触发的消息队列。注意当前只支持将云监控事件投递到消息队列 Kafka 位于北京地域的主题中。与白名单绑定的实例，只有白名单中配置的 IP 才能访问对应的 Kafka 实例，因此：推送给消息队列 Kafka 时，不要选择白名单列表里的实例。已配置推送到某个实例后，不要将该实例添加到白名单列表中。事件规则里第一次选择投递到消息队列 Kafka 的主题时，该主题的用户管理下将自动创建用户名为__volcevent_xxxvolc的用户，请不要删除该用户，否则将导致云监控无法正常投递消息到该主题。
WebhookIds	Array of String	否	-	告警回调 ID 列表。注意 WebhookIds和Endpoint参数仅支持二选一，不能同时填写。
NotifyTemplates	Array of NotifyTemplateBasic	否	-	通知模版配置。说明事件为订阅制，一个事件可以匹配多个事件规则，每个事件规则又可以配置不同的发送渠道。因此，当不同事件规则中的联系人有重复时，事件规则按照级别（倒序）+更新时间（倒序）进行排序，并使用第一个事件规则的级别+通知模板发送事件通知。

FilterPattern

参数	类型	是否必选	示例值	描述
key	String	是	Source	模式匹配中的 key。
value	Any	是	ecs	模式匹配中 key 的取值。

EffectiveTime

参数	类型	是否必选	示例值	描述
StartTime	String	否	09:00	规则启用的开始时间。
EndTime	String	否	20:59	规则启用的结束时间。

TLSTarget

参数	类型	是否必选	示例值	描述
TopicId	String	否	6a6****67c7	主题 ID。
ProjectId	String	否	79fe****122f	项目 ID。
ProjectName	String	否	default	项目名称。
RegionNameCN	String	否	北京	区域的中文名称。
RegionNameEN	String	否	cn-beijing	区域的英文名称。

MQTarget

参数	类型	是否必选	示例值	描述
Type	String	否	kafka	告警通知方式。
Topic	String	否	testkafka	消息队列的 Topic。
VpcId	String	否	vpc-2bzq*****pm22	私有网络（VPC）ID。
Region	String	否	cn-beijing	MQ 实例所在 Region。
Password	String	否	-	MQ 实例密码。
Endpoints	String	否	-	集群地址，仅对 rule_engine 返回。
InstanceId	String	否	kafka-cno*****5hc	MQ 实例 ID。
AuthEncrypt	Array of Integer	否	-	账号密码的密文，仅对 rule_engine 返回。

NotifyTemplateBasic

参数	类型	是否必选	示例值	描述
Channel	String	否	email	通知渠道，取值： email：邮箱 sms：短信 phone：电话 lark：飞书 dingtalk：钉钉 wecom：企业微信 slack：Slack api：回调地址
NotifyTemplateId	String	否	189828***00	通知模版 ID。注意每种通知渠道仅支持配置 1 个通知模版 ID。

请求示例

返回参数

参数	类型	示例值	描述
Data	Object of RuleIDVo	-	事件规则返回内容。

RuleIDVo

参数	类型	示例值	描述
RuleId	String	157284163494346****	事件规则 ID。

返回示例

错误码

本接口无特有的错误码。更多信息请参见错误码。

最近更新时间：2026.08.11 20:28:01

这个页面对您有帮助吗？

有用

有用

无用

无用