CreateDataQualityAlertRule - DataWorks - Alibaba Cloud Documentation Center

Creates a data quality monitoring alert rule 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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The project ID.	10001
Condition	string	Yes	The alert condition of the data quality monitoring rule.	results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
Target	object	Yes	The monitored target of the data quality monitoring rule.
Type	string	Yes	The type of the monitored target. Only DataQualityScan is supported.	DataQualityScan
Ids	array	Yes	The list of monitored target IDs. Currently, only one ID can be set.
	long	Yes	The ID of the monitored target.	113646
Notification	object	Yes	The list of alert channels.
Channels	array	Yes	The list of alert channels. You can set both `Email` and `Sms` at the same time. In other cases, only one channel can be set.
	string	Yes	Alert channels. Dingding Weixin Mail Sms Phone Webhook Feishu	Sms
Receivers	array<object>	Yes	The alert recipients.
	object	Yes	The alert recipients.
Extension	string	No	Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.	{"atAll":true}
ReceiverType	string	Yes	The type of alert recipients. AliUid WebhookUrl DingdingUrl WeixinUrl FeishuUrl TaskOwner DataQualityScanOwner ShiftSchedule	TaskOwner
ReceiverValues	array	No	The value of alert recipients.
	string	No	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 / WeixinUrl, enter the corresponding URL.	https://oapi.dingtalk.com/robot/send?access_token=a30bae7******

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	0bc14115***159376359
Id	long	The user-defined rule ID returned after the monitoring rule is successfully created.	1010543619

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bc14115***159376359",
  "Id": 1010543619
}

Error codes

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