Docs

Cloud Monitor

Event rule

ListEventRules

Query event rules.

Considerations

This API involves multiple downstream dependencies. Frequent calls will trigger rate limiting. We recommend keeping QPS not higher than 20 for this API.

Request descriptions

Request method: POST

Request URL: https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListEventRules&Version=2018-01-01

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request descriptions

Parameters	Type	Required	Sample value	Description
Action	String	Yes	ListEventRules	The name of the API. The API name is ListEventRules.
Version	String	Yes	2018-01-01	The API version. The API version is 2018-01-01.
RuleName	String	No	rule-01	Event rule name. Fuzzy search by name is applied. The name must be 1 to 128 characters in length. It cannot start with a digit or hyphen (-).
Source	Array of String	No	ecs	Event source.
Status	Array of String	No	enable	Rule status. enable: The rule is enabled. disable: The rule is disabled.
PageSize	Integer	No	30	The number of rows per page for a pagination query. Default value: 30.
PageNumber	Integer	No	1	The page number for a pagination query. Default value: 1. Actual start position = (PageNumber-1) * PageSize Actual end position = PageNumber * PageSize
OrderBy	String	No	UpdatedAt	Rule sorting field. UpdatedAt: (Default) Sorted by rule modification time. RuleName: Sorted by rule name. CreatedAt: Sorted by rule creation time.
Asc	Boolean	No	false	Rule sorting order. true: Ascending order false: Descending order

Sample request

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​
}​

Response parameters

Parameters	Type	Sample value	Description
Asc	Boolean	false	Sorting order of the returned event rules.
Data	Array of Rule	-	Details about rules that meet the criteria.
OrderBy	String	HappenTime	The sorting condition.
TotalCount	Integer	2	Total number of event rules that meet the criteria.

Rule

Parameters	Type	Sample value	Description
RuleId	String	168*****4352	Event rule ID.
Source	String	vke	Event source.
RuleName	String	test-kafka	Rule name.
Description	String	This is test rule 01	Rule description.
EventBusName	String	default	Event bus name. Only default is supported.
AccountId	String	210****168	Volcano Engine root user ID.
Region	String	cn-beijign	The region.
Level	String	critical	Severity level of the alert.
EnableState	String	enable	Rule status. enable: The rule is enabled. disable: The rule is disabled.
EffectStartAt	String	12:00	The start of the time period during which the rule is active.
EffectEndAt	String	20:00	The end of the time period during which the rule is active.
EventType	Array of String	["vke:Addon:AddonStatus.Failed"]	Event type.
FilterPattern	JSON Map	-	Filter pattern, also known as an event matching rule. Custom matching rules are not supported.
ContactMethods	Array of String	[ "Webhook", "Email", "MQ", "SMS" ]	Alert notification method. Phone: Phone Email: Email SMS: SMS Webhook: Alert callback TLS: TLS MQ: Message Queue for Kafka
Endpoint	String	http://example.com/alert	The callback address when the alert notification method is alert callback.
TLSTarget	Array of TLSTarget	-	TLS configuration. This is triggered when TLS is the alert method.
ContactGroupIds	Array of String	["166*****7680"]	A list of alert contact group IDs. When the ContactMethods parameter is Email, Phone, or SMS, this parameter cannot be empty.
MessageQueue	Array of MQTarget	-	The message queue used when the alert notification method is Message Queue for Kafka.
UpdatedAt	Integer	1666686791	Update time of the event rule.
CreatedAt	Integer	1666668613	Creation time of the event rule.
WebhookIds	Array of String	-	A list of alert callback IDs.
NotifyTemplates	Array of NotifyTemplateBasic	-	Notification template configuration.

FilterPattern

Parameters	Type	Sample value	Description
key	String	"Type": [ "vke:Addon:AddonStatus.Failed" ]	A list of event types for pattern matching. Any matching is supported.
value	Any	"Source": "vke"	Event source in pattern matching.

TLSTarget

Parameters	Type	Sample value	Description
TopicId	String	6a6****67c7	Topic ID.
ProjectId	String	79fe****122f	Project ID.
ProjectName	String	default	The project name.
RegionNameCN	String	Beijing	Chinese name of the region.
RegionNameEN	String	cn-beijing	Region name in English.

MQTarget

Parameters	Type	Sample value	Description
Type	String	kafka	Alert notification method.
Topic	String	testkafka	Topic of the message queue.
VpcId	String	vpc-2bzq*****pm22	VPC ID.
Region	String	cn-beijing	Region where the MQ instance is located.
Password	String	-	MQ instance password.
Endpoints	String	-	Cluster address, which is only returned for rule_engine.
InstanceId	String	kafka-cno*****5hc	MQ instance ID.
AuthEncrypt	Array of Integer	-	Encrypted account password, which is only returned for rule_engine.

NotifyTemplateBasic

Parameters	Type	Sample value	Description
Channel	String	email	Notification channel. Values: email: Email sms: SMS phone: Phone lark: Feishu dingtalk: DingTalk wecom: WeCom slack：Slack api: Callback address
NotifyTemplateId	String	189828***00	Notification template ID. warning Only one notification template ID can be specified for each notification channel.

Sample response

{​
    "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​
    }​
}​

Error code

There are no error codes specific to this API. For more information, see Error codes.

Last updated: 2026.03.27 11:34:32