用于更新指定的数据质量监控告警规则。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Id |
integer |
否 |
告警规则 ID。 |
105412 |
| ProjectId |
integer |
否 |
项目 ID。 |
1000 |
| Condition |
string |
否 |
数据质量监控告警规则告警条件。 |
results.any { r -> r.status == 'fail' && r.rule.severity == 'High' } |
| Target |
object |
否 |
数据质量监控告警规则关注目标。 |
|
| Type |
string |
否 |
监控对象的类型,只支持 DataQualityScan。 |
DataQualityScan |
| Ids |
array |
否 |
监控目标 ID 列表,目前只支持设置一个。 |
|
|
integer |
否 |
监控目标 ID。 |
7638999336 |
|
| Notification |
object |
否 |
告警通知配置。 |
|
| Channels |
array |
是 |
渠道列表,除了可以同时设置 Email 和 Sms 外,其他的情况都只能设置一种渠道。 |
|
|
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****** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。 |
0bc14115***159376359 |
| Success |
boolean |
告警规则是否更新成功。 |
True |
示例
正常返回示例
JSON格式
{
"RequestId": "0bc14115***159376359",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。