All Products
Search
Document Center

DataWorks:CreateDataQualityEvaluationTaskInstance

Last Updated:Sep 29, 2026

Creates a data quality check task instance.

Note

This API has been deprecated. We recommend migrating to dataworks-public(2024-05-18) - CreateDataQualityScanRun 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

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

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

DataQualityEvaluationTaskId

integer

Yes

The ID of the data quality check task.

2000011

RuntimeResource

object

No

The resource group information. This parameter is required when running data quality checks on non-MaxCompute data.

ResourceGroupId

string

No

The identifier of the schedule resource group configured for the task.

63900680

Cu

number

No

The CU consumption configured for the task. This parameter is required if you use a serverless resource group.

0.25

Parameters

string

Yes

The execution parameters of the data quality check in JSON format. The following keys are available:

  • triggerTime: the timestamp in milliseconds of the trigger time. This value is used as the base time for the $[yyyymmdd] expression in the data range of the data quality monitoring task. This key is required.

{ "triggerTime": 1733284062000 }

ProjectId

integer

Yes

The ID of the DataWorks workspace. You can logon to the DataWorks console and go to the workspace management page to obtain the ID.

This parameter specifies the DataWorks workspace for this API invoke operation.

10000

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

ecb967ec-c137-48****

Id

integer

The data quality monitoring instance ID.

22130

Examples

Success response

JSON format

{
  "RequestId": "ecb967ec-c137-48****",
  "Id": 22130
}

Error codes

HTTP status code

Error code

Error message

Description

400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.