All Products
Search
Document Center

DataWorks:CreateDataQualityScanRun

Last Updated:Sep 29, 2026

Triggers the execution of a specified data quality monitoring task and returns the run instance ID.

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

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

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

DataQualityScanId

integer

No

The ID of the data quality monitoring task.

20000001

ProjectId

integer

No

The project ID.

10000

Parameters

array<object>

No

The parameter settings used during the actual run. The triggerTime parameter is required.

object

No

The parameter settings used during the actual run.

Value

string

No

The parameter value:

  • If the parameter name is triggerTime, the value must be the timestamp of the scheduling time.

1775812636

Name

string

No

The parameter name. Currently supported parameter:

  • triggerTime

Other scheduling parameters are not supported.

triggerTime

RuntimeResource

object

No

The schedule resource group used when the data quality monitoring task runs. This shares the same data structure as the scheduling API.

Id

string

No

The resource group ID.

e9455a13-ff00-4965-833c-337546ba4854

Cu

number

No

The CU configuration reserved for the resource group when running the data quality monitoring task.

0.25

Image

string

No

The image settings used when running the data quality monitoring task on the resource group.

i-xxxxxx

Response elements

Element

Type

Description

Example

object

The response struct.

RequestId

string

The request ID.

0bc14115***159376359

Id

integer

The run ID of the successfully triggered task.

248840

Examples

Success response

JSON format

{
  "RequestId": "0bc14115***159376359",
  "Id": 248840
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.