CreateEventRule--云监控-火山引擎

文档中心

立即注册

导航

CreateEventRule

最近更新时间：2024.06.27 14:36:24首次发布时间：2022.10.26 11:08:02

调用CreateEventRule接口创建事件规则。

注意事项

该接口调用服务方较多，不建议高频调用，否则将触发限流。建议QPS值不大于20。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateEventRule&Version=2018-01-01

ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

调试

API Explorer

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

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateEventRule`	接口名称。当前 API 的名称为 `CreateEventRule`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数	类型	是否必选	示例值	描述
RuleName	String	否	`rule-01`	规则名称。
Description	String	否	`This is test rule 01`	规则描述。
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列表。当AlertMethods参数为Email，Phone，SMS时，ContactGroupIds参数不能为空。
Endpoint	String	否	`http://example.com/alert`	告警通知方式为告警回调时，触发的回调地址。
TLSTarget	Array of TLSTargetInfo	否	`-`	告警方式为日志服务时，触发的日志服务的配置。
MessageQueue	Array of MQTarget	否	`-`	告警通知方式为消息队列kafka时，触发的消息队列。注意当前只支持投递到消息队列kafka里北京地域的主题。与白名单绑定的实例，只有白名单中配置的IP才能访问对应的kafka实例，所以请注意：推送给消息队列kafka时，不要选择白名单列表里的实例。已配置推送到某个实例后，不要将该实例添加到白名单列表中。事件规则里第一次选择投递到消息队列kafka的这个主题时，该主题的用户管理下将自动创建用户名为__volcevent_xxxvolc的用户，请不要删除该用户，否则云监控无法正常投递消息到该主题。
WebhookIds	Array of String	否	`-`	告警回调ID列表。WebhookIds和Endpoint参数二选一，不能同步填写。

FilterPattern

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

EffectiveTime

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

TLSTargetInfo

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

MQTarget

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

返回参数

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

RuleIDVo

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

请求示例

POST https://open.volcengineapi.com?Action=CreateEventRule&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "RuleName":"rule-01",
    "Description":"This is test rule 01",
    "EventBusName":"default",
    "EventSource":"ecs",
    "EventType":[
        "ecs:Disk:DiskError.Redeploy.Executing",
        "ecs:Disk:DiskError.Redeploy.Inquiring",
        "ecs:Disk:DiskError.Redeploy.Succeeded"
    ],
    "Status":"enable",
    "Level":"warning",
    "FilterPattern":{
        "Type":[
            "ecs:Disk:DiskError.Redeploy.Executing",
            "ecs:Disk:DiskError.Redeploy.Inquiring",
            "ecs:Disk:DiskError.Redeploy.Succeeded"
        ],
        "Source":"ecs"
    },
    "EffectiveTime":{
        "StartTime":"09:00",
        "EndTime":"20:59"
    },
    "ContactMethods":[
        "Webhook",
        "Email",
        "SMS"
    ],
    "Endpoint":"http://example.com/alert"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20230****4C52",
        "Action":"CreateEventRule",
        "Version":"2018-01-01",
        "Service":"Volc_Observe",
        "Region":"cn-beijing"
    },
    "Result":{
        "Data":{
            "RuleID":"157284163494346****"
        }
    }
}

错误码

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

云监控