This API has a deprecated equivalent from v7.0U1.
Cancel Tasks
DescriptionCancel a running operation associated with the task. This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage.
Request
URLURL
https://{api_host}/api/cis/tasks/{task}?action=cancel
Path Parameters
Path Parameters
string
task
Required
Task identifier. The parameter must be an identifier for the resource type: com.vmware.cis.task.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the task is already canceled or completed. | com.vmware.vapi.std.errors.unsupported : if the task is not cancelable.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if the task’s state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-CancelTask -Task "MyTask"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/cis/tasks/{task}?action=cancel
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/cis/tasks/{task}?action=cancel
x-vmw-doc-operation: cancel
Availability
Added in 7.0U2
