使用ListDataQualityTemplates查询数据质量规则模板列表-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListDataQualityTemplates

list

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Catalog	string	否	数据质量模板所属的目录路径。	/timeliness/ods_layer
ProjectId	integer	否	项目 ID。	10000
Name	string	否	模板规则名称模糊匹配。	table_rows
PageNumber	integer	否	结果分页页码，默认为 1。	1
PageSize	integer	否	结果分页大小，默认为 10。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	0bc14115***159376359
PageInfo	object	数据质量规则模板分页查询结果。
TotalCount	integer	总条数。	10
PageSize	integer	页数。	20
PageNumber	integer	页码。	1
DataQualityTemplates	array<object>	规则模板列表。
	object	规则模板。
ModifyTime	integer	数据质量规则模板更新时间。	1729816478147
Owner	string	数据质量规则模板责任人。	205250754596036836
ModifyUser	string	数据质量规则模板最近更新人。	205250754596036836
CreateTime	integer	数据质量规则模板创建时间。	1729816478147
ProjectId	integer	项目 ID。	7635
CreateUser	string	数据质量规则模板创建人。	7892346529452
Id	string	数据质量规则模板 ID。	819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a
Spec	string	数据质量规则模板的具体配置。具体含义，请参见数据质量 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": "205250754596036836",
        "ModifyUser": "205250754596036836",
        "CreateTime": 1729816478147,
        "ProjectId": 7635,
        "CreateUser": "7892346529452",
        "Id": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a",
        "Spec": "{\n    \"assertion\": \"anomaly detection fro id_not_null_cnt\",\n    \"id_not_null_cnt\": {\n        \"query\": \"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';\"\n    },\n    \"identity\": \"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\"\n}"
      }
    ]
  }
}

错误码

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

变更历史

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