Skip to main content

GET – Metric Report Instance

Request​

GET https://{{ip}}/redfish/v1/TelemetryService/MetricReports/{{metric_report_instance}}
Content-Type: application/json

  1. The Metric Report Instance resource specifies the metric report that the Redfish service will create, corresponding to the Metric Report Definition.

  2. The Metric Reports are updated periodically based on the recurrence interval specified.

Response​

The response of the request will be in JSON format. The properties are mentioned in the following table.

Table 1. Metric Report Instance Properties

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

MetricReportDefinition

Object

True

The value shall be reference to the metric definition for this metric.

Timestamp

String

True

  1. This property represents time associated with the metric report in its entirety.

  2. This property shall contain the time when the metric report was generated.

ReportSequence

String

True

  1. This property will get updated each time when the Metric Report updates.

  2. When the ReportUpdates property for the MetricReportDefninition associated with the MetricReport is NewReport, then ReportSequence will be "1"always and for all other values of ReportUpdates, the ReportSequence will be incremented by 1 for each update in the MetricReport.

MetricValuesObject

True

The values shall be metric values for this MetricReport.

Property

Type

Description

MetricId

String

The value shall be the Identifier of the source metric within the associated MetricDefinition.

MetricValue

String

The value of the metric represented as a string.

TimeStamp

String

  1. The value shall be an ISO 8601 date time for when the metric value was computed.

  2. That this may be different from the time when this instance is created.

MetricProperty

String

The value shall be an OData conformant URI to a property contained in the scope of the MetricScope.

Request example​

GET https://{{ip}}/redfish/v1/TelemetryService/MetricReports/AverageTemperatureReport
Content-Type: application/json

Response example​

{
    "@odata.context": "/redfish/v1/$metadata#MetricReport.MetricReport",
    "@odata.etag": "\"1581503942\"",
    "@odata.id": "/redfish/v1/TelemetryService/MetricReports/AverageTemperatureReport",
    "@odata.type": "#MetricReport.v1_2_0.MetricReport",
    "Id": "AverageTemperatureReport",
    "MetricReportDefinition": {
      "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/AverageTemperatureReport"
    },
    "MetricValues": [
      {
        "MetricId": "AverageTemperature",
        "MetricProperty": "/redfish/v1/Chassis/Self/Thermal#/Temperatures/117_0/ReadingCelsius",
        "MetricValue": "0",
        "Timestamp": "2020-02-12T05:39:02+00:00"
      },
      {
        "MetricId": "AverageTemperature",
        "MetricProperty": "/redfish/v1/Chassis/Self/Thermal#/Temperatures/116_0/ReadingCelsius",
        "MetricValue": "0",
        "Timestamp": "2020-02-12T05:39:02+00:00"
      }
    ],
    "Name": "Average_Temperature_Report",
    "ReportSequence": "1",
    "Timestamp": "2020-02-12T05:39:02+00:00"
}