CreateDataQualityRuleTemplate-DataWorks(DataWorks)-阿里云帮助中心

Creates a rule template.

Note

This API has been deprecated. We recommend migrating to dataworks-public(2024-05-18) - CreateDataQualityTemplate for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the rule template. The name can contain digits, letters, Chinese characters, and half-width or full-width punctuation marks. The name can be up to 512 characters in length.	Table row Count Verification
ProjectId	integer	Yes	The DataWorks workspace ID.	12345
VisibleScope	string	No	The visibility scope of the template. Valid values: Tenant: available to the entire tenant. Project: available only in the current project. Valid values: Project : Available only in the current project. Tenant : Available to the entire tenant.	Project
DirectoryPath	string	No	The directory path where the custom template is stored. Levels are separated by forward slashes (/). Each level name can be up to 1024 characters in length and cannot contain whitespace characters or forward slashes.	/ods/order_data
SamplingConfig	object	Yes	The settings required for sample collection.
Metric	string	No	The name of the sampling metric. Valid values: Count: the number of table rows. Min: the minimum value of a field. Max: the maximum value of a field. Avg: the average value of a field. DistinctCount: the number of distinct values in a field. DistinctPercent: the ratio of distinct values to the total number of rows. DuplicatedCount: the number of duplicate values in a field. DuplicatedPercent: the ratio of duplicate values to the total number of rows. TableSize: the table size. NullValueCount: the number of rows where the field value is null. NullValuePercent: the ratio of rows where the field value is null. GroupCount: the count of rows for each value after aggregation by field value. CountNotIn: the number of rows that do not match the enumerated values. CountDistinctNotIn: the number of distinct values that do not match the enumerated values. UserDefinedSql: sample collection through a custom SQL statement.	Count
MetricParameters	string	Yes	The parameters required for sample collection.	{"SQL": "select count(1) from table;"}
SettingConfig	string	No	The runtime parameter setting statements to execute before the sampling statement. The value can be up to 1000 characters in length. Currently, only MaxCompute is supported.	SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;
CheckingConfig	object	No	The sample verification settings.
Type	string	Yes	The threshold calculation method. Valid values: Fixed Fluctation FluctationDiscreate Auto Average Variance	Fixed
ReferencedSamplesFilter	string	No	An expression that specifies how to query reference samples. Some threshold types require querying reference samples and then aggregating their values to derive the threshold for comparison.	{ "bizdate": [ "-1", "-7", "-1m" ] }

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	691CA452-D37A-4ED0-9441
Code	string	The code of the rule template.	UserDefined:3001

Examples

Success response

JSON format

{
  "RequestId": "691CA452-D37A-4ED0-9441\n",
  "Code": "UserDefined:3001"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.