ListAlertRules - DataWorks - Alibaba Cloud Documentation Center

Queries a list of custom monitoring alert rules.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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.
	long	No	The ID of the scheduling task.	1234
Types	array	No	The alert triggering condition.
	string	No	The alert type. Valid values: Finished: An instance is successfully run. UnFinished: An instance does not finish running before a specified point in time. Error: An error occurs on an instance. CycleUnfinished: An instance does not finish running as expected within a specific cycle. Timeout: An instance times out. InstanceTransferComplete: An instance is generated by the auto triggered node. InstanceTransferFluctuate: The number of generated instances fluctuates. ExhaustedError: An error persists after an instance is automatically rerun. InstanceKeyword: An instance with errors contains specified keywords. InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold. InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold. ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold. ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.	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	long	Yes	The number of entries per page. Maximum value: 100.	10

Response parameters

Parameter	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.
AlertRules	object
Id	long	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: Finished: An instance is successfully run. UnFinished: An instance does not finish running before a specified point in time. Error: An error occurs on an instance. CycleUnfinished: An instance does not finish running as expected within a specific cycle. Timeout: An instance times out. InstanceTransferComplete: An instance is generated by the auto triggered node. InstanceTransferFluctuate: The number of generated instances fluctuates. ExhaustedError: An error persists after an instance is automatically rerun. InstanceKeyword: An instance with errors contains specified keywords. InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold. InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold. ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold. ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.	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.
StreamTaskIds	long	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.
CycleAndTime	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: the absolute value. The number of instances increases or decreases. increase: The number of instances increases. decrease: The number of instances decreases.	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: node Baseline: baseline Project: workspace BizProcess: workflow	Task
Ids	array	The IDs of monitored objects.
Ids	long	The ID of the monitored object.	32567
AllowTasks	array	The nodes that are not to be monitored.
AllowTasks	long	The ID of the node that is not to be monitored.	123123

Examples

Sample success responses

JSONformat

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D9380485D946",
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-12-27	The response structure of the API has changed	View Change Details