ListDataQualityTemplates - DataWorks - Alibaba Cloud Documentation Center

Queries the list of data quality rule templates in a project.

Operation description

This API operation is available for all DataWorks editions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:ListDataQualityTemplates	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Catalog	string	No	The directory path to which the data quality template belongs.	/timeliness/ods_layer
ProjectId	long	No	The project ID.	10000
Name	string	No	Fuzzy match for the template rule name.	table_rows
PageNumber	integer	No	The number of records per page. Default value: 10.	1
PageSize	integer	No	The page number of the results. Default value: 1.	10

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The API request ID, which is generated as a UUID.	0bc14115***159376359
PageInfo	object	Paged query results of data quality rule templates.
TotalCount	integer	The total number of records.	10
PageSize	integer	The number of pages.	20
PageNumber	integer	The page number.	1
DataQualityTemplates	array<object>	The list of rule templates.
DataQualityTemplate	object	The rule template.
ModifyTime	long	The time when the data quality rule template was updated.	1729816478147
Owner	string	The owner of the data quality rule template.	205250754596036836
ModifyUser	string	The last updater of the data quality rule template.	205250754596036836
CreateTime	long	The time when the data quality rule template was created.	1729816478147
ProjectId	long	The project ID.	7635
CreateUser	string	The creator of the data quality rule template.	7892346529452
Id	string	The ID of the data quality rule template.	819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a
Spec	string	Specific configurations of the data quality rule template. For more information, see Data quality Spec configuration description.	{ "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" }

Examples

Sample success responses

JSONformat

{
  "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"
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.