更新事件规则的内容。 ## 请求说明 * 请求方式：POST * 请求地址：https://cloudmonitor.cn\-beijing.volcengineapi.com?Action=UpdateEventRule&Version=2018\-01\-01 ## 调试 ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |UpdateEventRule |接口名称。当前 API 的名称为 `UpdateEventRule`。 | |Version |String |是 |2018\-01\-01 |接口版本。当前 API 的版本为 `2018-01-01`。 | |RuleId |String |是 |15847\*\*\*\*\*\*\*\*688768 |事件规则 ID。 | |RuleName |String |否 |rule\-01 |事件规则名称。|\ | | | | ||\ | | | | |* 长度限制在 1～128 字符之间。|\ | | | | |* 不能以数字、中划线`-`开头。 | |Description |String |否 |This is test rule 01 after updating |事件规则描述。|\ | | | | ||\ | | | | |* 不能以数字、中划线`-`、中文符号开头。|\ | | | | |* 只能包含中文，字母，数字，下划线`_`，中划线`-`、中文符号。|\ | | | | |* 长度限制在 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 |是 |notice |告警规则的严重程度。|\ | | | | ||\ | | | | |* **notice**：通知|\ | | | | |* **warning**：警告|\ | | | | |* **critical**：严重 | |FilterPattern |JSON Map |否 |\- |过滤模式，也叫事件匹配规则。|\ | | | | |暂时不支持自定义匹配规则。 | |EffectiveTime |Object of [EffectiveTime](#effectivetime) |是 |\- |规则生效时间，规则只会在这段时间内生效。 | |ContactMethods |Array of String |是 |[ "Webhook", "Email", "SMS" ] |告警通知方式。|\ | | | | ||\ | | | | |* **Phone**：电话|\ | | | | |* **Email**：邮件|\ | | | | |* **SMS**：短信|\ | | | | |* **Webhook**：告警回调|\ | | | | |* **TLS**：日志服务|\ | | | | |* **MQ**：消息队列 Kafka | |ContactGroupIds |Array of String |否 |[ "157284\*\*\*\*\*\*\*\*69152" ] |告警通知组 ID 列表。当`ContactMethods`参数为`Email`，`Phone`，`SMS`时，不能为空。 | |Endpoint |String |否 |http://example.com/alert |当`ContactMethods`参数为`webhook`时，触发的回调地址。|\ | | | | |:::warning|\ | | | | |`WebhookIds`和`Endpoint`参数只能二选一，不能同步配置。|\ | | | | ||\ | | | | |:::| |TLSTarget |Array of [TLSTarget](#tlstarget) |否 |\- |当`ContactMethods`参数为`TLS`时，触发的日志服务的配置。 | |MessageQueue |Array of [MQTarget](#mqtarget) |否 |\- |当`ContactMethods`参数为`MQ`时，触发的消息队列。 | |WebhookIds |Array of String |否 |\- |告警回调 ID 列表。|\ | | | | |:::warning|\ | | | | |`WebhookIds`和`Endpoint`参数只能二选一，不能同步配置。|\ | | | | ||\ | | | | |:::| |NotifyTemplates |Array of [NotifyTemplateBasic](#notifytemplatebasic) |否 |\- |通知模版配置。|\ | | | | |:::tip|\ | | | | |事件为订阅制，一个事件可以匹配多个事件规则，每个事件规则又可以配置不同的发送渠道。因此，当不同事件规则中的联系人有重复时，事件规则按照 **级别（倒序）+更新时间（倒序）** 进行排序，并使用第一个事件规则的 **级别+通知模板**发送事件通知。|\ | | | | ||\ | | | | |:::| ### 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。|\ | | | | |:::warning|\ | | | | |每种通知渠道仅支持配置 1 个通知模版 ID。|\ | | | | ||\ | | | | |:::| ## 请求示例 ```json POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=UpdateEventRule&Version=2018-01-01 Content-Type: application/json { "RuleId": "15847********688768", "RuleName": "rule-01", "Status": "enable", "ContactGroupIds": [ "157284********69152" ], "ContactMethods": [ "Webhook", "Email", "SMS" ], "Description": "This is test rule 01 after updating", "EffectiveTime": { "EndTime": "20:59", "StartTime": "09:00" }, "Endpoint": "http://example.com/alert", "EventBusName": "default", "EventSource": "ecs", "EventType": [ "ecs:Disk:DiskError.Redeploy.Executing", "ecs:Disk:DiskError.Redeploy.Inquiring", "ecs:Disk:DiskError.Redeploy.Succeeded" ], "FilterPattern": {}, "Level": "notice", "MessageQueue": [ { "Type": "kafka", "Topic": "testkafka", "VpcId": "vpc-2bzq*****pm22", "Region": "cn-guilin-boe", "Password": "-", "Endpoints": "-", "InstanceId": "kafka-cno*****5hc", "AuthEncrypt": [ null ] } ], "TLSTarget": [ { "TopicId": "6a6****67c7", "ProjectId": "79fe****122f", "ProjectName": "default", "RegionNameCN": "北京", "RegionNameEN": "cn-beijing" } ], "WebhookIds": [ "" ], "NotifyTemplates": [ { "Channel": "email", "NotifyTemplateId": "189828***00" } ] } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Data |Object of [RuleIDVo](#ruleidvo) |\- |事件规则返回内容。 | ### RuleIDVo |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |RuleId |String |157284163494346\*\*\*\* |事件规则 ID。 | ## 返回示例 ```json { "ResponseMetadata": { "Action": "UpdateEventRule", "Region": "cn-beijing", "Service": "cloudmonitor", "Version": "2018-01-01", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Data": { "RuleId": "157284163494346****" } } } ``` ## 错误码本接口无特有的错误码，更多信息请参见 [错误码](https://www.volcengine.com/docs/6408/78947)。

云监控