ResourceDefinition

uris

/redfish/v1/JobService/Jobs/{job_id}

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	Job资源模型的OData描述信息
@odata.id	string	true	-	Job资源节点的访问路径
@odata.type	string	true	-	Job资源类型
Id	string	true	-	Job资源的Id
Name	string	false	-	Job资源的名称
CreatedBy	string	true	-	创建此任务条目的人员或程序
JobStatus	string	true	OK,Warning	Job资源的状态，默认为OK，JobService关闭时待执行任务返回Warning
JobState	string	false	Cancelled,Completed,Exception,Pending,Running	Job执行状态 ● Cancelled：取消执行 ● Completed：执行完成 ● Exception：执行异常 ● Pending：执行等待 ● Running：正在运行
StartTime	string	true	-	启动或计划启动任务的日期和时间
EndTime	string	true	-	Job执行结束时间，仅JobState为Completed、Cancelled、Exception时展示
Messages	array	true	-	与任务关联的消息数组
Messages[].Message	string	true	-	错误信息内容
Messages[].MessageId	string	true	-	错误信息Id
Messages[].MessageArgs	array	true	-	错误信息的参数
PercentComplete	number	true	-	此任务的完成百分比
Schedule	object	false	-	任务计划的设置
Schedule.Lifetime	string	true	-	整体过期时间
Schedule.InitialStartTime	string	false	-	最早触发时间
Schedule.RecurrenceInterval	string	false	-	连续执行任务的间隔时间
Schedule.EnabledDaysOfWeek	string	false	-	每周生效日期，不设置默认全周生效
Schedule.MaxOccurrences	string	false	-	最大执行的次数
Schedule.Name	string	false	-	名称
HidePayload	boolean	true	true,false	是否隐藏Payload的显示
Payload	object	true	-	-
Payload.JsonBody	string	true	-	执行任务所用的JSON负载
Oem	object	true	-	自定义属性
JobType	string	true	-	Job的类型
CreateTime	string	true	-	Job创建时间
ExecuteTimes	number	true	-	Job已经执行的次数

supported_methods

GET
PATCH
DELETE

HTTP methods

GET

命令功能

查询指定编排任务信息

说明

BMC300 5.8.0.1及以上版本支持

命令格式

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

请求头:

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/JID_43031012380

请求头：

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

请求消息体：无

响应样例：

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

PATCH

命令功能

修改指定编排任务信息

说明

BMC300 5.8.0.1及以上版本支持

命令格式

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

请求头:

X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
  "JobState": "Cancelled",
  "Schedule": {
    "EnabledDaysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "InitialStartTime": "2018-01-01T01:00:00+06:00",
    "MaxOccurrences": 5,
    "Name": "Scheduled Nightly Reboot of the rack",
    "RecurrenceInterval": "P1D"
  }
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET操作，从响应头中获取（对应于"ETag"参数）
JobState	Job执行状态	可选，支持修改的Job状态： ● Cancelled
Schedule	任务调度规则	可选，定义持续执行的任务
Lifetime	整体过期时间	可选，表示持续xx天xx小时xx分钟，字符串正则格式："^P(\d+D)?(T(\d+H)?(\d+M)?)$"
InitialStartTime	最早触发时间	可选，时间格式"2018-04-01T00:00:01+06:00"
RecurrenceInterval	最近两次连续执行任务的时间间隔	可选，表示间隔xx天xx小时xx分钟，字符串正则格式："^P(\d+D)?(T(\d+H)?(\d+M)?)$" 最小间隔时间为PT15M
EnabledDaysOfWeek	每周的哪一天生效	可选，支持的参数包括： ● Monday ● Tuesday ● Wednesday ● Thursday ● Friday ● Saturday ● Sunday ● Every
MaxOccurrences	最大执行的次数	可选
Name	名称	可选，长度范围[1,128]

使用指南

无

使用实例

请求样例：

http

PATCH https://device_ip/redfish/v1/JobService/Jobs/JID_43031012380

请求头：

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

请求消息体：

json

{
  "JobState": "Cancelled",
  "Schedule": {
    "EnabledDaysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "InitialStartTime": "2026-01-01T03:00:00+08:00",
    "MaxOccurrences": 5,
    "Name": "Scheduled Nightly Reboot of the rack",
    "RecurrenceInterval": "P1D"
  }
}

响应样例：

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": "Cancelled",
  "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": 5,
    "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

DELETE

命令功能

删除指定编排任务信息

说明

BMC300 5.8.0.1及以上版本支持

命令格式

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

请求头:

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

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
auth_value	执行该DELETE请求时，必须在"Headers"中携带"X-Auth-Token"值用于鉴权	可通过/redfish/v1/SessionService/Sessions创建会话时获得
header_type	请求消息的格式	支持的消息格式包括： ● application/json ● application/json;charset=utf-8

使用指南

无

使用实例

请求样例：

http

DELETE https://device_ip/redfish/v1/JobService/Jobs/JID_42950489620

请求头：

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

请求消息体：无

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

输出说明

参见 DELETE 通用输出说明

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

DELETE ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

DELETE