CheckFileDeployment

Returns the check result of a file pending deployment to DataWorks. After a file created on the DataWorks Data Studio page is submitted, the file enters the deployment check state. DataWorks returns a file deployment check event to you, and you need to determine whether the file can proceed with deployment verification based on the event content. You can call this operation to return the check result of the file pending deployment to DataWorks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
CheckerInstanceId	string	Yes	The instance ID to which the file checker belongs. You can obtain this value from the CheckerInstanceId field in the file publish check event.	66_123455623_2
Status	string	Yes	The check status of the file pending deployment. Valid values: OK: The file passed the check. WARN: The file passed the check but has warnings. FAIL: The file failed the check. Valid values: OK : The file passed the check. FAIL : The file failed the check. WARN : The file passed the check but has warnings.	OK
CheckDetailUrl	string	No	Deprecated.	https://result.aliyun.com/?checkerInstanceId=

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is used for subsequent troubleshooting.	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.