Triggers a data quality monitoring task and returns the run instance ID.
Operation description
DataWorks Basic Edition or a higher edition is required.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DataQualityScanId |
integer |
No |
The ID of the data quality monitor. |
20000001 |
| ProjectId |
integer |
No |
The project ID. |
10000 |
| Parameters |
array<object> |
No |
The parameter settings used during the actual run. The |
|
|
object |
No |
The parameter settings used during the actual run. |
||
| Value |
string |
No |
The parameter value. You can use a scheduling time expression. |
$[yyyy-mm-dd-1] |
| Name |
string |
No |
The parameter name. |
dt |
| RuntimeResource |
object |
No |
The scheduling resource group used when running the data quality monitor. This resource group uses the same data structure as in the scheduling API. |
|
| Id |
string |
No |
The resource group ID. |
e9455a13-ff00-4965-833c-337546ba4854 |
| Cu |
number |
No |
The Compute Resources (CUs) reserved for running the data quality monitor in the resource group. |
0.25 |
| Image |
string |
No |
The image settings used when running the data quality monitor in the resource group. |
i-xxxxxx |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| RequestId |
string |
The request ID. |
0bc14115***159376359 |
| Id |
integer |
The RunId that was successfully triggered. |
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.