Queries a list of custom monitoring alert rules.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Owner |
string |
No |
The ID of the Alibaba Cloud account used by the owner of the rule. |
1933790683**** |
| TaskIds |
array |
No |
The IDs of the scheduling tasks. |
|
|
integer |
No |
The ID of the scheduling task. |
1234 |
|
| Types |
array |
No |
The alert triggering condition. |
|
|
string |
No |
The alert type. Valid values:
|
Error |
|
| Receiver |
string |
No |
The ID of the Alibaba Cloud account used by the alert recipient. |
1933790683**** |
| Name |
string |
No |
The name of the rule. |
error_rule |
| PageNumber |
integer |
Yes |
The page number. Pages start from page 1. |
1 |
| PageSize |
integer |
Yes |
The number of entries per page. Maximum value: 100. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
A6C6B486-E3A2-5D52-9E76-D9380485D946 |
| PagingInfo |
object |
The pagination information. |
|
| TotalCount |
integer |
The total number of entries returned. |
5 |
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries per page. |
10 |
| AlertRules |
array<object> |
The rules. |
|
|
array<object> |
|||
| Id |
integer |
The rule ID. |
22125 |
| Name |
string |
The name of the rule. |
error_test |
| Owner |
string |
The ID of the Alibaba Cloud account used by the owner of the rule. |
1933790683**** |
| Enabled |
boolean |
Indicates whether the rule is enabled. |
true |
| TriggerCondition |
object |
The alert triggering condition. |
|
| Type |
string |
The alert type. Valid values:
|
Error |
| Extension |
object |
The extended information about the rule. This parameter is required for specific types of alerts. |
|
| Error |
object |
The configuration for an alert of the Error type. |
|
| StreamTaskIds |
array |
The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks. |
|
|
integer |
The ID of the real-time computing task. |
123 |
|
| AutoRerunAlertEnabled |
boolean |
Indicates whether an alert is triggered if a batch synchronization task is automatically rerun upon a failure. |
false |
| Timeout |
object |
The configuration for an alert of the Timeout type. |
|
| TimeoutInMinutes |
integer |
The timeout period. Unit: minutes. |
10 |
| UnFinished |
object |
The configuration for an alert of the UnFinished type. |
|
| UnFinishedTime |
string |
The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59]. |
12:00 |
| CycleUnfinished |
object |
The configuration for an alert of the CycleUnfinished type. |
|
| CycleAndTime |
array<object> |
The configurations of the scheduling cycle and timeout period of the instance. |
|
|
object |
|||
| CycleId |
integer |
The ID of the scheduling cycle of the instance. Valid values: [1,288]. |
1 |
| Time |
string |
The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59]. |
01:00 |
| InstanceErrorCount |
object |
The configuration for an alert of the InstanceErrorCount type. |
|
| Count |
integer |
The maximum number of instances on which an error occurs. Valid values: [1,10000]. |
10 |
| InstanceErrorPercentage |
object |
The configuration for an alert of the InstanceErrorPercentage type. |
|
| Percentage |
integer |
The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: [1-100]. |
10 |
| InstanceTransferFluctuate |
object |
The configuration for an alert of the InstanceTransferFluctuate type. |
|
| Trend |
string |
The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:
|
abs |
| Percentage |
integer |
The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: [1-100]. |
10 |
| Target |
object |
The monitored objects. |
|
| Type |
string |
The type of the monitored objects. Valid values:
|
Task |
| Ids |
array |
The IDs of monitored objects. |
|
|
integer |
The ID of the monitored object. |
32567 |
|
| AllowTasks |
array |
The nodes that are not to be monitored. |
|
|
integer |
The ID of the node that is not to be monitored. |
123123 |
Examples
Success response
JSON format
{
"RequestId": "A6C6B486-E3A2-5D52-9E76-D938048****",
"PagingInfo": {
"TotalCount": 5,
"PageNumber": 1,
"PageSize": 10,
"AlertRules": [
{
"Id": 22125,
"Name": "error_test",
"Owner": "1933790683****",
"Enabled": true,
"TriggerCondition": {
"Type": "Error",
"Extension": {
"Error": {
"StreamTaskIds": [
123
],
"AutoRerunAlertEnabled": false
},
"Timeout": {
"TimeoutInMinutes": 10
},
"UnFinished": {
"UnFinishedTime": "12:00"
},
"CycleUnfinished": {
"CycleAndTime": [
{
"CycleId": 1,
"Time": "01:00"
}
]
},
"InstanceErrorCount": {
"Count": 10
},
"InstanceErrorPercentage": {
"Percentage": 10
},
"InstanceTransferFluctuate": {
"Trend": "abs",
"Percentage": 10
}
},
"Target": {
"Type": "Task",
"Ids": [
32567
],
"AllowTasks": [
123123
]
}
}
}
]
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.