GET – MetricDefinition inventory properties
Use the GET method to retrieve each MetricDefinition info.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/TelemetryService/MetricDefinitions/{Id}
Response body
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| Id | String | The identifier of this resource. | ||||||
| Description | String | “The metadata information about a metric.” | ||||||
| Name | String | The name of this resource. | ||||||
| MetricType | String | The type of metric. | ||||||
| Implementation | String | The implementation of the metric. | ||||||
| PhysicalContext | String | The physical context of the metric. | ||||||
| MetricDataType | String | The data type of the metric. | ||||||
| Units | String | The units of measure for this metric. | ||||||
| CalculationAlgorithm | String | The calculation that is performed on a source metric to obtain the metric being defined. | ||||||
| CalculationTimeInterval | String | The time interval over which the metric calculation is performed. | ||||||
| IsLinear | Boolean | An indication of whether the metric values are linear versus non-linear. | ||||||
| Calculable | String | An indication of whether the metric can be used in a calculation. | ||||||
| Wildcards | Array | The wildcards and their substitution values for the entries in the MetricProperties array property. | ||||||
| MetricProperties | Array | The list of URIs with wildcards and property identifiers that this metric definition defines. | ||||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"Wildcards": [
{
"Name": "PWild",
"Values": [
"0",
"1",
"2",
"3"
]
}
],
"CalculationTimeInterval": "PT1S",
"Description": "The metadata information about a metric.",
"MetricType": "Numeric",
"PhysicalContext": "PowerSupply",
"CalculationAlgorithm": "Average",
"Name": "AveragePowerSupplyInput",
"IsLinear": true,
"MetricDataType": "Integer",
"Id": "AveragePowerSupplyInput",
"MetricProperties": [
"/redfish/v1/Chassis/1/Power#/PowerSupplies/{PWild}/PowerInputWatts"
],
"@odata.etag": "\"31db0d95174de283fa99ca3a69891e2c\"",
"Calculable": "NonSummable",
"Implementation": "Calculated",
"@odata.type": "#MetricDefinition.v1_0_3.MetricDefinition",
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/AveragePowerSupplyInput",
"Units": "W"
}