用于在指定项目中创建数据质量监控告警规则。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectId | long | 是 | 项目 ID。 | 10001 |
Condition | string | 是 | 数据质量监控告警规则告警条件。 | results.any { r -> r.status == 'fail' && r.rule.severity == 'High' } |
Target | object | 是 | 数据质量监控告警规则关注目标。 | |
Type | string | 是 | 监控对象的类型,只支持 DataQualityScan。 | DataQualityScan |
Ids | array | 是 | 监控目标 ID 列表,目前只支持设置一个。 | |
long | 是 | 监控目标 ID。 | 113646 | |
Notification | object | 是 | 告警渠道列表。 | |
Channels | array | 是 | 渠道列表,除了可以同时设置 | |
string | 是 | 告警通道。
| Sms | |
Receivers | array<object> | 是 | 告警接收对象。 | |
object | 是 | 告警接收对象。 | ||
Extension | string | 否 | 告警对象需要的额外配置,当 ReceiverType 为 DingdingUrl,支持设置 | {"atAll":true} |
ReceiverType | string | 是 | 告警接收对象类型。
| TaskOwner |
ReceiverValues | array | 否 | 告警接收对象值。 | |
string | 否 | 告警接收对象值。
| https://oapi.dingtalk.com/robot/send?access_token=a30bae7****** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0bc14115***159376359",
"Id": 1010543619
}
错误码
访问错误中心查看更多错误码。