Task management

2.6.1 Get task details

API endpoint

GET /NSphere/api/message-resource/{msgId}

API description

Get task details by task ID. New API added in E0930.

Request Content-Type

application/x-www-form-urlencoded

Response Content-Type

application/json

Request parameters

Parameter name	Description	Location	Required	Type	schema
msgId	Task ID.	path	true	integer(int64)

Response status

Response code	Description	schema
200	OK	ApiResponseApiTaskMsgDetailVO

Response parameters

Parameter name	Description	Type	schema
state	Status code. 0: success, 1: failure, 2: partial success.	integer(int32)	integer(int32)
errorCode	Error code. A non-zero value indicates a business error.	integer(int32)	integer(int32)
successMessage	Success message.	string
failureMessage	Error message. Valid when the result is failure or partial success.	string
data	Response data. When the status code is 0 this contains the normal returned data; when non-zero and non-empty it contains the data required to describe the exception.	ApiTaskMsgDetailVO	ApiTaskMsgDetailVO
msgId	Task ID.	integer(int64)
name	Task name.	string
targetId	Target object ID (e.g. VM ID, host ID).	integer(int64)
targetName	Name of the object on which the task is executed (e.g. VM, host).	string
detail	Task description.	string
completed	Whether the task has completed.	boolean
result	Execution result. Returned after the task completes. 0: success; 1: failure; 2: partial success.	integer(int32)
progress	Task progress (unit: %).	integer(int32)
failMsg	Failure reason. Returned after the task completes. Returns a success description when the task succeeds.	string
eventType	Event type. Enum: 1201 = add VM, 21 = delete VM, 23 = add VM device, 24 = delete VM device, 25 = modify VM device, 30 = start VM, 31 = power off VM, 32 = shut down VM, 33 = reboot VM, 1203 = clone VM, 1202 = deploy VM, etc.	integer(int32)
start	Task start time (ms).	string(date-time)
complete	Task completion time (ms).	string(date-time)
refreshData	Returned only when a refresh is required.	array	ApiRefreshData
key	Data type to refresh. 1: cloud resource, 2: data center, 3: host, 4: cluster, 5: VM, 6: VM UUID.	string
value	Data object ID (e.g. VM ID).	string
keyValue	Extended result entity.	array	ApiKeyValue
key	Returned result name (e.g. VM state field).	string
value	Returned result value (e.g. VM state value).	string

Response example

{
  "state": 0,
  "errorCode": 0,
  "successMessage": null,
  "failureMessage": null,
  "data": {
    "msgId": null,
    "name": null,
    "targetId": null,
    "targetName": null,
    "detail": null,
    "completed": true,
    "result": null,
    "progress": null,
    "failMsg": null,
    "eventType": null,
    "start": null,
    "complete": null,
    "refreshData": [
      {
        "key": null,
        "value": null
      }
    ],
    "keyValue": [
      {
        "key": null,
        "value": null
      }
    ]
  }
}

2.6.1 Get task details​

2.6.1 Get task details