Some endpoints within the Cloud Accelerator API are asynchronous. When you call these endpoints, you will first receive a jobId in the response. You can then use this jobId to query the corresponding status endpoint and check the progress of the job. Once the job completes, it will include the result of the job. If the job was successful, the result will be SUCCEEDED along with additional information about the created resource, including a resource ID. This resource ID can then be used with the associated GET endpoint to retrieve further details about the resource.
It is recommended to poll the status endpoint every 60 seconds until receiving a status which dictates the job is complete. The status endpoint will return the response on completion for 30 days.
Asynchronous Request Response Codes
| Status Code | Description |
|---|---|
| 202 ACCEPTED | Job accepted |
| 400 BAD REQUEST | Incorrect format |
| 403 FORBIDDEN | The token provided is invalid, or corresponds to a user that does not have access to the Cloud API or endpoint resource |
| 409 CONFLICT | An async job is already running for this resource |
Asynchronous Request Job Status Types
| Status | Description |
|---|---|
| RUNNING | The job has been accepted and is processing |
| SUCCEEDED | The job has been completed successfully. The response will include additional information about the resource created |
| FAILED | The job failed. A message property is included which may provide information on why the job failed |
| TIMED_OUT | The job took too long. This can be caused by a variety of scenarios. It is advised to reduce the scope of the request and try again. |
| ABORTED | The job was aborted before completion. Note that the API does not provide an endpoint to cancel jobs |
| PENDING | The job has been accepted, but has not begun processing |