ListDataQualityEvaluationTasks - 查询质量监控任务列表_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

质量监控任务列表分页查询。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ProjectId	long	否	DataWorks 工作空间 ID	100
TableGuid	string	否	表在数据地图中的唯一 ID	odps.unit_test.tb_unit_test
Name	string	否	模糊匹配数据质量校验任务名称	测试
PageSize	integer	否	列表分页查询页大小，默认为 10	10
PageNumber	integer	否	列表分页查询页码，默认为 1	1

返回参数

名称	类型	描述	示例值
	object	返回值
RequestId	string	API 请求 ID	691CA452-D37A-4ED0-9441
PagingInfo	object	质量校验任务分页查询结果
TotalCount	string	总条数	131
PageSize	string	页大小	10
PageNumber	string	页码	1
DataQualityEvaluationTasks	array<object>	质量校验任务
DataQualityEvaluationTask	object
Id	long	数据质量校验任务 ID	10001
Name	string	数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长 255 个字符。	数据质量校验任务
Description	string	数据质量校验任务描述，最长 65535 个字符	This is a daily run data quality evaluation plan
TenantId	long	DataWorks 租户 ID	10
ProjectId	long	DataWorks 工作空间 ID	100
Target	object	数据质量校验任务的监控对象
Type	string	监控对象类型 Table	Table
DatabaseType	string	表类型的数据集，表所属的数据库类型 maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	表在数据地图中的唯一 ID	odps.unit_test.tb_unit_test
PartitionSpec	string	分区表的分区设置	ds=$[yyyymmdd-1]
Trigger	object	数据质量校验任务的触发配置
Type	string	何种事件可以触发质量校验任务执行 ByScheduledTaskInstance：调度实例运行成功	ByScheduledTaskInstance
TaskIds	array	type=ByScheduledTaskInstance 时生效 ,具体指明哪些调度节点的实例执行成功后可以触发
TaskId	long	调度任务节点 ID	10001
RuntimeConf	string	使用数据源时的一些设置，目前只支持指定 EMR 的 yarn 队列、采集 EMR 表时 SQL 引擎指定为 SPARK_SQL\|KYUUBI\|PRESTO_SQL\|HIVE_SQL	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Hooks	array<object>	数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的 Hook
Hook	object	回调设置
Type	string	后续处理动作类型 BlockTaskInstance：阻塞 DataWorks 任务实例执行	BlockTaskInstance
Condition	string	Hook 触发条件	${severity} == "High" AND ${status} == "Critical"
Notifications	object	告警配置
Condition	string	Notification 触发条件	${severity} == "High"
Notifications	array<object>	具体的告警设置
Notification	object	告警设置
NotificationChannels	array<object>	告警方式配置
NotificationChannel	object	告警方式
Channels	array	告警方式
Channel	string	告警方式 Mail - 邮件 Sms - 短信 Phone - 电话 Feishu - 飞书 Weixin - 微信 Dingding - 钉钉 Webhook - 自定义 Webhook	Mail
NotificationReceivers	array<object>	告警接收人配置
NotificationReceiver	object	告警接收人
ReceiverType	string	告警接收人类型 AliUid - 阿里云账号 Uid WebhookUrl - 自定义 webhook URL DingdingUrl - 钉钉机器人 Url FeishuUrl - 飞书机器人 Url WeixinUrl - 企微机器人 Url	AliUid
ReceiverValues	array	告警接收人具体值
ReceiverValue	string	告警接收人具体值	user1
Extension	string	扩展信息，格式为 json，例如钉钉机器人支持 at 所有人	{"atAll":"true"}

示例

正常返回示例

JSON格式

{
  "RequestId": "691CA452-D37A-4ED0-9441",
  "PagingInfo": {
    "TotalCount": "131",
    "PageSize": "10",
    "PageNumber": "1",
    "DataQualityEvaluationTasks": [
      {
        "Id": 10001,
        "Name": "数据质量校验任务",
        "Description": "This is a daily run data quality evaluation plan",
        "TenantId": 10,
        "ProjectId": 100,
        "Target": {
          "Type": "Table",
          "DatabaseType": "maxcompute",
          "TableGuid": "odps.unit_test.tb_unit_test",
          "PartitionSpec": "ds=$[yyyymmdd-1]"
        },
        "Trigger": {
          "Type": "ByScheduledTaskInstance",
          "TaskIds": [
            10001
          ]
        },
        "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }",
        "Hooks": [
          {
            "Type": "BlockTaskInstance",
            "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
          }
        ],
        "Notifications": {
          "Condition": "${severity} == \"High\"",
          "Notifications": [
            {
              "NotificationChannels": [
                {
                  "Channels": [
                    "Mail"
                  ]
                }
              ],
              "NotificationReceivers": [
                {
                  "ReceiverType": "AliUid",
                  "ReceiverValues": [
                    "user1"
                  ],
                  "Extension": "{\"atAll\":\"true\"}"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-11-06	OpenAPI 返回结构发生变更	查看变更详情