You need to enable JavaScript to run this app.
导航

UpdateEventRule

最近更新时间2023.08.16 14:51:57

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

调用UpdateEventRule接口更新事件规则的内容。

注意事项

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

Request URL

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

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

请求参数

参数

类型

是否必填

示例值

说明

RuleId

String

15847********688768

要修改的规则ID。

RuleName

String

rule-01

规则名称。

Description

String

This is test rule 01 after updating

规则描述。

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

notice

告警规则的严重程度。

  • notice:通知
  • warning:警告
  • critical:严重

FilterPattern

Map

-

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

EffectiveTime

Map

-

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

ContactMethods

Array

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

告警通知方式。

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

ContactGroupIds

Array

[ "157284********69152" ]

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

Endpoint

String

http://example.com/alert

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

TLSTarget

Array

[{"RegionNameEN": "cn-guilin-boe",
"RegionNameCN": "桑园",
"ProjectId": "79fe****122f",
"ProjectName": "test",
"TopicId": "6a6****67c7"}]

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

MessageQueue

Array

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

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

FilterPattern请求参数

参数

类型

是否必填

示例值

说明

Type

Array

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

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

Source

String

ecs

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

EffectiveTime请求参数

参数

类型

是否必填

示例值

说明

StartTime

String

12:00

规则启用的开始时间。

EndTime

String

20:00

规则启用的结束时间。

返回参数


请求示例

POST https://open.volcengineapi.com?Action=UpdateEventRule&Version=2018-01-01
ServiceName=Volc_Observe
Region=cn-beijing 
AccessKey=xxx 
SecretKey=xxx 

{
    "RuleId":"15847********688768"
    "RuleName":"rule-01",
    "Description":"This is test rule 01 after updating",
    "EventBusName":"default",
    "EventSource":"ecs",
    "EventType":[
        "ecs:Disk:DiskError.Redeploy.Executing",
        "ecs:Disk:DiskError.Redeploy.Inquiring",
        "ecs:Disk:DiskError.Redeploy.Succeeded"
    ],
    "Status":"enable",
    "Level":"notice",
    "FilterPattern":{
        "Type":[
            "ecs:Disk:DiskError.Redeploy.Executing",
            "ecs:Disk:DiskError.Redeploy.Inquiring",
            "ecs:Disk:DiskError.Redeploy.Succeeded"
        ],
        "Source":"ecs"
    },
    "EffectiveTime":{
        "StartTime":"12:00",
        "EndTime":"20:00"
    },
    "ContactMethods":[
        "Webhook",
        "Email",
        "SMS"
    ],
    "Endpoint":"http://example.com/alert"
}

返回示例