ListDataQualityScanRuns - 数据质量扫描运行记录查询

更新时间:
复制为 MD 格式

查询指定项目下的数据质量扫描运行记录。

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListDataQualityScanRuns

list

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

DataQualityScanId

integer

数据质量监控 ID。

10001

CreateTimeFrom

integer

数据质量监控运行最早开始时间。

1710239005403

CreateTimeTo

integer

数据质量监控运行最晚开始时间。

1710239005403

Status

string

数据质量校验结果状态。

  • Pass

  • Running

  • Error

  • Fail

  • Warn

Fail

SortBy

string

排序字段列表,支持修改时间、创建时间等字段,格式为"排序字段+排序方式(Desc/Asc)"(默认 Asc,可以省略)。排序字段的枚举值如下:

  • CreateTime (Desc/Asc)

  • Id (Desc/Asc)

CreateTime Desc

PageSize

integer

列表翻页查询页大小,默认为 10。

20

PageNumber

integer

列表翻页查询页码,默认为 1。

1

ProjectId

integer

项目 ID。

12345

Filter

object

扩展的查询 Filter,目前支持以下过滤参数:

  • TaskInstanceId 调度任务实例 ID

  • RunNumber 实例运行次数

{ "TaskInstanceId": "111", "RunNumber": "1" }

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

0bc14115***159376359

PageInfo

object

分页信息。

TotalCount

integer

总条数。

324

PageSize

integer

列表翻页查询页大小,默认为 10。

10

PageNumber

integer

列表翻页查询页码,默认为 1。

1

DataQualityScanRuns

array<object>

数据质量监控运行记录列表。

array<object>

数据质量监控运行记录列表。

Id

integer

数据质量监控运行记录 ID。

3155

CreateTime

integer

数据质量监控运行开始时间。

1710239005403

FinishTime

integer

数据质量监控运行结束时间。

1710239005403

Status

string

当前运行状态。

  • Pass

  • Running

  • Error

  • Warn

  • Fail

Fail

Parameters

array<object>

实际运行时,使用的参数设置。

object

参数信息。

Name

string

参数名。

dt

Value

string

参数值,可以使用调度时间表达式。

$[yyyy-mm-dd-1]

示例

正常返回示例

JSON格式

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 324,
    "PageSize": 10,
    "PageNumber": 1,
    "DataQualityScanRuns": [
      {
        "Id": 3155,
        "CreateTime": 1710239005403,
        "FinishTime": 1710239005403,
        "Status": "Fail",
        "Parameters": [
          {
            "Name": "dt",
            "Value": "$[yyyy-mm-dd-1]"
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情