CreateDataQualityAlertRule - 创建数据质量告警规则

用于在指定项目中创建数据质量监控告警规则。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectIdlong

项目 ID。

10001
Conditionstring

数据质量监控告警规则告警条件。

results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
Targetobject

数据质量监控告警规则关注目标。

Typestring

监控对象的类型,只支持 DataQualityScan。

DataQualityScan
Idsarray

监控目标 ID 列表,目前只支持设置一个。

long

监控目标 ID。

113646
Notificationobject

告警渠道列表。

Channelsarray

渠道列表,除了可以同时设置 EmailSms 外,其他的情况都只能设置一种渠道。

string

告警通道。

  • Dingding
  • Weixin
  • Mail
  • Sms
  • Phone
  • Webhook
  • Feishu
Sms
Receiversarray<object>

告警接收对象。

object

告警接收对象。

Extensionstring

告警对象需要的额外配置,当 ReceiverType 为 DingdingUrl,支持设置{"atAll":true}@所有人。

{"atAll":true}
ReceiverTypestring

告警接收对象类型。

  • AliUid
  • WebhookUrl
  • DingdingUrl
  • WeixinUrl
  • FeishuUrl
  • TaskOwner
  • DataQualityScanOwner
  • ShiftSchedule
TaskOwner
ReceiverValuesarray

告警接收对象值。

string

告警接收对象值。

  • 当 ReceiverType 为 AliUid 时填阿里云 UID
  • 当 ReceiverType 为 ShiftSchedule 时填值班表 ID
  • 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。
https://oapi.dingtalk.com/robot/send?access_token=a30bae7******

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

0bc14115***159376359
Idlong

创建自定义监控规则成功后,返回的自定义规则 ID。

1010543619

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。