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

查询指定项目下的数据质量告警规则列表。

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListDataQualityAlertRules

list

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ProjectId	integer	是	项目 ID。	10001
DataQualityScanId	integer	否	数据质量告警规则关注的数据质量监控 ID。	10001
SortBy	string	否	排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（默认 Asc，可以省略）。排序字段的枚举值如下： CreateTime (Desc/Asc) Id (Desc/Asc)	CreateTime Desc
PageNumber	integer	是	结果分页页码。	1
PageSize	integer	是	结果分页大小。	10

返回参数

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

示例

正常返回示例

JSON格式

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 335,
    "PageNumber": 1,
    "PageSize": 10,
    "DataQualityAlertRules": [
      {
        "Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
        "Target": {
          "Type": "DataQualityScan",
          "Ids": [
            7638999336
          ]
        },
        "ProjectId": 59094,
        "Id": 26433,
        "Notification": {
          "Receivers": [
            {
              "Extension": "{\"atAll\":true}",
              "ReceiverType": "AliUid",
              "ReceiverValues": [
                "https://oapi.dingtalk.com/robot/send?access_token=a30bae7******"
              ]
            }
          ],
          "Channels": [
            "Sms"
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。