跳到主要内容

GET – 任务属性

使用 GET 方法检索 Redfish 服务的 Task 资源中的属性。

请求 URL

GET https://<BMC_IPADDR>/redfish/v1/TaskService/Tasks/{Id}

请求正文

响应正文

字段类型描述

Id

字符串

Id 属性用于唯一标识此任务资源。

Name

字符串

Task {Id}

Description

字符串

“This resource represents a task for a Redfish implementation.”

TaskState

字符串

任务的状态。

StartTime

字符串

上次启动任务的日期时间戳。

EndTime

字符串

上次完成任务的日期时间戳。

Messages

对象

已展开。

 

Messages[N]

字符串

与任务关联的消息。

PercentComplete

整数

此属性应指示任务的完成进度(以完成百分比进行报告)。

TaskStatus

字符串

任务的完成状态。

TaskState 和 TaskStatus 之间的映射关系:
  • “Completed”(TaskState)–>“OK”(TaskStatus)

  • “Killed”(TaskState)–>“Warning”(TaskStatus)

  • “Exception”(TaskState)–>“Warning”(TaskStatus)

  • 其他(TaskState)–> 不公开 TaskStatus(TaskStatus)

TaskMonitor

链接

此任务的任务监控器的 URI。这是在 TaskState 为 Completed、Exception 或 Killed 时用于删除任务的 URI。

HidePayload

布尔

此属性应指示在创建任务后是否应隐藏有效负载的内容。

状态代码

HTTP 状态代码错误消息 ID
500InternalError

示例

返回以下示例 JSON 响应:

{
"@odata.context": "/redfish/v1/$metadata#Task.Task",
"@odata.etag": "\"0B755D5E\"",
"@odata.id": "/redfish/v1/TaskService/Tasks/1",
"@odata.type": "#Task.v1_4_3.Task",
"Description": "This resource represents a task for a Redfish implementation.",
"EndTime": "2024-11-30T05:49:59+00:00",
"HidePayload": true,
"Id": "1",
"Messages": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The task with Id '1' has started.",
"MessageArgs": [
"1"
],
"MessageId": "TaskEvent.1.0.3.TaskStarted",
"MessageSeverity": "OK",
"Resolution": "None."
},
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The task with Id '1' has completed.",
"MessageArgs": [
"1"
],
"MessageId": "TaskEvent.1.0.3.TaskCompletedOK",
"MessageSeverity": "OK",
"Resolution": "None."
}
],
"Name": "Task 1",
"PercentComplete": 100,
"StartTime": "2024-11-30T05:46:48+00:00",
"TaskMonitor": "/redfish/v1/TaskService/TaskMonitors/1",
"TaskState": "Completed",
"TaskStatus": "OK"
}