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

Update the state of an asynchronous job

Contributors
PDFs

PATCH /cluster/jobs/{uuid}

Introduced In: 9.6

Updates the state of a specific asynchronous job.

Parameters

Name Type In Required Description

uuid

string

path

True

Job UUID

action

string

query

False

Requests a job to pause, resume, or cancel. Note that not all jobs support these actions. A job can only be resumed if it is in a paused state. After you successfully request a job to be cancelled, the job state changes to either success or failure.

  • enum: ["pause", "resume", "cancel"]

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

458762

Job is already in a terminal state.

458773

The Job Manager is not initialized.

458771

The specified job is running.

458776

The specified job is not currently running.

458783

This job does not support pause.

458784

This job does not support cancel.
Name Type Description

error

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

Definitions

See Definitions

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.