GET – Telemetry service properties
Use the GET method to retrieve properties in Telemetry service resource for Redfish service.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/TelemetryService
Request body
None
Response body
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
Description | String | This resource shall be used to represent a Metrics Service for a Redfish implementation. | ||||||
Id | String | TelemetryService | ||||||
Name | String | Telemetry Service | ||||||
ServiceEnabled | Boolean | If FoD is 2 or higher, the value is true, otherwise is false. | ||||||
SupportedCollectionFunctions | Array | "Average", "Minimum", or "Maximum" | ||||||
Status | Object | The status of the telemetry service. | ||||||
State | String | The state of the telemetry service. | ||||||
Health | String | The health of the telemetry service. | ||||||
MetricDefinitions | Link | The link to the collection of metric definitions. | ||||||
MetricReportDefinitions | Link | The link to the collection of metric report definitions. | ||||||
MetricReports | Link | The link to the collection of metric reports. | ||||||
Actions | Object | Expanded. | ||||||
#TelemetryService.SubmitTestMetricReport | Object | This action generates a metric report. | ||||||
target | Link | Link to invoke action. | ||||||
title | String | SubmitTestMetricReport | ||||||
@Redfish.ActionInfo | Link | Link to the info of this action. | ||||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"@odata.context": "/redfish/v1/$metadata#TelemetryService.TelemetryService",
"@odata.etag": "\"05F8DACB\"",
"@odata.id": "/redfish/v1/TelemetryService",
"@odata.type": "#TelemetryService.v1_3_1.TelemetryService",
"Actions": {
"#TelemetryService.SubmitTestMetricReport": {
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/SubmitTestMetricReportActionInfo",
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport",
"title": "SubmitTestMetricReport"
}
},
"Description": "This resource shall be used to represent a Metrics Service for a Redfish implementation.",
"Id": "TelemetryService",
"MetricDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions"
},
"MetricReportDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions"
},
"MetricReports": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReports"
},
"Name": "Telemetry Service",
"ServiceEnabled": true,
"Status": {
"Health": "OK",
"State": "Enabled"
},
"SupportedCollectionFunctions": [
"Maximum",
"Minimum",
"Average"
]
}