ListDIAlarmRules - DataWorks - Alibaba Cloud Documentation Center

Views alert rules configured for a synchronization task.

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
JobId	long	No	The ID of the task for which alert rules are configured.	1000001
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
DIAlarmRuleId	long	No	The ID of the alert rule. If you leave this parameter empty, all alert rules of the task are queried.	34988

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	74C2FECD-5B3A-554A-BCF5-351A36DE9815
PagingInfo	object	The pagination information.
TotalCount	long	The total number of entries returned.	90
PageNumber	long	The page number. Pages start from page 1.	1
PageSize	long	The number of entries per page.	10
DIJobAlarmRules	array<object>	The alert rules.
DIJobAlarmRules	object	The details of an alert rule.
Id	long	The ID of the alert rule.	72402
DIJobId	long	The ID of the synchronization task.	32594
Description	string	The description of the alert rule.	rule descrition
MetricType	string	The metric type in the alert rule. Valid values: Heartbeat FailoverCount Delay DdlReport ResourceUtilization	Heartbeat
Name	string	The name of the alert rule.	rule_name
Enabled	boolean	Indicates whether the alert rule is enabled. Valid values: True and False.	True
TriggerConditions	array<object>	The conditions that are used to trigger the alert rule.
TriggerConditions	object	The condition that is used to trigger the alert rule.
Severity	string	The severity level. Valid values: Warning Critical	Critical
Duration	long	The time interval for alert calculation. Unit: minutes.	1
Threshold	long	The alert threshold. If the alert rule is for task status, no threshold is used. If the alert rule is for failovers, the threshold is the number of failovers. If the alert rule is for latency, the threshold is the latency duration, in seconds.	5
DdlTypes	array	The types of DDL operations for which the alert rule takes effect. This parameter is returned only if the MetricType parameter is set to DdlReport.
DdlTypes	string	The type of the DDL operation for which the alert rule takes effect. This parameter is returned only if the MetricType parameter is set to DdlReport. Valid values: AlterAddColumn AlterDropColumn AlterRenameColumn AlterRenameTable AlterTableModify DropTable TruncateTable	ALTERADDCOLUMN
DdlReportTags`deprecated`	array	This parameter is deprecated and replaced by the DdlTypes parameter.
DdlReportTags`deprecated`	string	This parameter is deprecated and replaced by the DdlTypes parameter.	ALTERADDCOLUMN
NotificationSettings	object	The alert notification method and recipient settings.
NotificationChannels	array<object>	The alert notification methods.
NotificationChannels	object	The alert notification method.
Severity	string	The severity level. Valid values: Warning Critical	Critical
Channels	array	The alert notification methods.
Channels	string	The alert notification method. Valid values: Mail Phone Sms Ding	Ding
NotificationReceivers	array<object>	The settings of alert notification recipients.
NotificationReceiver	object	The settings of alert notification recipients.
ReceiverType	string	The recipient type. Valid values: AliyunUid, DingToken, FeishuToken, and WebHookUrl.	DingToken
ReceiverValues	array	The recipient. If the value of the ReceiverType parameter is AliyunUid, the value of this parameter is the Alibaba Cloud account ID of a user. If the value of the ReceiverType parameter is DingToken, the value of this parameter is the token of a DingTalk chatbot.
ReceiverValue	string	The recipient. If the value of the ReceiverType parameter is AliyunUid, the value of this parameter is the Alibaba Cloud account ID of a user. If the value of the ReceiverType parameter is DingToken, the value of this parameter is the token of a DingTalk chatbot.	token1
MuteInterval	long	The duration of the alert suppression interval. Unit: minutes.	5
InhibitionInterval`deprecated`	long	This parameter is deprecated and replaced by the MuteInterval parameter.	5
DIAlarmRuleId`deprecated`	long	This parameter is deprecated. Use the Id parameter instead.	72402

Examples

Sample success responses

JSONformat

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-351A36DE9815",
  "PagingInfo": {
    "TotalCount": 90,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "Id": 72402,
        "DIJobId": 32594,
        "Description": "rule descrition",
        "MetricType": "Heartbeat",
        "Name": "rule_name",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Critical",
            "Duration": 1,
            "Threshold": 5,
            "DdlTypes": [
              "ALTERADDCOLUMN"
            ],
            "DdlReportTags": [
              "ALTERADDCOLUMN"
            ]
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Critical",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "MuteInterval": 5,
          "InhibitionInterval": 5
        },
        "DIAlarmRuleId": 72402
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-01-09	The response structure of the API has changed	View Change Details
2025-01-06	The response structure of the API has changed	View Change Details