Get Action Status

Get Action Status

The response contains information about the action status by the given taskId

Request
URI
GET
https://{api_host}/suite-api/api/actions/{taskId}/status
COPY
Path Parameters
string
taskId
Required

Action identifier (result of the action: POST /api/actions/{id})

Query Parameters
boolean
detail
Optional
Constraints: default: false

Information about action status objects

Authentication
This operation uses the following authentication methods.
Responses
200

The populated action information

Returns action-status-info of type(s) application/json 
"{\n  \"taskId\" : \"46977637-ecc5-4100-8601-50e6063303aa\",\n  \"name\" : \"VMWARE-Power Off VM\",\n  \"state\" : \"Completed\",\n  \"resourceKind\" : \"Virtual Machine\",\n  \"submittedBy\" : \"admin\",\n  \"authSource\" : \"LOCAL\",\n  \"startDate\" : \"2019-12-05T09:57:20.439Z\",\n  \"completeDate\" : \"2019-12-05T09:57:22.439Z\",\n  \"actionResult\" : \"ActionResult\",\n  \"messages\" : [ {\n    \"message\" : \"Cannot power Off: Another task is already in progress\",\n    \"level\" : \"ERROR\",\n    \"timestamp\" : \"2019-12-05T09:57:20.439Z\"\n  }, {\n    \"message\" : \"The operation is not allowed in current state\",\n    \"level\" : \"WARN\",\n    \"timestamp\" : \"2019-12-05T09:57:20.439Z\"\n  }, {\n    \"message\" : \"The virtual machine is powered Off\",\n    \"level\" : \"INFO\",\n    \"timestamp\" : \"2019-12-05T09:57:20.439Z\"\n  } ],\n  \"triggeredAutomatically\" : true,\n  \"triggeringSource\" : \"Source\",\n  \"triggeringEventId\" : \"80814fe2-3a62-4d19-9641-5b3b50a75238\",\n  \"triggeringEventName\" : \"Virtual machine disk I/O write latency is high\",\n  \"triggeringSourceEvent\" : \"Source Event\",\n  \"actionObjectStatuses\" : [ {\n    \"id\" : \"aa8bff3d-7a1a-4390-8b52-61a8f7647f11\",\n    \"state\" : \"COMPLETED_SUCCESSFULLY\",\n    \"creationDate\" : \"2019-12-05T09:57:20.439Z\",\n    \"messages\" : [ {\n      \"message\" : \"Cannot power On VM 'VM-1'\",\n      \"level\" : \"ERROR\",\n      \"timestamp\" : \"2019-12-05T09:57:20.439Z\"\n    }, {\n      \"message\" : \"The operation is not allowed in current state\",\n      \"level\" : \"WARN\",\n      \"timestamp\" : \"2019-12-05T09:57:20.439Z\"\n    }, {\n      \"message\" : \"Powering on VM 'VM-1'\",\n      \"level\" : \"INFO\",\n      \"timestamp\" : \"2019-12-05T09:57:20.439Z\"\n    } ]\n  } ]\n}"
string
taskId
Required

The id of the action

string
name
Optional

The action name

string
state
Optional

The state of the action

string
resourceKind
Optional

The resourceKind on which the action has been performed

string
submittedBy
Optional

The user who submitted the action

string
authSource
Optional

The authSource of the action

string
startDate
Optional

The start date of the action

string
completeDate
Optional

The complete date of the action

string
actionResult
Optional

The result of the action

array of object
messages
Optional

The messages of the action result

boolean
triggeredAutomatically
Optional

Flag that identifies whether action is triggered automatically or not

string
triggeringSource
Optional

The source that triggered the action

string
triggeringEventId
Optional

The id of the event that triggered the action

string
triggeringEventName
Optional

The name of the event that triggered the action

string
triggeringSourceEvent
Optional

The triggering source event of the action

array of object
actionObjectStatuses
Optional

Collection of statuses of tasks


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/actions/{taskId}/status
On This Page
Actions Operations
POST
Perform Action
POST
Populate Action
GET
Get Action Status
GET
Get All Actions