Triggers the specified data quality scan and returns the run ID.
Operation description
This operation is available only in DataWorks Basic Edition and later versions.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DataQualityScanId |
integer |
No |
The data quality scan ID. |
20000001 |
| ProjectId |
integer |
No |
The project ID. |
10000 |
| Parameters |
array<object> |
No |
The parameters for the run. The |
|
|
object |
No |
A runtime parameter. |
||
| Value |
string |
No |
The parameter value.
|
1775812636 |
| Name |
string |
No |
The name of the parameter. The only supported value is:
No other scheduling parameters are currently supported. |
triggerTime |
| RuntimeResource |
object |
No |
Specifies the scheduling resource group used to run the data quality scan. This object uses the same data structure as the scheduling API. |
|
| Id |
string |
No |
The resource group ID. |
e9455a13-ff00-4965-833c-337546ba4854 |
| Cu |
number |
No |
The number of compute units (CUs) to reserve from the resource group for the data quality scan. |
0.25 |
| Image |
string |
No |
The image configuration for running the data quality scan on the resource group. |
i-xxxxxx |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| RequestId |
string |
The request ID. |
0bc14115***159376359 |
| Id |
integer |
The run ID. |
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.