ResourceDefinition

uris

/redfish/v1/TelemetryService

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	TelemetryService资源模型的OData描述信息
@odata.id	string	true	-	TelemetryService资源节点的访问路径
@odata.type	string	true	-	TelemetryService资源类型
MaxReports	number	true	-	支持的最大指标报告数
MetricDefinitions {	object	true	-	指标项相关信息
`MetricDefinitions.@odata.id`	string	false	-	指定对象的资源路径
}
MetricReportDefinitions {	object	true	-	指标报告定义相关信息
`MetricReportDefinitions.@odata.id`	string	false	-	指定对象的资源路径
}
MetricReports {	object	true	-	指标报告相关信息
`MetricReports.@odata.id`	string	false	-	指定对象的资源路径
}
Triggers {	object	true	-	触发器相关信息
`Triggers.@odata.id`	string	false	-	指定对象的资源路径
}
MinCollectionInterval	string	true	-	最小采集时间间隔
ServiceEnabled	boolean	false	true,false	遥测服务使能状态
SupportedCollectionFunctions[ ]	array	true	Average,Maximum,Minimum,Summation	针对指标支持的算法 ● Average：求均值 ● Maximum：求最大值 ● Minimum：求最小值 ● Summation：求总和
Actions {	object	true	-	遥测服务可执行的操作
Actions.#TelemetryService.ClearMetricReports {	object	true	-	清除指标报告
Actions.#TelemetryService.ClearMetricReports.target	string	true	-	操作路径
`Actions.#TelemetryService.ClearMetricReports.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
}
Actions.#TelemetryService.ResetMetricReportDefinitionsToDefaults {	object	true	-	将指标报告定义重置为默认状态
`Actions.#TelemetryService.ResetMetricReportDefinitionsToDefaults.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
Actions.#TelemetryService.ResetMetricReportDefinitionsToDefaults.target	string	true	-	操作路径
}
Actions.#TelemetryService.ResetTriggersToDefaults {	object	true	-	将触发器重置为默认状态
`Actions.#TelemetryService.ResetTriggersToDefaults.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
Actions.#TelemetryService.ResetTriggersToDefaults.target	string	true	-	操作路径
}
Actions.#TelemetryService.SubmitTestMetricReport {	object	true	-	提交测试指标报告
`Actions.#TelemetryService.SubmitTestMetricReport.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
Actions.#TelemetryService.SubmitTestMetricReport.target	string	true	-	操作路径
}
}
Id	string	true	-	遥测服务资源的ID
Name	string	true	-	遥测服务资源的名称
SchemaComplianceMode	string	true	-	TelemetryService相关资源显示模式

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询遥测服务资源信息

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/TelemetryService

请求头:

text


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

请求头：

text


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

请求消息体：无

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#TelemetryService.TelemetryService",
"@odata.id": "/redfish/v1/TelemetryService",
"@odata.type": "#TelemetryService.v1_3_4.TelemetryService",
"MaxReports": 32,
"MetricDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions"
},
"MetricReportDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions"
},
"MetricReports": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReports"
},
"MinCollectionInterval": "PT0H0M10S",
"ServiceEnabled": true,
"SupportedCollectionFunctions": [
"Average",
"Maximum",
"Minimum",
"Summation"
],
"Triggers": {
"@odata.id": "/redfish/v1/TelemetryService/Triggers"
},
"Actions": {
"#TelemetryService.ClearMetricReports": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.ClearMetricReports",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/ClearMetricReportsActionInfo"
},
"#TelemetryService.ResetMetricReportDefinitionsToDefaults": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.ResetMetricReportDefinitionsToDefaults",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/ResetMetricReportDefinitionsToDefaultsActionInfo"
},
"#TelemetryService.ResetTriggersToDefaults": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.ResetTriggersToDefaults",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/ResetTriggersToDefaultsActionInfo"
},
"#TelemetryService.SubmitTestMetricReport": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/SubmitTestMetricReportActionInfo"
}
}
}

响应码：200

PATCH

命令功能

修改遥测服务资源信息

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/TelemetryService

请求头:

text


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

请求消息体:

json

{
"ServiceEnabled": ServiceEnabled_value
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
ServiceEnabled	服务使能开关	true, false

使用指南

无

使用实例

请求样例：

http

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

请求头：

text


X-Auth-Token: 4b9d8666c671a55def97bf146b727dac
Content-Type: application/json
If-Match: W/"06348C97"

请求消息体：

json

{
"ServiceEnabled": false
}

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#TelemetryService.TelemetryService",
"@odata.id": "/redfish/v1/TelemetryService",
"@odata.type": "#TelemetryService.v1_3_4.TelemetryService",
"MaxReports": 32,
"MetricDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions"
},
"MetricReportDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions"
},
"MetricReports": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReports"
},
"MinCollectionInterval": "PT0H0M10S",
"ServiceEnabled": false,
"SupportedCollectionFunctions": [
"Average",
"Maximum",
"Minimum",
"Summation"
],
"Triggers": {
"@odata.id": "/redfish/v1/TelemetryService/Triggers"
},
"Actions": {
"#TelemetryService.ClearMetricReports": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.ClearMetricReports",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/ClearMetricReportsActionInfo"
},
"#TelemetryService.ResetMetricReportDefinitionsToDefaults": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.ResetMetricReportDefinitionsToDefaults",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/ResetMetricReportDefinitionsToDefaultsActionInfo"
},
"#TelemetryService.ResetTriggersToDefaults": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.ResetTriggersToDefaults",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/ResetTriggersToDefaultsActionInfo"
},
"#TelemetryService.SubmitTestMetricReport": {
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport",
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/SubmitTestMetricReportActionInfo"
}
}
}

响应码：200

POST (ACTION)

SubmitTestMetricReport

命令功能

提交测试指标报告上报

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport

请求头:

text


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

请求消息体:

json

{
"MetricReportName": metric_report_name,
"GeneratedMetricReportValues": [
{
"MetricId": metric_id,
"Timestamp": time_stamp,
"MetricProperty": metric_property,
"MetricValue": metric_value,
"MetricDefinition": metric_definition
}
]
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
metric_report_name	上报指标名称	必选，字符串
metric_id	指标Id	可选，字符串
time_stamp	时间戳	可选，字符串，格式：^[0-9]{4}(-[0-9]{2}){2}T([0-9]{2}😃{2}[0-9]{2}Z$
metric_property	指标属性	可选，字符串，长度1-512
metric_value	指标值	可选，字符串，长度1-64
metric_definition	指标定义	可选，对象

使用指南

无

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport>

请求头：

text


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

请求消息体：

json

{
"MetricReportName": "TestMetricReport",
"GeneratedMetricReportValues": [
{
"MetricId": "AverageReadingCelsius",
"Timestamp": "2020-12-06T12:00:00Z",
"MetricProperty": "/redfish/v1/Chassis/Tray_1/Thermal#/Temperatures/0/ReadingCelsius",
"MetricValue": "50",
"MetricDefinition": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/AverageReadingCelsius"
}
}
]
}

响应样例：

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

POST (ACTION)

ClearMetricReports

命令功能

清除指标报告

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/TelemetryService/Actions/TelemetryService.ClearMetricReports

请求头:

text


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

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

无

使用指南

无

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/TelemetryService/Actions/TelemetryService.ClearMetricReports>

请求头：

text


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

请求消息体：

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

POST (ACTION)

ResetMetricReportDefinitionsToDefaults

命令功能

恢复指标报告定义到默认值

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/TelemetryService/Actions/TelemetryService.ResetMetricReportDefinitionsToDefaults

请求头:

text


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

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

无

使用指南

无

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/TelemetryService/Actions/TelemetryService.ResetMetricReportDefinitionsToDefaults>

请求头：

text


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

请求消息体：

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

POST (ACTION)

ResetTriggersToDefaults

命令功能

恢复触发器到默认值

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/TelemetryService/Actions/TelemetryService.ResetTriggersToDefaults

请求头:

text


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

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

无

使用指南

无

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/TelemetryService/Actions/TelemetryService.ResetTriggersToDefaults>

请求头：

text


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

请求消息体：

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

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

SubmitTestMetricReport ​

POST (ACTION) ​

ClearMetricReports ​

POST (ACTION) ​

ResetMetricReportDefinitionsToDefaults ​

POST (ACTION) ​

ResetTriggersToDefaults ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

SubmitTestMetricReport

POST (ACTION)

ClearMetricReports

POST (ACTION)

ResetMetricReportDefinitionsToDefaults

POST (ACTION)

ResetTriggersToDefaults