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

ResourceDefinition

uris

  • /redfish/v1/TaskService

properties

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-任务服务资源模型的OData描述信息
@odata.idstringtrue-当前任务资源的访问路径。您可以访问该资源,获取该任务的详细信息。
@odata.typestringtrue-任务服务资源的类型
Idstringtrue-任务服务资源的ID
Namestringtrue-指任务服务资源的名称
DateTimestringtrue-系统时间。已屏蔽该属性值频繁变化导致的事件上报
CompletedTaskOverWritePolicystringtrueOldest,Manual对已完成的任务的处理方法。
● Oldest:新任务覆盖最早的任务
● Manual:不进行覆盖
LifeCycleEventOnTaskStateChangebooleantruetrue,false任务状态变化时是否上报事件。
● true
● false
Statusobjecttrue-任务服务资源的状态,包括:
● State:使能状态
● Health:健康状态
● Severity:自定义健康状态
TaskAutoDeleteTimeoutMinutesnumberfalse-任务完成后的自动删除时间,单位是分钟。默认为10分钟。
说明:BMC300 5.12.0.1及以上版本支持
ServiceEnabledbooleantruetrue,false任务服务使能状态
Tasksobjecttrue-任务列表
Tasks[].@odata.idstringtrue-指定任务的访问路径

supported_methods

  • GET
  • PATCH

HTTP methods

GET

命令功能

查询任务服务资源信息

命令格式

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

请求头:


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

请求消息体: 无

参数说明

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

使用指南

使用实例

请求样例:

http
GET https://device_ip/redfish/v1/TaskService

请求头:


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

请求消息体:无

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#TaskService.TaskService",
  "@odata.id": "/redfish/v1/TaskService",
  "@odata.type": "#TaskService.v1_2_1.TaskService",
  "Id": "TaskService",
  "Name": "Tasks Service",
  "DateTime": "2016-07-10T11:50:19+00:00",
  "CompletedTaskOverWritePolicy": "Oldest",
  "LifeCycleEventOnTaskStateChange": false,
  "Status": {
    "State": "Enabled",
    "Oem": {
      "Public": {
        "Severity": "Informational"
      }
    },
    "Health": "OK"
  },
  "TaskAutoDeleteTimeoutMinutes": 10,
  "ServiceEnabled": true,
  "Tasks": {
    "@odata.id": "/redfish/v1/TaskService/Tasks"
  }
}

响应码:200

PATCH

命令功能

修改任务服务资源信息

说明

BMC300 5.12.0.1及以上版本支持

命令格式

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

请求头:


X-Auth-Token: 123456789***********************
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json
{
  "TaskAutoDeleteTimeoutMinutes": task_auto_delete_timeout_minutes
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
ifmatch_value请求消息的匹配参数可通过对相应资源发起GET操作,从响应头中获取(对应于"ETag"参数)
task_auto_delete_timeout_minutes任务完成后的自动删除时间取值范围为[10, 60],单位:分钟

使用指南

使用实例

请求样例:

http
PATCH https://device_ip/redfish/v1/TaskService

请求头:


X-Auth-Token: 123456789***********************
Content-Type: application/json
If-Match: W/"3d607e36"

请求消息体:

json
{
  "TaskAutoDeleteTimeoutMinutes": 20
}

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#TaskService.TaskService",
  "@odata.id": "/redfish/v1/TaskService",
  "@odata.type": "#TaskService.v1_2_1.TaskService",
  "Id": "TaskService",
  "Name": "Tasks Service",
  "DateTime": "2016-07-10T11:50:19+00:00",
  "CompletedTaskOverWritePolicy": "Oldest",
  "LifeCycleEventOnTaskStateChange": false,
  "Status": {
    "State": "Enabled",
    "Oem": {
      "Public": {
        "Severity": "Informational"
      }
    },
    "Health": "OK"
  },
  "TaskAutoDeleteTimeoutMinutes": 20,
  "ServiceEnabled": true,
  "Tasks": {
    "@odata.id": "/redfish/v1/TaskService/Tasks"
  }
}

响应码:200