文档中心
JobsCollection
更新时间： 2026/06/26
在Gitcode上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/JobService/Jobs

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-Jobs资源模型的OData描述信息
@odata.idstringtrue-Jobs资源节点的访问路径
@odata.typestringtrue-Jobs资源类型
Namestringfalse-Jobs资源的名称
Members@odata.countnumbertrue-任务总数
Membersarraytrue-Job任务集合
Members[].@odata.idstringtrue-Job任务对象的详情链接

supported_methods ​

  • GET
  • POST

HTTP methods ​

GET ​

命令功能

查询编排任务集合信息

说明

BMC300 5.8.0.1及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/JobService/Jobs

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

无

使用实例

请求样例：

http
GET https://device_ip/redfish/v1/JobService/Jobs

请求头：

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

请求消息体：无

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#JobCollection.JobCollection",
  "@odata.id": "/redfish/v1/JobService/Jobs",
  "@odata.type": "#JobCollection.JobCollection",
  "Name": "JobCollection",
  "Description": "A Collection of Job resource instances",
  "Members@odata.count": 1,
  "Members": [
    {
      "@odata.id": "/redfish/v1/JobService/Jobs/JID_42950489620"
    }
  ]
}

响应码：200

POST (CREATE) ​

命令功能

创建编排任务

说明

BMC300 5.8.0.1及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/JobService/Jobs

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
  "CreatedBy": "baron",
  "Schedule": {
    "EnabledDaysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "InitialStartTime": "2026-01-01T01:00:00+06:00",
    "Lifetime": "P4D",
    "MaxOccurrences": 3,
    "Name": "Scheduled Nightly Reboot of the rack",
    "RecurrenceInterval": "P1D"
  },
  "HidePayload": false,
  "Payload": {
    "JsonBody": "{\"Diagnose\":[{\"DeviceType\":\"NIC\",\"Mode\":\"Quick\"}]}"
  },
  "StartTime": "2026-04-01T00:00:01+6:00",
  "Oem": {
    "Public": {
      "JobType": "SPDiagnose"
    }
  }
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
CreatedBy创建者可选，长度范围[1,128]
Schedule定义持续执行的任务可选
EnabledDaysOfWeek每周的哪一天生效，Every表示每天都生效可选，支持的参数包括：
● Monday
● Tuesday
● Wednesday
● Thursday
● Friday
● Saturday
● Sunday
● Every
InitialStartTime最早触发时间可选，时间格式"2018-04-01T00:00:01+06:00"
Lifetime整体过期时间可选，表示持续xx天xx小时xx分钟，字符串正则格式："^P(\d+D)?(T(\d+H)?(\d+M)?)$"
MaxOccurrences最大执行的次数可选
Name名称可选，长度范围[1,128]
RecurrenceInterval最近两次连续执行任务的时间间隔可选，表示间隔xx天xx小时xx分钟，字符串正则格式："^P(\d+D)?(T(\d+H)?(\d+M)?)$"
最小间隔时间为PT15M
HidePayload是否隐藏Payload的显示可选
Payload--
JsonBody任务执行的参数，字符串类型（对象序列化后的数据）可选，长度范围[0,2048]
StartTimeJob计划执行的时间可选，注意这里不是创建的时间，该属性和Schedule有以下联系：
● 当未配置Schedule和StartTime属性，创建的任务立即执行，且执行一次，StartTime刷新为开始执行的时间
● 当未配置Schedule属性，但配置了StartTime属性，则任务在StartTime时刻开始执行，且执行一次
● 当配置了Schedule属性，该StartTime属性为计算属性（即使配置了也无效），通过Schedule的配置计算出下次任务待执行的时间
Oem自定义属性-
JobType任务类型必选

使用指南

无

使用实例

请求样例：

http
POST https://device_ip/redfish/v1/JobService/Jobs

请求头：

X-Auth-Token: 123456789***********************
Content-Type: application/json

请求消息体：

json
{
  "CreatedBy": "baron",
  "Schedule": {
    "EnabledDaysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "InitialStartTime": "2026-01-01T01:00:00+06:00",
    "Lifetime": "P4D",
    "MaxOccurrences": 3,
    "Name": "Scheduled Nightly Reboot of the rack",
    "RecurrenceInterval": "P1D"
  },
  "HidePayload": false,
  "Payload": {
    "JsonBody": "{\"Diagnose\":[{\"DeviceType\":\"NIC\",\"Mode\":\"Quick\"}]}"
  },
  "StartTime": "2026-04-01T00:00:01+6:00",
  "Oem": {
    "Public": {
      "JobType": "SPDiagnose"
    }
  }
}

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#JobService.Job",
  "@odata.id": "/redfish/v1/JobService/Jobs/JID_43031012380",
  "@odata.type": "#Job.v1_2_4.Job",
  "Id": "JID_43031012380",
  "Name": "Job of SPDiagnose",
  "CreatedBy": "baron",
  "JobStatus": "OK",
  "JobState": "Pending",
  "StartTime": "2026-04-01T02:00:01+08:00",
  "Messages": [],
  "PercentComplete": 0,
  "Schedule": {
    "Lifetime": "P4D",
    "InitialStartTime": "2026-01-01T03:00:00+08:00",
    "RecurrenceInterval": "P1D",
    "EnabledDaysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "MaxOccurrences": 3,
    "Name": "Scheduled Nightly Reboot of the rack"
  },
  "HidePayload": false,
  "Payload": {
    "JsonBody": "{\"Diagnose\":[{\"DeviceType\":\"NIC\",\"Mode\":\"Quick\"}]}"
  },
  "Oem": {
    "Public": {
      "JobType": "SPDiagnose",
      "CreateTime": "2025-05-23T21:49:32+08:00",
      "ExecutedTimes": 0
    }
  }
}

响应码：200