Skip to main content

GET – MetricReport properties

Use the GET method to retrieve each MetricReport info.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/TelemetryService/MetricReports/{Id}

Response body

FieldTypeDescription

Id

String

The identifier of this resource.

Description

String

The metric definitions used to create a metric report.

Name

String

The name of this resource.

Timestamp

String

The time associated with the metric report in its entirety.

MetricReportDefinition

Link

The definitions in the metric report.

MetricValues

Array

An array of metric values for the metered items of this Metric.

 

MetricValues[N]

Object

A metric Value.

  

MetricDefinition

Link

The link to the metric.

  

MetricId

String

The metric definitions identifier for this metric.

  

MetricProperty

String

The URI for the property from which this metric is derived.

  

MetricValue

String

The metric value, as a string.

  

Timestamp

String

The time when the metric is obtained.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"Name": "PowerMetrics",
"MetricValues": [
{
"MetricValue": "242",
"Timestamp": "2020-03-21T09:34:30+00:00",
"MetricProperty": "/redfish/v1/Chassis/1/Power#/PowerControl/0/PowerMetrics/MaxConsumedWatts"
},
{
"MetricValue": "223",
"Timestamp": "2020-03-21T09:34:30+00:00",
"MetricProperty": "/redfish/v1/Chassis/1/Power#/PowerControl/0/PowerMetrics/MinConsumedWatts"
},
{
"MetricValue": "230",
"Timestamp": "2020-03-21T09:34:30+00:00",
"MetricProperty": "/redfish/v1/Chassis/1/Power#/PowerControl/0/PowerMetrics/AverageConsumedWatts"
},
...
],
"MetricReportDefinition": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/PowerMetrics"
},
"Id": "PowerMetrics",
"Timestamp": "2020-03-21T09:34:57+00:00",
"@odata.etag": "\"e941767245f49ddcf2707ee0ba3f9252\"",
"@odata.type": "#MetricReport.v1_2_0.MetricReport",
"Description": "The metric definitions used to create a metric report.",
"MetricValues@odata.count": 25920,
"@odata.id": "/redfish/v1/TelemetryService/MetricReports/PowerMetrics"
}