ListDataQualityResults - 查询质量结果列表_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

质量结果列表分页查询。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ProjectId	long	否	DataWorks 工作空间 ID	100
DataQualityRuleId	long	否	数据质量规则 ID	100001
DataQualityEvaluationTaskId	long	否	数据质量校验任务 ID	200001
DataQualityEvaluationTaskInstanceId	long	否	数据质量校验任务实例 ID	10001
CreateTimeFrom	long	否	数据质量校验结果最早生成时间	1710239005403
CreateTimeTo	long	否	数据质量校验结果最晚生成时间	1710239005403
BizdateFrom	string	否	规则实例业务起始日期	2024-05-01
BizdateTo	string	否	规则实例业务截止日期	2024-05-04
PageSize	integer	否	列表分页查询页大小，默认为 10	10
PageNumber	integer	否	列表分页查询页码，默认为 1	1

返回参数

名称	类型	描述	示例值
	object	返回值
RequestId	string	API 请求 ID	691CA452-D37A-4ED0-9441
PagingInfo	object	数据质量校验结果分页查询结果
PageNumber	integer	页码	1
PageSize	integer	页大小	10
TotalCount	integer	总条数	219
DataQualityResults	array<object>	质量校验结果列表
DataQualityResult	object	质量校验结果
Id	long	校验结果 ID	16033
Status	string	校验结果状态 Running Error Passed Warned Critical	Passed
CreateTime	long	校验结果生成时间	1708284916414
TaskInstanceId	long	校验任务实例 ID	200001
Sample	string	本次校验所使用的样本值	[ { "gender": "male", "_count": 100 }, { "gender": "female", "_count": 100 } ]
Details	array<object>	本次校验的详情
Detail	object	校验详情
ReferencedValue	string	使用引用的样本，用来参与 CheckedValue 计算的基准值	0.0
CheckedValue	string	最终用来与阈值比较的值	100.0
Status	string	最终的比较结果状态 Error Passed Warned Critical	Passed
Rule	object	校验开始时，规则配置快照
Id	long	规则 ID	100001
Name	string	规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长 255 个字符	表不能为空
ProjectId	long	DataWorks 项目空间 ID	100
Enabled	boolean	规则是否启用	true
Severity	string	规则对于业务的等级（对应页面上的强弱规则） High Normal	Normal
Description	string	规则描述信息，最长 500 个字符	this is a odps _sql task
TemplateCode	string	创建规则时所引用的规则模板 Code	SYSTEM:user_defined_sql
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]
SamplingConfig	object	样本采集所需的设置
Metric	string	采样的指标名称。 Count：表行数 Min：字段最小值 Max：字段最大值 Avg：字段均值 DistinctCount：字段唯一值个数 DistinctPercent：字段唯一值个数与数据行数占比 DuplicatedCount：字段重复值个数 DuplicatedPercent：字段重复值个数与数据行数占比 TableSize：表大小 NullValueCount：字段为空的行数 NullValuePercent：字段为空的比例 GroupCount：按字段值聚合后每个值与对应的数据行数 CountNotIn：枚举值不匹配行数 CountDistinctNotIn：枚举值不匹配唯一值个数 UserDefinedSql：通过自定义 SQL 做样本采集	Count
MetricParameters	string	样本采集时，所需的参数	{ "columns": [ "id", "name" ] }
SettingConfig	string	具体执行采样语句前，插入执行的一些运行时参数设置语句，最长 1000 个字符。目前只支持 MaxCompute	SET odps.sql.udf.timeout=600s;
SamplingFilter	string	采样时，对不关注的数据进行二次过滤的条件，最多 16777215 个字符	id IS NULL
CheckingConfig	object	样本校验设置
Type	string	阈值计算方式 Fixed Fluctation FluctationDiscreate Auto Average Variance	Fixed
ReferencedSamplesFilter	string	有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式	{ "bizdate": [ "-1", "-7", "-1m" ] }
Thresholds	object	阈值设置
Expected	object	期望的阈值设置
Value	string	阈值数值	100.0
Operator	string	比较符 > >= < <= != =	>
Warned	object	普通警告的阈值设置
Value	string	阈值数值	100.0
Operator	string	比较符 > >= < <= != =	>
Critical	object	严重警告的阈值设置
Value	string	阈值数值	100.0
Operator	string	比较符 > >= < <= != =	>
ErrorHandlers	array<object>	质量规则校验问题处理器
ErrorHandler	object	质量规则校验问题处理器
Type	string	处理器类型： SaveErrorData	SaveErrorData
ErrorDataFilter	string	如果是自定义 SQL 规则，需要用户指定 SQL 来过滤问题数据	SELECT * FROM tb_api_log WHERE id IS NULL

示例

正常返回示例

JSON格式

{
  "RequestId": "691CA452-D37A-4ED0-9441",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 219,
    "DataQualityResults": [
      {
        "Id": 16033,
        "Status": "Passed",
        "CreateTime": 1708284916414,
        "TaskInstanceId": 200001,
        "Sample": "[\n  {\n    \"gender\": \"male\",\n    \"_count\": 100\n  }, {\n    \"gender\": \"female\",\n    \"_count\": 100\n  }\n]",
        "Details": [
          {
            "ReferencedValue": "0.0",
            "CheckedValue": "100.0",
            "Status": "Passed"
          }
        ],
        "Rule": {
          "Id": 100001,
          "Name": "表不能为空",
          "ProjectId": 100,
          "Enabled": true,
          "Severity": "Normal",
          "Description": "this is a odps _sql task",
          "TemplateCode": "SYSTEM:user_defined_sql",
          "Target": {
            "Type": "Table",
            "DatabaseType": "maxcompute",
            "TableGuid": "odps.unit_test.tb_unit_test",
            "PartitionSpec": "ds=$[yyyymmdd-1]"
          },
          "SamplingConfig": {
            "Metric": "Count",
            "MetricParameters": "{ \"columns\": [ \"id\", \"name\" ] }",
            "SettingConfig": "SET odps.sql.udf.timeout=600s; ",
            "SamplingFilter": "id IS NULL"
          },
          "CheckingConfig": {
            "Type": "Fixed",
            "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }",
            "Thresholds": {
              "Expected": {
                "Value": "100.0",
                "Operator": ">"
              },
              "Warned": {
                "Value": "100.0",
                "Operator": ">"
              },
              "Critical": {
                "Value": "100.0",
                "Operator": ">"
              }
            }
          },
          "ErrorHandlers": [
            {
              "Type": "SaveErrorData\n",
              "ErrorDataFilter": "SELECT * FROM tb_api_log WHERE id IS NULL"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

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