Snapservice. Tasks Get
Returns information about a task.
This operation was added in vSphere API 8.0.3.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Read.
Request
URI
GET
https://{host}/api/snapservice/tasks/{task}
COPY
Path Parameters
string
task
Required
Task identifier.
The parameter must be an identifier for the resource type: com.vmware.snapservice.task.
Responses
200
Information about the specified task.
Returns
Snapservice.Tasks.Info
of type(s)
application/json
"Snapservice.Tasks.Info Object"
401
if the user can not be authenticated.
Returns
Vapi.Std.Errors.Unauthenticated
of type(s)
application/json
"Vapi.Std.Errors.Unauthenticated Object"
403
if the user doesn't have the required privileges.
Returns
Vapi.Std.Errors.Unauthorized
of type(s)
application/json
"Vapi.Std.Errors.Unauthorized Object"
404
if the task is not found.
Returns
Vapi.Std.Errors.NotFound
of type(s)
application/json
"Vapi.Std.Errors.NotFound Object"
500
Vapi.Std.Errors.Error if the system reports an error while responding to the request.
Vapi.Std.Errors.ResourceInaccessible if the task's state cannot be accessed.
Returns
Vapi.Std.Errors.Error
of type(s)
application/json
"Vapi.Std.Errors.Error Object"
503
if the system is unable to communicate with a service to complete the request.
Returns
Vapi.Std.Errors.ServiceUnavailable
of type(s)
application/json
"Vapi.Std.Errors.ServiceUnavailable Object"Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/snapservice/tasks/{task}