调用UpdateEventRule接口更新事件规则的内容。
ServiceName : Volc_Observe Region : cn-beijing AccessKey : xxx SecretKey : xxx
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateEventRule | 接口名称。当前 API 的名称为 UpdateEventRule。 |
| Version | String | 是 | 2018-01-01 | 接口版本。当前 API 的版本为 2018-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| 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 of String | 是 | [ "ecs:Disk:DiskError.Redeploy.Executing", "ecs:Disk:DiskError.Redeploy.Inquiring", "ecs:Disk:DiskError.Redeploy.Succeeded" ] | 事件类型。 |
Status | String | 否 |
| 规则状态。
|
Level | String | 是 |
| 告警规则的严重程度。
|
FilterPattern | JSON Map | 否 |
| 过滤模式，也叫事件匹配规则。 |
| EffectiveTime | Object of EffectiveTime | 是 | - | 规则生效时间，规则只会在这段时间内生效。 |
ContactMethods | Array of String | 是 |
| 告警通知方式。
|
| ContactGroupIds | Array of String | 否 | [ "157284********69152" ] | 告警通知组ID列表。当AlertMethods参数为Email，Phone，SMS时，ContactGroupIds参数不能为空。 |
| Endpoint | String | 否 | http://example.com/alert | 告警通知方式为告警回调时，触发的回调地址。 |
| TLSTarget | Array of TLSTargetInfo | 否 | - | 告警方式为日志服务时，触发的日志服务的配置。 |
| MessageQueue | Array of MQTarget | 否 | - | 告警通知方式为消息队列kafka时，触发的消息队列。 |
| WebhookIds | Array of String | 否 | - | 告警回调ID列表。WebhookIds和Endpoint参数二选一，不能同步填写。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| key | String | 是 | Source | 模式匹配中的key。 |
| value | Any | 是 | ecs | 模式匹配中的key的取值。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| StartTime | String | 否 | 09:00 | 规则启用的开始时间。 |
| EndTime | String | 否 | 20:59 | 规则启用的结束时间。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| TopicId | String | 否 | 6a6****67c7 | 主题ID。 |
| ProjectId | String | 否 | 79fe****122f | 项目ID。 |
| ProjectName | String | 否 | test | 项目的名称。 |
| RegionNameCN | String | 否 | 桑园 | 区域的中文名称。 |
| RegionNameEN | String | 否 | cn-guilin-boe | 区域的英文名称。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| 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 | - | 事件规则返回内容。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RuleId | String | 157284163494346**** | 规则ID。 |
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" }
{ "Result": { "Data": { "RuleId": "15847********688768" } }, "ResponseMetadata": { "Action": "UpdateEventRule", "Region": "cn-beijing", "Service": "Volc_Observe", "Version": "2018-01-01", "RequestId": "20230604110420****100232280022D31" } }
本接口无特有的错误码。更多信息请参见错误码。