Task Cancel Task
Cancels a running or queued task.
A task may only be canceled if it is cancelable. Multiple cancel requests will be treated as a single cancelation request. Canceling a completed or already canceled task will throw an InvalidState exception.
If a task is canceled, its runtime state will be set to error and its error state will be set to RequestCanceled.
A cancel operation is asynchronous. The operation may return before the task is canceled.
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case Task/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
No Content
NotSupported: If the task is not cancelable.
InvalidState: If the task is already canceled or completed.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}