Returns the check events for a file that is pending deployment in DataStudio. After a file is committed, DataWorks checks the file and generates events before deployment. Use the returned events to determine whether the file can proceed with deployment validation.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CheckerInstanceId |
string |
Yes |
The ID of the instance to which the file checker belongs. You can obtain the ID from the CheckerInstanceId parameter in the check event logs returned by DataWorks. |
66_123455623_2 |
| Status |
string |
Yes |
The check status of the file that you want to deploy. Valid values:
|
OK |
| CheckDetailUrl |
string |
No |
This parameter is deprecated. |
https://result.aliyun.com/?checkerInstanceId= |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. You can use the ID to troubleshoot issues. |
86d5a5ac-0cc0-4c5f-a374-a15713b252ab |
Examples
Success response
JSON format
{
"RequestId": "86d5a5ac-0cc0-4c5f-a374-a15713b252ab"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.