All Products
Search
Document Center

DataWorks:CreateDataQualityScanRun

Last Updated:Jan 12, 2026

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

Operation description

This API operation is available for all DataWorks editions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DataQualityScanIdlongNo

The ID of the data quality monitor.

20000001
ProjectIdlongNo

The project ID.

10000
Parametersarray<object>No

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

objectNo

The parameter settings used during the actual run.

ValuestringNo

The parameter value. You can use a scheduling time expression.

cn-shanghai$[yyyy-mm-dd-1]
NamestringNo

The parameter name.

regiondt
RuntimeResourceobjectNo

The scheduling resource group used when running the data quality monitor. This resource group uses the same data structure as in the scheduling API.

IdstringNo

The resource group ID.

e9455a13-ff00-4965-833c-337546ba4854
CufloatNo

The Compute Resources (CUs) reserved for running the data quality monitor in the resource group.

0.25
ImagestringNo

The image settings used when running the data quality monitor in the resource group.

i-xxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The request ID.

0bc14115***159376359
Idlong

The RunId that was successfully triggered.

248840

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.