ResourceDefinition

uris

/redfish/v1/DataAcquisitionService

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	DataAcquisitionService资源模型的OData描述信息
@odata.id	string	true	-	DataAcquisitionService资源节点的访问路径
@odata.type	string	true	-	DataAcquisitionService资源类型
Id	string	true	-	DataAcquisitionService资源的ID
Name	string	true	-	DataAcquisitionService资源的名称
ServiceEnabled	boolean	false	true,false	数据采集服务开关状态
Health	string	true	-	数据采集服务健康状态
DataAcquisitionReport {	object	true	-	数据采集报告
`DataAcquisitionReport.@odata.id`	string	true	-	数据采集报告资源的访问路径
}
Actions {	object	true	-	DataAcquisitionService可执行的操作
Actions.#HwDataAcquisitionService.ExportAcquisitionData {	object	true	-	导出数据表操作
Actions.#HwDataAcquisitionService.ExportAcquisitionData.target	string	true	-	导出数据表操作的路径
`Actions.#HwDataAcquisitionService.ExportAcquisitionData.DataSource@Redfish.AllowableValues[ ]`	array	true	Metric,Tag,DataPoint	可导出的表名允许的参数，包括： ● DataPoint：数据点 ● Metric：指标 ● Tag：标签
`Actions.#HwDataAcquisitionService.ExportAcquisitionData.@Redfish.ActionInfo`	string	true	-	Action参数信息说明
}
Actions.#HwDataAcquisitionService.ClearHistoryData {	object	true	-	清除"数据采集点信息表"操作
Actions.#HwDataAcquisitionService.ClearHistoryData.target	string	true	-	清除"数据采集点信息表"操作的路径
`Actions.#HwDataAcquisitionService.ClearHistoryData.@Redfish.ActionInfo`	string	true	-	Action参数信息说明
}
Actions.#HwDataAcquisitionService.DataFiltering {	object	true	-	创建"数据采集点信息表"筛选任务的操作
Actions.#HwDataAcquisitionService.DataFiltering.target	string	true	-	创建"数据采集点信息表"筛选任务的路径
`Actions.#HwDataAcquisitionService.DataFiltering.@Redfish.ActionInfo`	string	true	-	Action参数信息说明
}
}

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询数据采集服务资源

说明

本资源受许可证控制，需要通过许可证授权后才能使用。

命令格式

URL: https://device_ip/redfish/v1/DataAcquisitionService

请求头:

text


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

请求头：

text


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

请求消息体：无

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#HwDataAcquisitionService.HwDataAcquisitionService",
"@odata.type": "#HwDataAcquisitionService.v1_0_0.HwDataAcquisitionService",
"@odata.id": "/redfish/v1/DataAcquisitionService",
"Id": "DataAcquisitionService",
"Name": "Data Acquisition Service",
"ServiceEnabled": true,
"Health": "OK",
"DataAcquisitionReport": {
"@odata.id": "/redfish/v1/DataAcquisitionService/DataAcquisitionReport"
},
"Actions": {
"#HwDataAcquisitionService.ExportAcquisitionData": {
"target": "/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.ExportAcquisitionData",
"DataSource@Redfish.AllowableValues": [
"Metric",
"Tag",
"DataPoint"
],
"@Redfish.ActionInfo": "/redfish/v1/DataAcquisitionService/ExportAcquisitionDataActionInfo"
},
"#HwDataAcquisitionService.ClearHistoryData": {
"target": "/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.ClearHistoryData",
"@Redfish.ActionInfo": "/redfish/v1/DataAcquisitionService/ClearHistoryDataActionInfo"
},
"#HwDataAcquisitionService.DataFiltering": {
"target": "/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.DataFiltering",
"@Redfish.ActionInfo": "/redfish/v1/DataAcquisitionService/DataFilteringActionInfo"
}
}
}

响应码：200

PATCH

命令功能

修改数据采集服务开关状态

说明

本资源受许可证控制，需要通过许可证授权后才能使用。

命令格式

URL: https://device_ip/redfish/v1/DataAcquisitionService

请求头:

text


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

请求消息体:

json

{
"ServiceEnabled": enable
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
ServiceEnabled	数据采集服务的开关状态	true：数据采集服务打开；false：数据采集服务关闭

使用指南

无

使用实例

请求样例：

http

PATCH <https://device_ip/redfish/v1/DataAcquisitionService>

请求头：

text


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

请求消息体：

json

{
"ServiceEnabled": false
}

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#HwDataAcquisitionService.HwDataAcquisitionService",
"@odata.type": "#HwDataAcquisitionService.v1_0_0.HwDataAcquisitionService",
"@odata.id": "/redfish/v1/DataAcquisitionService",
"Id": "DataAcquisitionService",
"Name": "Data Acquisition Service",
"ServiceEnabled": false,
"Health": "OK",
"DataAcquisitionReport": {
"@odata.id": "/redfish/v1/DataAcquisitionService/DataAcquisitionReport"
},
"Actions": {
"#HwDataAcquisitionService.ExportAcquisitionData": {
"target": "/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.ExportAcquisitionData",
"DataSource@Redfish.AllowableValues": [
"Metric",
"Tag",
"DataPoint"
],
"@Redfish.ActionInfo": "/redfish/v1/DataAcquisitionService/ExportAcquisitionDataActionInfo"
},
"#HwDataAcquisitionService.ClearHistoryData": {
"target": "/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.ClearHistoryData",
"@Redfish.ActionInfo": "/redfish/v1/DataAcquisitionService/ClearHistoryDataActionInfo"
},
"#HwDataAcquisitionService.DataFiltering": {
"target": "/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.DataFiltering",
"@Redfish.ActionInfo": "/redfish/v1/DataAcquisitionService/DataFilteringActionInfo"
}
}
}

响应码：200

POST (ACTION)

ExportAcquisitionData

命令功能

导出数据表

说明

openUBMC 25.12 LTS以上版本不再支持此功能。

命令格式

URL: https://device_ip/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.ExportAcquisitionData

请求头:

text


X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{
"DataSource": "data_source"
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
data_source	需要导出的表格名	Metric：监控项信息定义表；Tag：数据监控项主体信息表；DataPoint：数据采集点信息表

使用指南

无

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.ExportAcquisitionData>

请求头：

text


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

请求消息体：

json

{
"DataSource": "DataPoint"
}

响应样例：

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": "Export Task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2017-07-30T05:46:39+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}

响应码：200

POST (ACTION)

ClearHistoryData

命令功能

清空"数据采集点信息表"

说明

清空"数据采集点信息表"后，新数据需等待下一个周期采集完成。

命令格式

URL: https://device_ip/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.ClearHistoryData

请求头:

text


X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

无

使用指南

无

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.ClearHistoryData>

请求头：

text


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

请求消息体：

json

{}

响应样例：

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": "Clear Task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2017-07-30T05:46:39+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}

响应码：202

POST (ACTION)

DataFiltering

命令功能

创建数据表格筛选任务

命令格式

URL: https://device_ip/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.DataFiltering

请求头:

text


X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{
"AcquisitionItems": [
{
"ComponentType": componenttype,
"MetricType": [
metrictype
],
"StartTime": starttime,
"EndTime": endtime
}
]
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
componenttype	需要查询的部件名，未指定时默认查询所有部件	CPU、Memory、Disk、Mainboard、PSU、Chassis、System、Fan
metrictype	需要查询的指标类型，未指定时默认查询所有指标	Temperature：温度；Voltage：电压；Current：电流；Performance：部件性能指标（以上数据仅支持20分钟时间内的数据查询）；Health：内存的Health信息，可查询6小时以内的数据；Log：内存和系统的ErrorLog，可查询6小时以内的数据；硬盘的Log信息可查询24小时内的数据；Smart：硬盘的Smart信息，可查询6小时以内的数据
starttime	起始时间	时间戳
endtime	结束时间	时间戳

使用指南

openUBMC 25.12 LTS以上版本不再支持此功能。

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/DataAcquisitionService/Actions/HwDataAcquisitionService.DataFiltering>

请求头：

text


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

请求消息体：

json

{
"AcquisitionItems": [
{
"ComponentType": "CPU",
"MetricType": [
"Voltage",
"Performance"
],
"StartTime": 1559001600,
"EndTime": 1559002800
}
]
}

响应样例：

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": "Data Filtering Task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2017-07-30T05:46:39+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}

响应码：202

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

ExportAcquisitionData ​

POST (ACTION) ​

ClearHistoryData ​

POST (ACTION) ​

DataFiltering ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

ExportAcquisitionData

POST (ACTION)

ClearHistoryData

POST (ACTION)

DataFiltering