Task
更新时间: 2026/06/26
在Gitcode上查看源码

ResourceDefinition

uris

  • /redfish/v1/TaskService/Tasks/taskid

properties

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-指定任务资源模型的OData描述信息
@odata.idstringtrue-指定任务资源的访问路径。您可以访问该资源,获取该任务的详细信息。
@odata.typestringtrue-指定任务资源的类型
Idstringtrue-指定任务资源的ID
Namestringtrue-指定任务资源的名称
Descriptionstringtrue-任务描述
TaskStatestringtrueNew,Starting,Running,Suspended,Interrupted,Pending,Stopping,Completed,Killed,Exception,Service指定任务资源的状态。
● New
● Starting
● Running
● Suspended
● Interrupted
● Pending
● Stopping
● Completed
● Killed
● Exception
● Service
TaskStatusstringtrueOK,Warning,Major,Critical指定任务的完成状态。
● OK
● Warning
● Major
● Critical
StartTimestringtrue-任务的起始时间
EndTimestringtrue-任务完成的日期和时间。此属性仅在任务完成后才会显示。
EstimatedDurationstringtrue^P(\d+D)?(T(\d+H)?(\d+M)?(\d+S)?)?$预估任务完成总时间。当前仅一键收集、配置导入导出、固件升级的任务支持该属性。比如PT4M表示预估完成时间为4分钟
Messagesobjecttrue-任务相关消息
Messages.@odata.typestringtrue-消息资源的OData描述信息
Messages.MessageIdstringtrue-信息编号
Messages.RelatedPropertiesarraytrue-任务属性描述
Messages.Messagestringtrue-任务信息
Messages.MessageArgsarraytrue-任务的详细信息
Messages.SeveritystringtrueOK,Warning,Critical错误严重级别,包括:
● OK
● Warning
● Critical
Messages.Resolutionstringtrue-解决任务状态的处理建议
Messages.MessageSeveritystringtrueOK,Warning,Critical错误严重级别,包括:
● OK
● Warning
● Critical
PercentCompletenumbertrue-任务完成的百分比进度
SubTasksobjecttrue-指向此任务的子任务集合的链接。该属性仅在含有子任务资源时才会显示。
说明:BMC500 5.13.0.1及以上版本支持
SubTasks[].@odata.idstringtrue-子任务集合资源链接。
说明:BMC500 5.13.0.1及以上版本支持
Oemobjecttrue-自定义属性
Oem.Publicobjecttrue-自定义属性
Oem.Public.TaskPercentagestringtrue-任务完成进度

supported_methods

  • GET

HTTP methods

GET

命令功能

查询指定任务资源信息

命令格式

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

请求头:


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

请求头:


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