Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

POST method for EnergyConsumption

Description

This method returns the energy consumption of the device in KWH.

Privilege

VIEW

HTTP response codes

201

Example request body

{
   "PluginId": "2F6D05BE-EE4B-4B0E-B873-C8D2F64A4625",
   "EntityType": 0,
   "EntityId": 10395,
   "Duration": 4
}

Example response body

{
    "TotalEnergy": "0.044"
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
PluginId	ID of a plug-in.
EntityType	Entity Type ID
EntityId	ID of an entity, only device.
Duration	Duration ID
Total Energy	Energy Consumption in KWH.

Table 2. Entity Type IDsThis table lists entity type IDs with their corresponding values
Entity Type ID	Entity Value
0	Device
1	Static/ Physical Group
2	Virtual Machine Group
3	Virtual Machine

Table 3. Duration supported for Entity Type 0,1,2This table lists the durations supported by devices, static/ physical groups and virtual machine groups.
Duration ID	Value
1	One hour
2	Six hours
3	Twelve hours
4	One day
5	One week
6	Two weeks
7	One month
8	Three months
9	Six months
10	One year

Table 4. Duration supported for Entity Type 3This table lists the durations supported by virtual machines
Duration ID	Value
1	One hour
2	Six hours
3	Twelve hours
4	One day
5	One week
6	One month
7	Three months
8	Six months
9	One year