ListDataQualityAlertRules - DataWorks - Alibaba Cloud Documentation Center

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

Operation description

DataWorks Basic Edition or a higher edition is required.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListDataQualityAlertRules

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The project ID.	10001
DataQualityScanId	integer	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 elements

Element	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.
	array<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
	integer	The ID of the monitored target.	7638999336
ProjectId	integer	The project ID.	59094
Id	integer	The ID of the data quality monitor alert rule.	26433
Notification	object	Alert notification configurations.
Receivers	array<object>	The alert recipients.
	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.
	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.
	string	Alert channels. Mail Weixin Feishu Phone Sms Webhook	Sms

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.