查询指定项目下的数据质量校验任务列表。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:ListDataQualityScans | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 否 | 模糊匹配数据质量校验任务名称。 | test |
| SortBy | string | 否 | 排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（默认 Asc，可以省略）。排序字段的枚举值如下：
| ModifyTime Desc |
| PageSize | integer | 是 | 列表翻页大小，默认为 10。 | 10 |
| PageNumber | integer | 是 | 列表翻页页码，默认为 1。 | 1 |
| ProjectId | long | 是 | 项目 ID。 | 10000 |
| Table | string | 否 | 模糊匹配监控的表名。 | video_album |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "0bc14115***159376359",
"PageInfo": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"DataQualityScans": [
{
"ModifyTime": 17236236472,
"Owner": 23782382795249,
"Description": "This is a hourly run data quality evaluation plan.",
"ModifyUser": 23782382795249,
"Parameters": [
{
"Value": "$[yyyy-mm-dd-1]",
"Name": "dt"
}
],
"CreateTime": 1694512304000,
"ProjectId": 59094,
"CreateUser": 7892346529452,
"ComputeResource": {
"Runtime": {
"HiveConf": "mapreduce.job.queuename=dq_queue",
"SparkConf": "spark.yarn.queue=dq_queue",
"Engine": "Hive"
},
"EnvType": "Prod",
"Name": "emr_cluster_001"
},
"Name": "Hourly partition quality monitoring",
"RuntimeResource": {
"Cu": 0.25,
"Id": "Serverless_resource_group_xxxxx",
"Image": "i-xxxxx"
},
"Trigger": {
"Type": "BySchedule",
"TaskIds": [
1023777390
]
},
"Hooks": [
{
"Condition": "results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' }",
"Type": "BlockTaskInstance"
}
],
"Id": 26433
}
]
}
}错误码
访问错误中心查看更多错误码。