ListDataQualityTemplates - 数据质量规则模板列表查询

查询指定项目下的数据质量规则模板列表。

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:ListDataQualityTemplateslist
*全部资源
*

请求参数

名称类型必填描述示例值
Catalogstring

数据质量模板所属的目录路径。

/timeliness/ods_layer
ProjectIdlong

项目 ID。

10000
Namestring

模板规则名称模糊匹配。

table_rows
PageNumberinteger

结果分页大小,默认为 10。

1
PageSizeinteger

结果分页页码,默认为 1。

10

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

0bc14115***159376359
PageInfoobject

数据质量规则模板分页查询结果。

TotalCountinteger

总条数。

10
PageSizeinteger

页数。

20
PageNumberinteger

页码。

1
DataQualityTemplatesarray<object>

规则模板列表。

DataQualityTemplateobject

规则模板。

ModifyTimelong

数据质量规则模板更新时间。

1729816478147
Ownerstring

数据质量规则模板责任人。

205250754596036836
ModifyUserstring

数据质量规则模板最近更新人。

205250754596036836
CreateTimelong

数据质量规则模板创建时间。

1729816478147
ProjectIdlong

项目 ID。

7635
CreateUserstring

数据质量规则模板创建人。

7892346529452
Idstring

数据质量规则模板 ID。

819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a
Specstring

数据质量规则模板的具体配置。具体含义,请参见数据质量 Spec 配置说明

{ "assertion": "anomaly detection fro id_not_null_cnt", "id_not_null_cnt": { "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';" }, "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a" }

示例

正常返回示例

JSON格式

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 10,
    "PageSize": 20,
    "PageNumber": 1,
    "DataQualityTemplates": [
      {
        "ModifyTime": 1729816478147,
        "Owner": 205250754596036830,
        "ModifyUser": 205250754596036830,
        "CreateTime": 1729816478147,
        "ProjectId": 7635,
        "CreateUser": 7892346529452,
        "Id": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a",
        "Spec": {
          "assertion": "anomaly detection fro id_not_null_cnt",
          "id_not_null_cnt": {
            "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';"
          },
          "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"
        }
      }
    ]
  }
}

错误码

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