Error Handling
When an error occurs in the API, APS typically provides additional information about what went wrong in the response body. When an error occurred while a job was running more debugging might be required.
Flow Graph Engine APIs Errors
Errors generated by the Flow Graph Engine APIs typically return a 4** or 5** HTTP status code in the response. The response body provides details of the error. The body structure of the error response for Flow Graph Engine APIs errors is as follows:
title string | The title of the error |
detail string | details on the error if there is any |
Example
{
"title": "Unauthorized"
}
{
"title": "Job submission rejected as it will exceed the submitter's free quota.",
"detail": "Used job quota will be replenished on Sun Mar 31 2024 20:00:00 GMT-0400 (Eastern Daylight Saving Time)"
}
Debugging Failed job
A job might end up in a FAILED status. When this happen look at the error section of the job to get more information on the error that occurred during the job.
Debugging job that didn’t produce the expected outputs
When a job end with a SUCCEEDED status, it indicate that the task provided was executed correctly. Therefore, the problem is most likely related to a task definition or an input being incorrectly setup. This require debugging the job execution to identify the root cause of the issue. To help debug what is happening on the service while the job is being executed, get the logs using the Get logs endpoints. Then, use the Resource API to download them. The logs contain executor specific runtime logs that will help understand what is happening when your job is executed.