任务管理

2.6.1查看任务详细信息

接口地址

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

接口描述

根据任务ID查询任务详细信息。E0930版本新增接口。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
msgId	任务ID	path	true	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiTaskMsgDetailVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiTaskMsgDetailVO	ApiTaskMsgDetailVO
msgId	任务ID	integer(int64)
name	任务名称	string
targetId	操作目标ID（如虚拟机ID、主机ID等）	integer(int64)
targetName	任务执行对象名称（如虚拟机、主机等）	string
detail	任务描述	string
completed	任务是否完成	boolean
result	执行结果。当任务执行完成后，返回该字段。0：成功；1：失败；2：部分成功	integer(int32)
progress	任务进度（单位：%）	integer(int32)
failMsg	失败原因。当任务执行完成后，返回该字段。当任务成功时返回成功的描述信息	string
eventType	事件类型。枚举：1201-增加虚拟机，21-删除虚拟机，23-增加虚拟机设备 24-删除虚拟机设备，25-修改虚拟机设备，30-启动虚拟机，31-关闭虚拟机电源，32-关闭虚拟机，33-重启虚拟机，1203-克隆虚拟机，1202-部署虚拟机等等。	integer(int32)
start	任务开始时间（ms）	string(date-time)
complete	任务完成时间（ms）	string(date-time)
refreshData	若需要刷新，才返回此结果	array	ApiRefreshData
key	需要刷新的数据类型。1：云资源，2：数据中心，3：主机，4：集群，5：虚拟机，6：虚拟机UUID	string
value	数据对象ID（如虚拟机ID）	string
keyValue	拓展结果实体类	array	ApiKeyValue
key	返回的结果名称（如虚拟机状态字段）	string
value	返回的结果值（如虚拟机状态结果）	string

响应示例

{

"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

}

]

}

}