Skip to main content
A newer release of this product is available.

Retrieve details of an asynchronous job

Contributors
PDFs

GET /cluster/jobs/{uuid}

Retrieves the details of a specific asynchronous job. After a job transitions to a failure or success state, it is deleted after a default time of 300 seconds.

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Job UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

code

integer

If the state indicates "failure", this is the final error code.

description

string

The description of the job to help identify it independent of the UUID.

end_time

string

The time the job ended.

message

string

A message corresponding to the state of the job providing additional details about the current state.

start_time

string

The time the job started.

state

string

The state of the job.

uuid

string
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "code": 0,
  "description": "App Snapshot Job",
  "end_time": "string",
  "message": "Complete: Successful",
  "start_time": "string",
  "state": "queued",
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.