GetDataQualityAlertRule - 获取数据质量告警规则_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

根据告警规则ID查询对应的数据质量监控告警规则详情。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:GetDataQualityAlertRule	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Id	long	否	数据质量监控告警规则 ID。	113642

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	0bc14115****159376359
DataQualityAlertRule	object	数据质量监控告警规则。
Id	long	数据质量监控告警规则 ID。	21045
Condition	string	数据质量监控告警规则告警条件。	results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
ProjectId	long	项目 ID。	90912
Target	object	数据质量监控告警规则关注目标。
Type	string	监控对象的类型，只支持 `DataQualityScan`。	DataQualityScan
Ids	array	监控目标 ID 列表。
Id	long	监控对象 ID。	113647
Notification	object	告警通知配置。
Channels	array	Channels 中，除可以同时设置 Email 和 Sms 外，其他的情况都只能设置一种渠道。
Channel	string	告警通道。 Dingding Mail Weixin Feishu Phone Sms Webhook	Dingding
Receivers	array<object>	告警接收对象。
Receiver	object	告警接收对象。
Extension	string	告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 `{"atAll":true}` @所有人。	{"atAll":true}
ReceiverType	string	告警接收对象类型。 ShiftSchedule WebhookUrl FeishuUrl TaskOwner WeixinUrl DingdingUrl DataQualityScanOwner AliUid	TaskOwner
ReceiverValues	array	告警接收对象值。
ReceiverValue	string	告警接收对象值。当 ReceiverType 为 AliUid 时填阿里云 UID 当 ReceiverType 为 ShiftSchedule 时填值班表 ID 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。	https://oapi.dingtalk.com/robot/send?access_token=a30bae7******

示例

正常返回示例

JSON格式

{
  "RequestId": "0bc14115****159376359",
  "DataQualityAlertRule": {
    "Id": 21045,
    "Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
    "ProjectId": 90912,
    "Target": {
      "Type": "DataQualityScan",
      "Ids": [
        113647
      ]
    },
    "Notification": {
      "Channels": [
        "Dingding"
      ],
      "Receivers": [
        {
          "Extension": {
            "atAll": true
          },
          "ReceiverType": "TaskOwner",
          "ReceiverValues": [
            "https://oapi.dingtalk.com/robot/send?access_token=a30bae7******"
          ]
        }
      ]
    }
  }
}

错误码

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