ListDataQualityAlertRules - DataWorks - Alibaba Cloud Documentation Center

Queries the list of data quality alert rules in a project.

Operation description

This API operation is available for all DataWorks editions.

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:ListDataQualityAlertRules	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The project ID.	10001
DataQualityScanId	long	No	The ID of the data quality monitor that the alert rule targets.	10001
SortBy	string	No	The list of sorting fields. Supports fields such as last modified time and creation time. Format: "SortField+SortOrder (Desc/Asc)", where Asc is the default. Valid values: CreateTime (Desc/Asc) Id (Desc/Asc)	CreateTime Desc
PageNumber	integer	Yes	The page number of the results.	1
PageSize	integer	Yes	The number of records to return on each page.	10

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	0bc14115***159376359
PageInfo	object	Alert rule configurations.
TotalCount	integer	The total number of entries returned.	335
PageNumber	integer	The current page number.	1
PageSize	integer	The number of records per page.	10
DataQualityAlertRules	array<object>	The list of alert rule configurations.
DataQualityAlertRule	object	Alert rule configurations.
Condition	string	The alert conditions.	results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
Target	object	Monitored targets of the data quality alert rule.
Type	string	The type of the monitored target. Only DataQualityScan is supported.	DataQualityScan
Ids	array	The list of monitored target IDs
Id	long	The ID of the monitored target.	7638999336
ProjectId	long	The project ID.	59094
Id	long	The ID of the data quality monitor alert rule.	26433
Notification	object	Alert notification configurations.
Receivers	array<object>	The alert recipients.
Receiver	object	The alert recipients.
Extension	string	Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.	{"atAll":true}
ReceiverType	string	The type of alert recipients. ShiftSchedule WebhookUrl FeishuUrl TaskOwner WeixinUrl DingdingUrl DataQualityScanOwner AliUid	AliUid
ReceiverValues	array	The value of alert recipients.
ReceiverValue	string	The value of alert recipients. If ReceiverType is AliUid, enter the Alibaba Cloud account ID. If ReceiverType is ShiftSchedule, enter the shift schedule ID. If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.	https://oapi.dingtalk.com/robot/send?access_token=a30bae7******
Channels	array	In Channels, you can set both Email and Sms at the same time. In other cases, only one channel can be set.
Channel	string	Alert channels. Mail Weixin Feishu Phone Sms Webhook	Sms

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 335,
    "PageNumber": 1,
    "PageSize": 10,
    "DataQualityAlertRules": [
      {
        "Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
        "Target": {
          "Type": "DataQualityScan",
          "Ids": [
            7638999336
          ]
        },
        "ProjectId": 59094,
        "Id": 26433,
        "Notification": {
          "Receivers": [
            {
              "Extension": {
                "atAll": true
              },
              "ReceiverType": "AliUid",
              "ReceiverValues": [
                "https://oapi.dingtalk.com/robot/send?access_token=a30bae7******"
              ]
            }
          ],
          "Channels": [
            "Sms"
          ]
        }
      }
    ]
  }
}

Error codes

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