Skip to main content
Contact Us

OpenManage Enterprise 3.10 RESTful API Guide

PDF

GET method for specific metric report definitions

This method fetches information about a specific metric report definition.

Description
Returns information about a specific metric report definition.
Privilege
VIEW
HTTP response codes
200
Example response body 
{
    "@odata.type": "#MetricReportDefinition.v1_3_0.MetricReportDefinition",
    "@odata.context": "/redfish/v1/$metadata#MetricReportDefinition.MetricReportDefinition",
    "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/PSUMetrics",
    "Id": "PSUMetrics",
    "Name": "PSU MRD",
    "Description": "PSU Metrics",
    "AppendLimit": 2400,
    "MetricReportDefinitionEnabled": true,
    "MetricReportDefinitionType": "Periodic",
    "MetricReportDefinitionType@Redfish.AllowableValues": [
        "Periodic",
        "OnChange",
        "OnRequest"
    ],
    "MetricReportHeartbeatInterval": "PT0H1M0S",
    "SuppressRepeatedMetricValue": true,
    "ReportTimespan": "PT0H0M0S",
    "ReportUpdates": "Overwrite",
    "ReportUpdates@Redfish.AllowableValues": [
        "AppendStopsWhenFull",
        "AppendWrapsWhenFull",
        "NewReport",
        "Overwrite"
    ],
    "ReportActions": [
        "RedfishEvent",
        "LogToMetricReportsCollection"
    ],
    "ReportActions@odata.count": 2,
    "ReportActions@Redfish.AllowableValues": [
        "LogToMetricReportsCollection",
        "RedfishEvent"
    ],
    "Status": {
        "State": "Enabled"
    },
    "Wildcards": [],
    "Wildcards@odata.count": 0,
    "Schedule": {
        "RecurrenceInterval": "PT0H1M0S"
    },
    "MetricReport": {
        "@odata.id": "/redfish/v1/TelemetryService/MetricReports/PSUMetrics"
    },
    "Metrics": [
        {
            "MetricId": "PSUInputVoltage",
            "MetricProperties": [],
            "CollectionFunction": null,
            "CollectionDuration": null,
            "CollectionTimeScope": "Point",
            "Oem": {
                "Dell": {
                    "@odata.type": "#DellMetricReportDefinition.v1_0_0.DellMetricReportDefinition",
                    "FQDD": null,
                    "Source": null
                }
            }
        },
        {
            "MetricId": "PSUInputCurrent",
            "MetricProperties": [],
            "CollectionFunction": null,
            "CollectionDuration": null,
            "CollectionTimeScope": "Point",
            "Oem": {
                "Dell": {
                    "@odata.type": "#DellMetricReportDefinition.v1_0_0.DellMetricReportDefinition",
                    "FQDD": null,
                    "Source": null
                }
            }
        }
    ],
    "Metrics@odata.count": 2,
    "Links": {
        "Triggers": []
    }
}
NOTE:When creating or modifying a metric report definition, the attributes, Name, AppendLimit, Status, Wildcards, and MetricProperties are read-only.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\