ListDataQualityTemplates - DataWorks - Alibaba Cloud Documentation Center

Operation description

DataWorks Basic Edition or a higher edition is required.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListDataQualityTemplates

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Catalog	string	No	The directory path to which the data quality template belongs.	/timeliness/ods_layer
ProjectId	integer	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 elements

Element	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.
	object	The rule template.
ModifyTime	integer	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	integer	The time when the data quality rule template was created.	1729816478147
ProjectId	integer	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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.