GET – MetricReportDefinition properties
Use the GET method to retrieve each MetricReportDefinition info.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/TelemetryService/MetricReportDefinitions/{Id}
Response body
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| Id | String | The identifier of this resource. | ||||||
| Description | String | “A set of metrics that are collected into a metric report.” | ||||||
| Name | String | The name of this resource. | ||||||
| ReportTimespan | String | Specifies the timespan duration of the metric report. | ||||||
| MetricReportDefinitionType | String | Specifies when the metric report is generated. | ||||||
| ReportActions | Array | The set of actions to perform when a metric report is generated. | ||||||
| ReportUpdates | String | “AppendWrapsWhenFull” if this property exists. | ||||||
| AppendLimit | Integer | 25920 if this property exists. | ||||||
| Metrics | Array | The list of metrics to include in the metric report. | ||||||
| Metrics[1] | Object | Specifies a metric to include in the metric report. | ||||||
| MetricProperties | String | The set of URIs for the properties on which this metric is collected. | ||||||
| CollectionTimeScope | String | The scope of time scope over which the function is applied. | ||||||
| CollectionDuration | String | The duration over which the function is computed. | ||||||
| Wildcards | Array | The set of wildcards and their substitution values for the entries in the MetricProperties property. | ||||||
| Status | Object | The status for this resource. | ||||||
| State | String | The state for this resource. | ||||||
| MetricReport | String | The location where the resultant metric report is placed. | ||||||
| Schedule | Object | The schedule for generating the metric report. | ||||||
| RecurrenceInterval | String | The amount of time until the next occurrence occurs. | ||||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following examples JSON response describe the PowerMetrics and PowerMetricsEvent.
{
"Wildcards": [
{
"Name": "PWild",
"Values": [
"0",
"1",
"2"
]
}
],
"ReportUpdates": "AppendWrapsWhenFull",
"Metrics": [
{
"MetricProperties": [
"/redfish/v1/Chassis/1/Power#/PowerControl/{PWild}/PowerMetrics/MaxConsumedWatts",
"/redfish/v1/Chassis/1/Power#/PowerControl/{PWild}/PowerMetrics/AverageConsumedWatts",
"/redfish/v1/Chassis/1/Power#/PowerControl/{PWild}/PowerMetrics/MinConsumedWatts"
],
"CollectionTimeScope": "Interval",
"CollectionDuration": "PT30S"
}
],
"Description": "A set of metrics that are collected into a metric report.",
"Name": "PowerMetrics",
"ReportTimespan": "PT24H",
"Id": "PowerMetrics",
"@odata.etag": "\"648d59955bddcc7f09232753f8ea5f4b\"",
"AppendLimit": 25920,
"ReportActions": [
"LogToMetricReportsCollection"
],
"MetricReport": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReports/PowerMetrics"
},
"@odata.type": "#MetricReportDefinition.v1_3_0.MetricReportDefinition",
"Status": {
"State": "Enabled"
},
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/PowerMetrics",
"MetricReportDefinitionType": "OnRequest"
}
{
"Wildcards": [
{
"Name": "PWild",
"Values": [
"0",
"1",
"2"
]
}
],
"ReportTimespan": "PT10M",
"Metrics": [
{
"MetricProperties": [
"/redfish/v1/Chassis/1/Power#/PowerControl/{PWild}/PowerMetrics/MaxConsumedWatts",
"/redfish/v1/Chassis/1/Power#/PowerControl/{PWild}/PowerMetrics/AverageConsumedWatts",
"/redfish/v1/Chassis/1/Power#/PowerControl/{PWild}/PowerMetrics/MinConsumedWatts"
],
"CollectionTimeScope": "Interval",
"CollectionDuration": "PT30S"
}
],
"Description": "A set of metrics that are collected into a metric report.",
"Name": "PowerMetricsEvent",
"Schedule": {
"RecurrenceInterval": "PT10M"
},
"Id": "PowerMetricsEvent",
"@odata.etag": "\"ffb0baa73f2c9f39bb6fa63236a919d7\"",
"ReportActions": [
"RedfishEvent"
],
"@odata.type": "#MetricReportDefinition.v1_3_0.MetricReportDefinition",
"Status": {
"State": "Enabled"
},
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/PowerMetricsEvent",
"MetricReportDefinitionType": "Periodic"
}