Get Task Status

Get Task Status

In general, to get the status of any long running operations, the operation
must have been initiated through the VMware Cloud Foundation Operations REST API.
This API returns the status of a specific task that was initiated via the REST API
with the exception of tasks that get created when any Remediation Action is performed
via the api/actions endpoint.

Request
URI
GET
https://{api_host}/suite-api/api/tasks/{id}
COPY
Path Parameters
string
id
Required

The id of the task

Authentication
This operation uses the following authentication methods.
Responses
200

Task status with the specified identifier

Returns task-status of type(s) application/json 
"{\n  \"taskId\" : \"a8c1f71d-a283-45ee-b333-ab0d87f1d9d1\",\n  \"statusMessage\" : \"Distributed Task Execution for ADAPTER_INSTALL\",\n  \"taskState\" : \"RUNNING\",\n  \"createdTime\" : 0,\n  \"lastUpdateTime\" : 1744473856279,\n  \"errorMessages\" : [ ]\n}"
string As uuid As uuid
taskId
Optional

The task identifier

string
description
Optional

A description for the task

string
statusMessage
Optional

Optional status message

string
taskState
Optional

The state of an asynchronous Task

Possible values are : INITIATED, STOPPED, RUNNING, FINISHED, ERROR, ABORTED, UNKNOWN,
integer As int64 As int64
createdTime
Optional

Task status creation time, in milliseconds (since midnight January 1, 1970)

integer As int64 As int64
lastUpdateTime
Optional

Task status last update time, in milliseconds (since midnight January 1, 1970)

array of string
errorMessages
Optional

List of error messages that occurred

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.


404

No Task is found with the specified identifier

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/tasks/{id}
On This Page
Tasks Operations
GET
Get Tasks Status
GET
Get Task Status