After you commit your file that is created on the DataStudio page, the system checks the file and returns check events before the system deploys the file. You must determine whether the check can be continued based on the events. You can call the CheckFileDeployment operation to return the check events for the file that you want to deploy to DataWorks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CheckFileDeployment

The operation that you want to perform.

CheckerInstanceId String Yes 66_123455623_2

The ID of the instance to which the file checker belongs.

RegionId String Yes cn-hangzhou

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

Status String Yes OK

The check status of the file that you want to deploy. Valid values:

  • OK: The file passes the check.
  • WARN: The file passes the check, but an alert is reported.
  • FAIL: The file fails the check.
CheckDetailUrl String No https://result.aliyun.com/?checkerInstanceId=

The URL of the custom check details page. The URL is contained in the file check details on the Create Deploy Task page. You can click the link provided in the file check details to go to the custom check details page to view the detailed check procedure.

Response parameters

Parameter Type Example Description
RequestId String 86d5a5ac-0cc0-4c5f-a374-a15713b252ab

The ID of the request. You can use the ID to troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CheckFileDeployment
&CheckerInstanceId=66_123455623_2
&RegionId=cn-hangzhou
&Status=OK
&<Common request parameters>

Sample success responses

XML format

<RequestId>86d5a5ac-0cc0-4c5f-a374-a15713b252ab</RequestId>

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. The error message returned because an internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the maximum number of requests for the resource has been reached.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.

For a list of error codes, visit the API Error Center.