跳转至

查询配置的质量规则

接口地址: /api/v1/dataset/dataQuality/rule/query

请求方式: GET

接口描述: 基于创建时间范围查询配置的质量规则

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
gte_start_time 开始时间 query Long类型13位时间戳
gte_end_time 结束时间 query Long类型13位时间戳

响应参数:

{
  "data":[{
    "datasetGuid":"\"demo\".\"zou\".\"view01\"", // 表的唯一标识
    "viewName":"demo", // 视图名称
    "columnName":"columnA", // 字段名称
    "owner":{
      "userId":"123",
      "username":"admin"
    },
    "createTime":1759248000000, // 创建时间,13位时间戳
    "rules":[{
      "ruleType":"规则枚举详见下面枚举列表",
      "checkContent":"校验内容"
    }],
    "clusterId":"xxxx" // 集群id
  }],
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

质量规则枚举列表(ruleType):

  1. NULL_CHECK:非空校验
  2. RANGE_CHECK:范围校验
  3. ENUM_CHECK:枚举校验
  4. INVALID_DATA_CHECK:非法日期校验
  5. FORMAT_CHECK:格式校验
  6. UNIQUNESS_CHECK:唯一性校验
  7. DATA_QUALITY_TEMPLATE:质量模板校验

查询数据质量校验情况

接口地址: /api/v1/dataset/dataQuality/result/query

请求方式: GET

接口描述: 基于创建时间范围查询质量校验结果情况

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
gte_start_time 开始时间 query Long类型13位时间戳
gte_end_time 结束时间 query Long类型13位时间戳

响应参数:

{
  "data":[{
    "id":"", // 校验结果唯一id
    "checkTime":1759248000000, // 校验时间 13位时间戳
    "datasetGuid":"\"demo\".\"zou\".\"view01\"", // 表的唯一标识
    "columnName":"columnA", // 校验字段
    "datasetOwner":{ // 视图负责人
      "userId":"123",
      "username":"admin"
    },
    "checkContent":"校验内容",
    "executionResult":"SUCCESS/FALIED", // 执行校验SQL的是否成功
    "checkResult":"PASS/NOT_PASS", // 校验结果是否通过
  }],
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}