GetDataQualityTemplate - 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:GetDataQualityTemplate

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Id	string	No	The data quality rule template ID.	a7ef0634-20ec-4a7c-a214-54020f91XXXX

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The API request ID, which is generated as a UUID.	0bc14115***159376359
DataQualityTemplate	object	The data quality rule template.
Id	string	The ID of the data quality rule template.	10001
ProjectId	integer	The project ID.	97535
CreateTime	integer	The time when the data quality rule template was created.	1606724043000
ModifyTime	integer	The time when the data quality rule template was updated.	1606724043000
CreateUser	string	The creator of the data quality rule template.	238428342865
ModifyUser	string	The last updater of the data quality rule template.	238428342865
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" }
Owner	string	The owner of the data quality rule template.	238428342865

Examples

Success response

JSON format

{
  "RequestId": "0bc14115***159376359",
  "DataQualityTemplate": {
    "Id": "10001",
    "ProjectId": 97535,
    "CreateTime": 1606724043000,
    "ModifyTime": 1606724043000,
    "CreateUser": "238428342865",
    "ModifyUser": "238428342865",
    "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}",
    "Owner": "238428342865"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.