全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：ListDataQualityRuleTemplates - 查询质量规则模版列表

    文档中心

    大数据开发治理平台 DataWorks：ListDataQualityRuleTemplates - 查询质量规则模版列表

    更新时间：Sep 03, 2026

    查询质量规则模版列表。

    说明

    目前该API接口已标记为弃用，推荐使用替代API：dataworks-public(2024-05-18) - ListDataQualityTemplates。

    接口说明

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

    调试

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

    调试

    授权信息

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

    请求参数

    名称

    类型

    必填

    描述

    示例值
    ProjectId

    integer

    是

    DataWorks 工作空间 ID

    10000
    CreationSource

    string

    是

    规则模板的创建来源，必填。

    • System：系统模板

    • UserDefined：用户自定义模板

    System

    DirectoryPath

    string

    否

    自定义模板被存放的类目目录，斜线/分隔层级。每个层级名称最长 1024 个字符，由不能包含空白字符、不能包含反斜线

    /ods/order_data
    Name

    string

    否

    模板规则名称模糊匹配，如果是系统模板，则会根据语言模糊匹配系统模板的国际化名称

    Table rows
    PageNumber

    integer

    是

    列表分页查询页大小，默认为 10

    10
    PageSize

    integer

    是

    列表分页查询页码，默认为 1

    1

    返回参数

    名称

    类型

    描述

    示例值

    object

    返回值

    RequestId

    string

    API 请求 ID

    691CA452-D37A-****
    PagingInfo

    object

    质量规则模版分页查询结果

    TotalCount

    integer

    总条数

    42
    PageSize

    integer

    页大小

    10
    PageNumber

    integer

    页码

    1
    DataQualityRuleTemplates

    array<object>

    规则模版列表

    array<object>

    规则模版详情

    Code

    string

    规则模版 Code

    USER_DEFINED:123
    Name

    string

    规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长 512 个字符

    Table row Count Verification

    ProjectId

    integer

    DataWorks 工作空间 ID

    2043
    SamplingConfig

    object

    样本采集所需的设置

    Metric

    string

    采样的指标名称

    • Count：表行数

    • Min：字段最小值

    • Max：字段最大值

    • Avg：字段均值

    • DistinctCount：字段唯一值个数

    • DistinctPercent：字段唯一值个数与数据行数占比

    • DuplicatedCount：字段重复值个数

    • DuplicatedPercent：字段重复值个数与数据行数占比

    • TableSize：表大小

    • NullValueCount：字段为空的行数

    • NullValuePercent：字段为空的比例

    • GroupCount：按字段值聚合后每个值与对应的数据行数

    • CountNotIn：枚举值不匹配行数

    • CountDistinctNotIn：枚举值不匹配唯一值个数

    • UserDefinedSql：通过自定义 SQL 做样本采集

    Max
    MetricParameters

    string

    样本采集时，所需的参数

    {"Sql": "select count(1) from table;"}

    SettingConfig

    string

    具体执行采样语句前，插入执行的一些运行时参数设置语句，最长 1000 个字符。目前只支持 MaxCompute

    SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;

    CheckingConfig

    object

    样本校验设置

    Type

    string

    阈值计算方式

    • Fixed

    • Fluctation

    • FluctationDiscreate

    • Auto

    • Average

    • Variance

    Fixed
    ReferencedSamplesFilter

    string

    有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式

    { "bizdate": [ "-1", "-7", "-1m" ] }

    VisibleScope

    string

    模板的可用范围：

    • Tenant：全租户都可用

    • Project：只在当前项目中可用

    Project
    DirectoryPath

    string

    自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长 1024 个字符，由不能包含空白字符、不能包含斜线

    /ods/order_data

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "691CA452-D37A-****",
  "PagingInfo": {
    "TotalCount": 42,
    "PageSize": 10,
    "PageNumber": 1,
    "DataQualityRuleTemplates": [
      {
        "Code": "USER_DEFINED:123",
        "Name": "Table row Count Verification\n",
        "ProjectId": 2043,
        "SamplingConfig": {
          "Metric": "Max",
          "MetricParameters": "{\"Sql\": \"select count(1) from table;\"}\n",
          "SettingConfig": "SET odps.sql.udf.timeout=600s; \nSET odps.sql.python.version=cp27;\n"
        },
        "CheckingConfig": {
          "Type": "Fixed",
          "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }\n"
        },
        "VisibleScope": "Project",
        "DirectoryPath": "/ods/order_data"
      }
    ]
  }
}

    错误码

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

    变更历史

    更多信息，参考变更详情。