Skip to main content

GET – Collection of MetricDefinition

Use the GET method to retrieve the properties MetricDefinition collection resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/TelemetryService/MetricDefinitions

Request body​

None

Response body​

FieldTypeDescription

Members

Array

Items: A reference link of the elements of MetricDefinition

Name

String

MetricDefinitions

Description

String

A Collection of MetricDefinition resource instances.

Note
Collection of “MetricDefinition” may contain members below:

  • AveragePowerSupplyInput

  • AveragePowerSupplyOutput

  • AverageCPUUtilization (not support on Lenovo AMD systems)

  • AverageMemoryUtilization (not support on Lenovo AMD systems)

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#MetricDefinitionCollection.MetricDefinitionCollection",
    "@odata.etag": "\"EE5B291D\"",
    "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions",
    "@odata.type": "#MetricDefinitionCollection.MetricDefinitionCollection",
    "Description": "A Collection of MetricDefinition resource instances.",
    "Members": [
        {
            "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/AveragePowerSupplyInput"
        },
        {
            "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/AveragePowerSupplyOutput"
        },
        {
            "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/AverageCPUUtilization"
        },
        {
            "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/AverageMemoryUtilization"
        }
    ],
    "Members@odata.count": 4,
    "Name": "MetricDefinitions"
}