Update the state of an asynchronous job
Updates the state of an asynchronous job to manage the progress or status of specific tasks within your system. Use this endpoint when you need to modify the state of ongoing operations.
HTTP method and endpoint
PATCH /cluster/jobs/{uuid}
Introduced in
ONTAP 9.6
Usage notes
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.
|
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
| Error Code | Description |
|---|---|
459753 |
Command execution failed with custom error from the program. |
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. |
Definitions
See Definitions
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. |