查询事件规则的信息。
该接口调用服务方较多,不建议高频调用,否则将触发限流。建议QPS值不大于20。
ServiceName : Volc_Observe Region : cn-beijing AccessKey : xxx SecretKey : xxx
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListEventRules | 接口名称。当前 API 的名称为 ListEventRules 。 |
Version | String | 是 | 2018-01-01 | 接口版本。当前 API 的版本为 2018-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RuleName | String | 否 |
| 规则名称,按照名称模糊搜索规则。
|
Source | Array of String | 否 | ecs | 事件源。 |
Status | Array of String | 否 |
| 规则状态。
|
PageSize | Integer | 否 | 30 | 分页查询参数,用于设置每页行数。默认值:30。 |
PageNumber | Integer | 否 |
| 分页查询参数,用于设置当前页码。默认值:1。
|
OrderBy | String | 否 |
| 规则排列依据。
|
Asc | Boolean | 否 |
| 规则排序方式。
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Asc | Boolean | false | 返回规则的排序方式。 |
Data | Array of Rule | - | 符合条件的规则的详细信息。 |
OrderBy | String | HappenTime | 返回规则的排序依据。 |
PageSize | Integer | 30 | 分页查询参数,用于设置每页行数。默认值:30。 |
PageNumber | Integer | 1 | 分页查询参数,用于设置当前页码。默认值:1。 |
TotalCount | Integer | 2 | 符合条件的事件规则总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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-chengdu-sdv | 地域。 |
Level | String | critical | 告警规则的严重程度。 |
EnableState | String |
| 规则状态。
|
EffectStartAt | String | 12:00 | 规则启用的开始时间。 |
EffectEndAt | String | 20:00 | 规则启用的结束时间。 |
EventType | Array of String | ["vke:Addon:AddonStatus.Failed"] | 事件类型。 |
FilterPattern | JSON Map |
| 过滤模式,也叫事件匹配规则。 |
ContactMethods | Array of String |
| 告警通知方式。
|
Endpoint | String | http://example.com/alert | 告警通知方式为告警回调时,触发的回调地址。 |
TLSTarget | Array of TLSTargetInfo | - | 告警方式为日志服务时,触发的日志服务的配置。 |
ContactGroupIds | Array of String |
| 告警通知组ID列表。
|
MessageQueue | Array of MQTarget | - | 告警通知方式为消息队列kafka时,触发的消息队列。 |
UpdatedAt | Integer | 1666686791 | 事件规则更新时间。 |
CreatedAt | Integer | 1666668613 | 事件规则创建时间。 |
WebhookIds | Array of String | - | 告警回调ID列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
key | String | "Type": [ "vke:Addon:AddonStatus.Failed" ] | 模式匹配中对应的事件类型列表,当前为任意匹配。 |
value | Any | "Source": "vke" | 模式匹配中对应的事件源。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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返回。 |
POST https://open.volcengineapi.com?Action=ListEventRules&Version=2018-01-01 ServiceName: Volc_Observe Region: cn-beijing AccessKey: xxx SecretKey: xxx { "RuleName": "rule-01", "OrderBy": "UpdatedAt", "Asc": true, "PageSize": 10, "PageNumber": 1 }
{ "ResponseMetadata": { "RequestId": "2b02*****f3b3", "Action": "ListEventRules", "Version": "2018-01-01" "Region": "cn-chengdu-sdv" }, "Result": { "Data": [ { "RuleId": "168*****4352", "Source": "vke", "RuleName": "test-kafka", "Description":"This is test rule 01", "EventBusName": "default", "AccountId": "210****168", "Region": "cn-chengdu-sdv", "Level": "critical", "EnableState": "enable", "EffectStartAt": "00:00", "EffectEndAt": "23:59", "EventType": [ "vke:Addon:AddonStatus.Failed" ], "FilterPattern": { "Source": "vke", "Type": [ "vke:Addon:AddonStatus.Failed" ] }, "ContactMethods": [ "MQ", "Webhook", "Email", "SMS" ], "ContactGroupIds": [ "166*****7680" ], "Endpoint":"http://example.com/alert", "MessageQueue": [ { "Type": "kafka", "Region": "cn-guilin-boe", "InstanceId": "kafka-cno*****5hc", "Topic": "testkafka", "VpcId": "vpc-2bzq*****pm22" } ], "UpdatedAt": 1691474146, "CreatedAt": 1691474146 } ], "PageNumber": 1, "PageSize": 10, "TotalCount": 1, "OrderBy": "UpdatedAt", "Asc": true } }
本接口无特有的错误码。更多信息请参见错误码。