You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /
  • 云监控

CreateEventRule

最近更新时间：2024.03.12 16:52:17

首次发布时间：2022.10.26 11:08:02

我的收藏

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

注意事项

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

Request URL

POST https://open.volcengineapi.com?Action=CreateEventRule&Version=2018-01-01


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

请求参数

参数

类型

是否必填

示例值

说明

RuleName

String

是

rule-01

规则名称。

Description

String

否

This is test rule 01

规则描述。

EventBusName

String

是

default

事件总线名称。目前仅支持填写default。

EventSource

String

是

ecs

事件源。

EventType

Array

否

["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

Object

是

-

过滤模式，也叫事件匹配规则。具体格式，请参见FilterPattern请求参数。
暂时不支持自定义匹配规则。

EffectiveTime

Object

是

-

规则生效时间，规则只会在这段时间内生效。具体格式，请参见EffectiveTime请求参数。

ContactMethods

Array

否

["Webhook", "Email", "SMS"]

告警通知方式。

  • Phone：电话
  • Email：邮件
  • SMS：短信
  • Webhook：告警回调
  • TLS：日志服务
  • MQ：消息队列kafka

ContactGroupIds

Array

否

["157284119688196****"]

告警通知方式为电话、短信、邮件时，触发的告警联系组ID。

Endpoint

String

否

http://example.com/alert

告警通知方式为告警回调时，触发的回调地址。

TLSTarget

Array

否

[{"RegionNameEN": "cn-beijing",
"RegionNameCN": "北京",
"ProjectId": "79fe****122f",
"ProjectName": "test",
"TopicId": "6a6****67c7"}]

告警方式为日志服务时，触发的日志服务的配置。

MessageQueue

Array

否

[{"Type": "kafka",
"Region": "cn-beijing",
"InstanceId": "kafka-cno*****5hc",
"Topic": "testkafka",
"VpcId": "vpc-2bzq*****pm22"}]

告警通知方式为消息队列kafka时，触发的消息队列。

注意

  • 当前只支持投递到消息队列kafka里北京地域的主题。
  • 与白名单绑定的实例，只有白名单中配置的IP才能访问对应的kafka实例，所以请注意：
    • 推送给消息队列kafka时，不要选择白名单列表里的实例。
    • 已配置推送到某个实例后，不要将该实例添加到白名单列表中。
  • 事件规则里第一次选择投递到消息队列kafka的这个主题时，该主题的用户管理下将自动创建用户名为__volcevent_xxxvolc的用户，请不要删除该用户，否则云监控无法正常投递消息到该主题。

FilterPattern请求参数

参数

类型

是否必填

示例值

说明

Type

Array

是

["ecs:Disk:DiskError.Redeploy.Executing", "ecs:Disk:DiskError.Redeploy.Inquiring", "ecs:Disk:DiskError.Redeploy.Succeeded"]

模式匹配中对应的事件类型列表，当前为任意匹配。

Source

String

是

ecs

模式匹配中对应的事件源。

EffectiveTime请求参数

参数

类型

是否必填

示例值

说明

StartTime

String

是

09:00

规则启用的开始时间。

EndTime

String

是

20:59

规则启用的结束时间。

返回参数

参数

类型

示例值

描述

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****"
        }
    }
}