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

Retrieve recent asynchronous jobs

Contributors
PDFs

GET /cluster/jobs

Introduced In: 9.6

Retrieves a list of recently running asynchronous jobs. After a job transitions to a failure or success state, it is deleted after a default time of 300 seconds.

Parameters

Name Type In Required Description

node.name

string

query

False

Filter by node.name

  • Introduced in: 9.11

state

string

query

False

Filter by state

start_time

string

query

False

Filter by start_time

error.target

string

query

False

Filter by error.target

  • Introduced in: 9.9

error.arguments.message

string

query

False

Filter by error.arguments.message

  • Introduced in: 9.9

error.arguments.code

string

query

False

Filter by error.arguments.code

  • Introduced in: 9.9

error.code

string

query

False

Filter by error.code

  • Introduced in: 9.9

error.message

string

query

False

Filter by error.message

  • Introduced in: 9.9

svm.uuid

string

query

False

Filter by svm.uuid

  • Introduced in: 9.8

svm.name

string

query

False

Filter by svm.name

  • Introduced in: 9.8

description

string

query

False

Filter by description

message

string

query

False

Filter by message

code

integer

query

False

Filter by code

end_time

string

query

False

Filter by end_time

uuid

string

query

False

Filter by uuid

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[job]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "code": 0,
      "description": "App Snapshot Job",
      "end_time": "string",
      "error": {
        "arguments": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "code": "4",
        "message": "entry doesn't exist",
        "target": "uuid"
      },
      "message": "Complete: Successful",
      "node": {
        "name": "string"
      },
      "start_time": "string",
      "state": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "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

next

href

self

href

_links

Name Type Description

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

The error that caused the job to fail. This property is only populated when the job fails and it matches the API response error structure used by all APIs. The message and code match the dedicated message and code properties once the job has failed.

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.

node

The node where this job was run

Name Type Description

name

string

The name of the node

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

job

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.

error

error

The error that caused the job to fail. This property is only populated when the job fails and it matches the API response error structure used by all APIs. The message and code match the dedicated message and code properties once the job has failed.

message

string

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

node

node

The node where this job was run

start_time

string

The time the job started.

state

string

The state of the job.

svm

svm

uuid

string

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.