Energy monitoring RAW API
This API is used to retrieve the RAW metrics for Energy Monitoring of a Managed System. The RAW metrics data is collected from the Flexible Service Processor (FSP) and it is collected at every collection interval (30 seconds). The metrics data is retained in HMC for 30 minutes. After 30 minutes, the data is completely purged from the system. The RAW data is used to generate the Processed and Aggregated metrics by further rolling up.
The collection of Raw metrics job runs every 30 seconds. It starts at xx:xx:00 and continues at xx:xx:30, and so on. If the Raw collection process gets errors for five consecutive times, the collection is paused for 15 minutes and then is resumed automatically.
Resource
/rest/api/pcm/ManagedSystem/<ManagedSystemUuid>/RawMetrics/EnergyMonitor/rest/api/pcm/ManagedSystem/<ManagedSystemUuid>/RawMetrics/EnergyMonitor?
StartTS=yyyy-MM-dd’T’hh:mm:ssZ&EndTS= yyyy-MM-dd’T’hh:mm:ssZ| Quick property | Description | Format |
|---|---|---|
| StartTS | The start time stamp is an optional parameter. If specified, the API returns the available Energy metrics from the specified time. | yyyy-MM-dd'T'HH:mm:ssZ |
| EndTS | The end time stamp is an optional parameter. If specified, the API returns available Energy metrics on or before the specified time. | yyyy-MM-dd'T'HH:mm:ssZ |
| Method | Description | Internet media type |
|---|---|---|
| GET | This API is used to retrieve the energy monitoring metrics for a managed system. | application/xml |
Response
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:ns2="http://a9.com/-/spec/opensearch/1.1/"
xmlns:ns3="http://www.w3.org/1999/xhtml">
<id>FEED_UNIQUE_ID</id>
<updated>YYYY-MM-DDThh:mm:ss.sssZ</updated>
<title type="text">EnergyMonitorMetrics</title>
<subtitle type="text">ManagedSystem MANAGED_SYSTEM_UUID</subtitle>
<link rel="self" href="https://HMC_IP_OR_HOST_NAME/rest/api/pcm/ManagedSystem/
MANAGED_SYSTEM_UUID/RawMetrics/EnergyMonitor"/>
<generator uri="IBM Power Systems Management Console" version="1"/>
<entry>
<id>ENTRY_UNIQUE_ID</id>
<updated>YYYY-MM-DDThh:mm:ss.sssZ</updated>
<title type="text">LTM_MANAGED_SYSTEM_MTMS_fsp_ yyyyMMDDThhmmss +0000.json</title>
<published>YYYY-MM-DDThh:mm:ss.sssZ</published>
<link type="application/vnd.ibm.powervm.pcm.json" href="https://HMC_IP_OR_HOST_NAME:
443/rest/api/pcm/ManagedSystem/MANAGED_SYSTEM_UUID/RawMetrics/EnergyMonitor/
FILE_NAME.json"/>
<author>
<name>IBM Power Systems Management Console</name>
</author>
<category term="fsp"/>
</entry>
<entry>
<id>ENTRY_UNIQUE_ID</id>
<updated>YYYY-MM-DDThh:mm:ss.sssZ</updated>
<title type="text">LTM_MANAGED_SYSTEM_MTMS_fsp_ yyyyMMDDThhmmss +0000.json</title>
<published>YYYY-MM-DDThh:mm:ss.sssZ</published>
<link type="application/vnd.ibm.powervm.pcm.json" href="https://HMC_IP_OR_HOST_NAME:
443/rest/api/pcm/ManagedSystem/MANAGED_SYSTEM_UUID/RawMetrics/EnergyMonitor/
FILE_NAME.json"/>
<author>
<name>IBM Power Systems Management Console</name>
</author>
<category term="fsp"/>
</entry>
</feed>
Successful execution of the request is returned with response code 200. In response, the application returns feed and entries.
Each entries have the link to the RAW metric data that is provided in the JSON format. See JSON specification for Energy monitoring RAW metrics to view the JSON specification for the Energy RAW metrics.
