Queries event-triggered alert rules.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeEventRuleList |
The operation that you want to perform. Set the value to DescribeEventRuleList. |
GroupId | String | No | 12345 |
The ID of the application group. |
NamePrefix | String | No | test |
The name prefix of the event-triggered alert rule. Fuzzy search is supported. |
PageNumber | String | No | 1 |
The number of the page to return. Default value: 1. |
PageSize | String | No | 10 |
The number of entries to return on each page. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | 200 |
The HTTP status code. The status code 200 indicates that the call was successful. |
EventRules | N/A | N/A |
The event-triggered alert rules. |
Description | String | event |
The description of the event-triggered alert rule. |
EventPattern | N/A | N/A |
The trigger condition of the event. |
EventTypeList | N/A | Exception |
The type of the event. |
LevelList | N/A | ["CRITICAL", "WARN", "INFO"] |
The level of the alert. Valid values: CRITICAL WARN INFO |
NameList | N/A | ["Agent_Status_Stopped"] |
The name of the event. |
Product | String | CloudMonitor |
The abbreviation of the service name. |
EventType | String | SYSTEM |
The type of the event. Valid values: SYSTEM and CUSTOM. |
GroupId | String | 12345 |
The ID of the application group. |
Name | String | evnetName |
The name of the event-triggered alert rule. |
State | String | ENABLED |
The status of the event-triggered alert rule. Valid values: ENABLED and DISABLED. |
Message | String | success |
The returned message. |
RequestId | String | D0E6D82B-16B5-422A-8136-EE5BDC01E415 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful. |
Total | Integer | 21 |
The total number of entries returned. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeEventRuleList
&<Common request parameters>
Sample success responses
XML
format
<DescribeEventRuleListResponse>
<Datapoints>
<EventRule>
<Name>aaabbb</Name>
<State>ENABLED</State>
<EventPattern>
<EventTypeList>
<EventTypeList>Exception</EventTypeList>
</EventTypeList>
<Product>CloudMonitor</Product>
<LevelList>
<LevelList>*</LevelList>
</LevelList>
<NameList>
<NameList>Alert_SendShortMessageFailed_QuotaReached</NameList>
<NameList>Group_AddResourcesFailed_QuotaReached</NameList>
<NameList>Agent_Status_Stopped</NameList>
<NameList>Agent_Status_Running</NameList>
</NameList>
</EventPattern>
<EventType>SYSTEM</EventType>
</EventRule>
<EventRule>
<Name>default_group_event_rule_3384581</Name>
<Description>Default group event rule</Description>
<State>ENABLED</State>
<EventPattern>
<Product>*</Product>
<LevelList>
<LevelList>CRITICAL</LevelList>
<LevelList>WARN</LevelList>
</LevelList>
<NameList>
<NameList>*</NameList>
</NameList>
</EventPattern>
<EventType>SYSTEM</EventType>
<GroupId>338****</GroupId>
</EventRule>
</Datapoints>
<RequestId>D0E6D82B-16B5-422A-8136-EE5BDC01E415</RequestId>
<Success>true</Success>
<Code>200</Code>
<Total>20</Total>
</DescribeEventRuleListResponse>
JSON
format
{
"Datapoints":{
"EventRule":[
{
"Name":"aaabbb",
"State":"ENABLED",
"EventPattern":{
"EventTypeList":{
"EventTypeList":[
"Exception"
]
},
"Product":"CloudMonitor",
"LevelList":{
"LevelList":[
"*"
]
},
"NameList":{
"NameList":[
"Alert_SendShortMessageFailed_QuotaReached",
"Group_AddResourcesFailed_QuotaReached",
"Agent_Status_Stopped",
"Agent_Status_Running"
]
}
},
"EventType":"SYSTEM"
},
{
"Name":"default_group_event_rule_3384581",
"Description":"Default group event rule",
"State":"ENABLED",
"EventPattern":{
"Product":"*",
"LevelList":{
"LevelList":[
"CRITICAL",
"WARN"
]
},
"NameList":{
"NameList":[
"*"
]
}
},
"EventType":"SYSTEM",
"GroupId":"338****"
}
]
},
"RequestId":"D0E6D82B-16B5-422A-8136-EE5BDC01E415",
"Success":true,
"Code":"200",
"Total":20
}
Error codes
For a list of error codes, visit the API Error Center.