You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /云监控/API参考/事件规则/CreateEventRule
CreateEventRule
最近更新时间：2024.09.25 11:01:42首次发布时间：2022.10.26 11:08:02
我的收藏

创建事件规则。

注意事项

该接口调用服务方较多，不建议高频调用，否则将触发限流。建议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

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

Body

参数类型是否必选示例值描述

RuleName

String

是

rule-01

规则名称。

  • 长度限制在1~128字符之间
  • 不能以数字、中划线开头

Description

String

否

This is test rule 01

规则描述。

  • 不能以数字、中划线、中文符号开头

  • 只能包含中文，字母，数字，下划线，中划线、中文符号

  • 长度限制在0~255字符之间

EventBusNameString是default事件总线名称。目前仅支持填写default。
EventSourceString是ecs事件源。
EventTypeArray 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

否

-

过滤模式，也叫事件匹配规则。
暂时不支持自定义匹配规则。

EffectiveTimeObject of EffectiveTime是-规则生效时间，规则只会在这段时间内生效。

ContactMethods

Array of String

是

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

告警通知方式。

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

ContactGroupIds

Array of String

否

["157284119688196****"]

告警通知组ID列表。

  • 最多选择5个联系组。
  • 当AlertMethods参数为Email，Phone，SMS时，ContactGroupIds参数不能为空。
EndpointString否http://example.com/alert告警通知方式为告警回调时，触发的回调地址。
TLSTargetArray of TLSTargetInfo否-告警方式为日志服务时，触发的日志服务的配置。

MessageQueue

Array of MQTarget

否

-

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

注意

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

FilterPattern

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

EffectiveTime

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

TLSTargetInfo

参数类型是否必选示例值描述
TopicIdString否6a6****67c7主题ID。
ProjectIdString否79fe****122f项目ID。
ProjectNameString否test项目的名称。
RegionNameCNString否桑园区域的中文名称。
RegionNameENString否cn-guilin-boe区域的英文名称。

MQTarget

参数类型是否必选示例值描述
TypeString否kafka告警通知的方式。
TopicString否testkafka消息队列的Topic。
VpcIdString否vpc-2bzq*****pm22VPC ID。
RegionString否cn-guilin-boeMQ实例region。
PasswordString否-密码。
EndpointsString否-集群地址，仅对rule_engine返回。
InstanceIdString否kafka-cno*****5hcMQ实例ID。
AuthEncryptArray of Integer否-账号密码的密文，仅对rule_engine返回。

返回参数

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

RuleIDVo

参数类型示例值描述
RuleIdString157284163494346****规则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****"
        }
    }
}

错误码

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