查询事件规则的信息。 ## 注意事项该接口调用服务方较多，不建议高频调用，否则将触发限流。建议 QPS 值不大于 20。 ## 请求说明 * 请求方式：POST * 请求地址：https://cloudmonitor.cn\-beijing.volcengineapi.com?Action=ListEventRules&Version=2018\-01\-01 ## 调试 ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |ListEventRules |接口名称。当前 API 的名称为 `ListEventRules`。 | |Version |String |是 |2018\-01\-01 |接口版本。当前 API 的版本为 `2018-01-01`。 | |RuleName |String |否 |rule\-01 |事件规则名称，按照名称模糊搜索规则。|\ | | | | ||\ | | | | |* 长度限制在 1～128 字符之间。|\ | | | | |* 不能以数字、中划线`-`开头。 | |Source |Array of String |否 |ecs |事件源。 | |Status |Array of String |否 |enable |规则状态。|\ | | | | ||\ | | | | |* **enable**：启用规则|\ | | | | |* **disable**：禁用规则 | |PageSize |Integer |否 |30 |分页查询参数，用于设置每页行数。默认值：30。 | |PageNumber |Integer |否 |1 |分页查询参数，用于设置当前页码。默认值：1。|\ | | | | ||\ | | | | |* 实际起始位置 = (PageNumber\-1) \* PageSize|\ | | | | |* 实际终止位置 = PageNumber \* PageSize | |OrderBy |String |否 |UpdatedAt |规则排列依据。|\ | | | | ||\ | | | | |* **UpdatedAt**：（默认）按照规则的修改时间排列。|\ | | | | |* **RuleName**：按照规则名称排序。|\ | | | | |* **CreatedAt**：按照规则创建事件排列。 | |Asc |Boolean |否 |false |规则排序方式。|\ | | | | ||\ | | | | |* **true**：升序|\ | | | | |* **false**：降序 | ## 请求示例 ```json POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListEventRules&Version=2018-01-01 Content-Type: application/json { "RuleName": "rule-01", "Asc": false, "OrderBy": "UpdatedAt", "Source": [ "ecs" ], "Status": [ "enable" ], "PageNumber": 1, "PageSize": 30 } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Asc |Boolean |false |返回规则的排序方式。 | |Data |Array of [Rule](#rule) |\- |符合条件的规则详细信息。 | |OrderBy |String |HappenTime |返回规则的排序依据。 | |TotalCount |Integer |2 |符合条件的事件规则总数。 | ### Rule |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |RuleId |String |168\*\*\*\*\*4352 |事件规则 ID。 | |Source |String |vke |事件源。 | |RuleName |String |test\-kafka |规则名称。 | |Description |String |This is test rule 01 |规则描述。 | |EventBusName |String |default |事件总线名称，目前仅支持填写为`default`。 | |AccountId |String |210\*\*\*\*168 |火山引擎账号 ID。 | |Region |String |cn\-beijign |地域。 | |Level |String |critical |告警规则的严重程度。 | |EnableState |String |enable |规则状态。|\ | | | ||\ | | | |* **enable**：规则启用|\ | | | |* **disable**：规则禁用 | |EffectStartAt |String |12:00 |规则启用的开始时间。 | |EffectEndAt |String |20:00 |规则启用的结束时间。 | |EventType |Array of String |["vke:Addon:AddonStatus.Failed"] |事件类型。 | |FilterPattern |JSON Map |\- |过滤模式，也叫事件匹配规则。|\ | | | |暂时不支持自定义匹配规则。 | |ContactMethods |Array of String |[ "Webhook",|告警通知方式。|\ | | |"Email",||\ | | |"MQ",|* **Phone**：电话|\ | | |"SMS" ] |* **Email**：邮件|\ | | | |* **SMS**：短信|\ | | | |* **Webhook**：告警回调|\ | | | |* **TLS**：日志服务|\ | | | |* **MQ**：消息队列 Kafka | |Endpoint |String |http://example.com/alert |告警通知方式为告警回调时，触发的回调地址。 | |TLSTarget |Array of [TLSTarget](#tlstarget) |\- |告警方式为日志服务时，触发的日志服务的配置。 | |ContactGroupIds |Array of String |["166\*\*\*\*\*7680"] |告警通知组 ID 列表。当`ContactMethods`参数为`Email`，`Phone`，`SMS`时，该参数不能为空。 | |MessageQueue |Array of [MQTarget](#mqtarget) |\- |告警通知方式为消息队列 Kafka 时，触发的消息队列。 | |UpdatedAt |Integer |1666686791 |事件规则更新时间。 | |CreatedAt |Integer |1666668613 |事件规则创建时间。 | |WebhookIds |Array of String |\- |告警回调 ID 列表。 | |==NotifyTemplates== |Array of [NotifyTemplateBasic](#notifytemplatebasic) |\- |通知模版配置。 | ### FilterPattern |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |key |String |"Type": [ "vke:Addon:AddonStatus.Failed" ] |模式匹配中对应的事件类型列表，当前为任意匹配。 | |value |Any |"Source": "vke" |模式匹配中对应的事件源。 | ### 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 { "ResponseMetadata": { "Action": "ListEventRules", "Region": "cn-beijing", "Service": "cloudmonitor", "Version": "2018-01-01", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Data": [ { "Level": "critical", "Region": "cn-beijing", "RuleId": "168*****4352", "Source": "vke", "Endpoint": "http://example.com/alert", "RuleName": "test-kafka", "AccountId": "210****168", "CreatedAt": 1666668613, "UpdatedAt": 1666686791, "EventType": [ "vke:Addon:AddonStatus.Failed" ], "TLSTarget": [ { "TopicId": "6a6****67c7", "ProjectId": "79fe****122f", "ProjectName": "default", "RegionNameCN": "北京", "RegionNameEN": "cn-beijing" } ], "WebhookIds": [ "" ], "NotifyTemplates": [ "Channel": "email", "NotifyTemplateId": "189828***00" ], "Description": "This is test rule 01", "EffectEndAt": "20:00", "EnableState": "enable", "EventBusName": "default", "MessageQueue": [ { "Type": "kafka", "Topic": "testkafka", "VpcId": "vpc-2bzq*****pm22", "Region": "cn-beijing", "Password": "", "Endpoints": "", "InstanceId": "kafka-cno*****5hc", "AuthEncrypt": [ null ] } ], "EffectStartAt": "12:00", "ContactMethods": [ "Webhook", "Email", "MQ", "SMS" ], "ContactGroupIds": [ "166*****7680" ] } ], "PageSize": 30, "PageNumber": 1, "TotalCount": 2 } } ``` ## 错误码本接口无特有的错误码，更多信息请参见 [错误码](https://www.volcengine.com/docs/6408/78947)。

云监控