ListDIAlarmRules - DataWorks - Alibaba Cloud Documentation Center

Queries a list of alert rules configured for a new-version synchronization task. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres.

Operation description

You can configure alert rules only for tasks that can be used for real-time data synchronization.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:*	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DIJobId	long	Yes	The ID of the task with which the alert rules are associated.	11260
PageNumber	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	74C2FECD-5B3A-554A-BCF5-351A36DE9815
DIAlarmRulePaging	object	The pagination information.
TotalCount	long	The total number of entries returned.	2
PageNumber	long	The page number.	1
PageSize	long	The number of entries per page.	10
DIJobAlarmRules	array<object>	The alert rules.
DIJobAlarmRule	object	The details of the alert rule.
DIAlarmRuleId	long	The alert rule ID.	41998
DIJobId	long	The ID of the task with which the alert rule is associated.	11260
Description	string	The description of the alert rule.	mysql synchronizes to hologres heartbeat alert
MetricType	string	The metric type in the alert rule. Valid values: Heartbeat FailoverCount Delay	Heartbeat
Enabled	boolean	Indicates whether the alert rule is enabled.	true
TriggerConditions	array<object>	The conditions that are used to trigger the alert rule.
TriggerCondition	object	The condition that is used to trigger the alert rule.
Severity	string	The severity level. Valid values: Warning Critical	Warning
Duration	long	The time interval for alert calculation. Unit: minutes.	15
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
NotificationSettings	object	The alert notification settings.
NotificationChannels	array<object>	The alert notification methods.
NotificationChannel	object	The alert notification method.
Severity	string	The severity level. Valid values: Warning Critical	Warning
Channels	array	The alert notification methods.
Channel	string	The alert notification method. Valid values: Mail: email Phone: phone call Sms: text message Ding: DingTalk chatbot token	Ding
NotificationReceivers	array<object>	The settings of alert notification recipients.
NotificationReceiver	object	The setting of an alert notification recipient.
ReceiverType	string	The recipient type. Valid values: AliyunUid and DingToken. If the alert notification method is Mail, Phone, or Sms, the value of this parameter is AliyunUid, which indicates the Alibaba Cloud account ID. If the alert notification method is Ding, the value of this parameter is DingToken, which indicates the DingTalk chatbot token.	DingToken
ReceiverValues	array	The recipients.
ReceiverValue	string	The recipient. If the recipient type is Alibaba Cloud account ID, the value of this parameter is the Alibaba Cloud account ID of a user. If the recipient type is DingTalk chatbot token, the value of this parameter is the token of a DingTalk chatbot.	token1
InhibitionInterval	integer	The duration of the alert suppression interval. Unit: minutes.	5

Examples

Sample success responses

JSONformat

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-351A36DE9815",
  "DIAlarmRulePaging": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 41998,
        "DIJobId": 11260,
        "Description": "mysql synchronizes to hologres heartbeat alert",
        "MetricType": "Heartbeat",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Warning",
            "Duration": 15,
            "Threshold": 5
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Warning",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "InhibitionInterval": 5
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.	-
429	Throttling.System	The DataWorks system is busy. Try again later.	-
429	Throttling.User	Your request is too frequent. Try again later.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

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

Change history

Change time	Summary of changes	Operation

No change history