ResourceDefinition

uris

/redfish/v1/TaskService/Tasks/taskid

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	指定任务资源模型的OData描述信息
@odata.id	string	true	-	指定任务资源的访问路径。您可以访问该资源，获取该任务的详细信息。
@odata.type	string	true	-	指定任务资源的类型
Id	string	true	-	指定任务资源的ID
Name	string	true	-	指定任务资源的名称
Description	string	true	-	任务描述
TaskState	string	true	New,Starting,Running,Suspended,Interrupted,Pending,Stopping,Completed,Killed,Exception,Service	指定任务资源的状态。 ● New：新建 ● Starting：启动中 ● Running：运行中 ● Suspended：已挂起 ● Interrupted：已中断 ● Pending：待处理 ● Stopping：停止中 ● Completed：已完成 ● Killed：已终止 ● Exception：异常 ● Service：服务中
TaskStatus	string	true	OK,Warning,Major,Critical	指定任务的完成状态。 ● OK：正常 ● Warning：警告 ● Major：主要 ● Critical：严重
StartTime	string	true	-	任务的起始时间
EndTime	string	true	-	任务完成的日期和时间。此属性仅在任务完成后才会显示。
EstimatedDuration	string	true	^P(\d+D)?(T(\d+H)?(\d+M)?(\d+S)?)?$	预估任务完成总时间。当前仅一键收集、配置导入导出、固件升级的任务支持该属性。比如PT4M表示预估完成时间为4分钟
Messages {	object	true	-	任务相关消息
`Messages.@odata.type`	string	true	-	消息资源的OData描述信息
Messages.MessageId	string	true	-	信息编号
Messages.RelatedProperties[ ]	array	true	-	任务属性描述
Messages.Message	string	true	-	任务信息
Messages.MessageArgs[ ]	array	true	-	任务的详细信息
Messages.Severity	string	true	OK,Warning,Critical	错误严重级别，包括： ● OK：正常 ● Warning：警告 ● Critical：严重
Messages.Resolution	string	true	-	解决任务状态的处理建议
Messages.MessageSeverity	string	true	OK,Warning,Critical	错误严重级别，包括： ● OK：正常 ● Warning：警告 ● Critical：严重
}
PercentComplete	number	true	-	任务完成的百分比进度
SubTasks {	object	true	-	指向此任务的子任务集合的链接。该属性仅在含有子任务资源时才会显示。说明 openUBMC 26.03及以上版本支持
`SubTasks.@odata.id`	string	true	-	子任务集合资源链接。说明 openUBMC 26.03及以上版本支持
}
Oem {	object	true	-	自定义属性
Oem.Public {	object	true	-	自定义属性
Oem.Public.TaskPercentage	string	true	-	任务完成进度
}
}

supported_methods

HTTP methods

GET

命令功能

查询指定任务资源信息

命令格式

URL: https://device_ip/redfish/v1/TaskService/Tasks/taskid

请求头:

text


X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
auth_value	执行该GET请求时，必须在"Headers"中携带"X-Auth-Token"值用于鉴权	可通过/redfish/v1/SessionService/Sessions创建会话时获得
taskid	待查询任务的ID	可从任务集合资源中获得

使用指南

无

使用实例

请求样例：

http

GET <https://device_ip/redfish/v1/TaskService/Tasks/16>

请求头：

text


X-Auth-Token: 123456789***********************

请求消息体：无

任务未完成时的响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#Task.Task",
"@odata.type": "#Task.v1_0_2.Task",
"@odata.id": "/redfish/v1/TaskService/Tasks/8",
"Id": "8",
"Name": "Upgarde Task",
"Description"："",
"TaskStatus": "OK",
"TaskState": "Running",
"StartTime": "2000-03-02T11:09:02+00:00",
"EstimatedDuration"："PT4M"
"Messages": [],

"PercentComplete": 8,
"SubTasks": {
"@odata.id": "/redfish/v1/TaskService/Tasks/8/SubTasks"
},
"Oem": {
"Public": {
"TaskPercentage": "8%"
}
}
}

响应码：200

任务完成时的响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#Task.Task",
"@odata.type": "#Task.v1_0_2.Task",
"@odata.id": "/redfish/v1/TaskService/Tasks/8",
"Id": "8",
"Name": "Upgarde Task",
"Description": "",
"TaskState": "Completed",
"TaskStatus": "OK",
"StartTime": "2000-03-02T11:09:02+00:00",
"EndTime": "2000-03-02T11:13:02+00:00",
"EstimatedDuration": "PT4M",
"Messages": {
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "iBMC.1.0.DumpingOK",
"RelatedProperties": [],
"Message": "Successfully collected the dump information file.",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None",
"MessageSeverity": "OK"
},
"PercentComplete": 100,
"SubTasks": {
"@odata.id": "/redfish/v1/TaskService/Tasks/8/SubTasks"
},
"Oem": {
"Public": {
"TaskPercentage": "100%"
}
}
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET