LogService
更新时间: 2026/07/01
在Gitcode上查看源码

ResourceDefinition

uris

  • /redfish/v1/Managers/manager_id/LogServices/logservices_id

properties

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue指定日志服务资源模型的OData描述信息
@odata.idstringtrue指定日志服务资源的访问路径
@odata.typestringtrue指定日志服务资源的类型
Idstringtrue指定日志服务资源的ID
Namestringtrue指定日志服务资源的名称
MaxNumberOfRecordsnumbertrue指定日志服务资源的最大可记录日志条数
OverWritePolicystringtrue指定日志服务资源的覆盖策略
● Unknown
● WrapsWhenFull
● NeverOverWrites
DateTimestringtrue指定日志服务资源的系统时间
DateTimeLocalOffsetstringtrue指定日志服务资源的时区
ServiceEnabledbooleantrue指定日志服务资源的启用状态
● true
● false
#LogService.ExportLogobjecttrue导出日志操作
targetstringtrue导出日志操作的访问路径
@Redfish.ActionInfostringtrue导出日志操作的查询路径
Entriesobjecttrue日志集合资源的访问路径
Descriptionstringtrue任务描述
TaskStatestringtrue任务执行状态
● New
● Starting
● Running
● Suspended
● Interrupted
● Pending
● Stopping
● Completed
● Killed
● Exception
● Service
TaskStatusstringtrue指定任务的完成状态。
● OK
● Warning
● Major
● Critical
StartTimestringtrue任务的起始时间
Messagesarraytrue任务相关的消息
PercentCompletestringtrue任务完成的百分比进度。
TaskPercentagestringtrue任务执行的进度

supported_methods

  • GET
  • POST

HTTP methods

GET

命令功能

查询指定日志服务资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/LogServices/logservices_id

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
auth_value请求消息的鉴权参数可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

该资源已屏蔽属性频繁变化导致的事件上报。

使用实例

请求样例: GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/logservices_id

X-Auth-Token: auth_value 请求消息体:无

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/LogServices/Members/$entity",
  "@odata.id": "/redfish/v1/Managers/1/LogServices/OperateLog",
  "@odata.type": "#LogService.v1_0_3.LogService",
  "Id": "OperateLog",
  "Name": "Operate Log",
  "MaxNumberOfRecords": 456,
  "OverWritePolicy": "WrapsWhenFull",
  "DateTime": "2018-08-30T17:42:17+00:00",
  "DateTimeLocalOffset": "GMT",
  "ServiceEnabled": true,
  "Actions": {
    "Oem": {
      "Public": {
        "#LogService.ExportLog": {
          "target": "/redfish/v1/Managers/1/LogServices/OperateLog/Actions/Oem/Public/LogService.ExportLog",
          "@Redfish.ActionInfo": "/redfish/v1/Managers/1/LogServices/OperateLog/ExportLogActionInfo"
        }
      }
    }
  },
  "Entries": {
    "@odata.id": "/redfish/v1/Managers/1/LogServices/OperateLog/Entries"
  }
}

响应码:200

POST (ACTION)

ExportLog

命令功能

导出日志信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/LogServices/logservices_id/Actions/Oem/Public/LogService.ExportLog

请求头:

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

请求消息体:

json
{
  "Type": type_value,
  "Content": Content
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
type_value导出类型● URI
Content导出文件路径● 操作路径
● 1、本地导出:“/tmp/ 文件路径”
● 2、远程导出:“文件传输协议://用户名:密码@ip地址/目录/文件名” 文件传输协议包括五种:sftp、https、nfs、cifs、scp

使用指南

使用实例

请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/LogServices/logservices_id/Actions/Oem/Public/LogService.ExportLog

X-Auth-Token: auth_value Content-Type: header_type 请求消息体:

json
{
  "Type": type_value,
  "Content": Content
}

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "1",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-05-09T16:57:14+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码:202

POST (ACTION)

ClearLog

命令功能

清空日志信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/LogServices/EventLog/Actions/LogService.ClearLog

请求头:

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

请求消息体:

json
{}

请求头参数说明

参见 请求头参数说明

请求体参数说明

使用指南

使用实例

请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/LogServices/EventLog/Actions/LogService.ClearLog

X-Auth-Token: auth_value Content-Type: header_type 请求消息体:

json
{}

响应样例:

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