CPU
/cluster/node/{nodeNumber}/resourceMonitoring/cpu/{granularity}/
This report provides total CPU utilization of the particular node. The report contains a collection of properties for each and every time slot, defined by the frequency within a given time period and by either the start and end times or the maximum logging period for the given frequency.
Table 237 Properties
Description Property
The number of the node of interest nodeNumber
The sampling granularity (5sec, min, hour) granularity
Read
GET /cluster/node/{nodeNumber}/resourceMonitoring/cpu/{granularity}/
No authorization is needed for the Read operation.
Table 238 Request Parameters
New in Version Description
Type Property
2.0 ISO8601 timestamp identifiying the start point for the sample to be returned Datetime
(string) startTime
2.0 ISO8601 timestamp identify the end point for the sample to be returned Datetime
(string) endTime
Table 239 Response Properties
New in Version Description
Type Property
2.0 CPU usage as a percentage
Double cpuUsage
2.0 UTC ISO 8601 datetime string for the sample
Datetime (string) timestamp
On Success this call will return 200 OK.
Error messages are returned in the following cases:
• 400 Bad Request
If no frequency is specified – “A frequency must be specified.”
◦
◦
If an invalid frequency is specified – “Invalid frequency specified: {granularity}”◦
If startTime is omitted – “Request does not specify all required parameters”◦
If startTime is badly formatted – “Invalid start point provided: {startTime}”◦
If endTime is badly formatted – “Invalid end point provided: {endTime}”◦
If endTime is prior to startTime – “endTime [{endTime}] is before startTime [{startTime}]”◦
If the requested range falls outside the available range – “requested range [{startTime}-> {endTime}] is outside of available range [{firstAvailable} -> {lastAvailable}]”
• 500 Internal Server Error
If an internal error occurs – “Internal error”
CPU 183
Memory
/cluster/node/{nodeNumber}/resourceMonitoring/memory/{granularity}/
This report provides total memory utilization of the particular node. The report contains a collection of properties for each and every time slot, defined by the frequency within a given time period and by either the start and end times or the maximum logging period for the given frequency.
Table 240 Properties
Description Property
The number of the node of interest nodeNumber
The sampling granularity (5sec, min, hour) granularity
Read
GET /cluster/node/{nodeNumber}/resourceMonitoring/memory/{granularity}/
No authorization is needed for the Read operation.
Table 241 Request Parameters
New in Version Description
Type Property
2.0 ISO8601 timestamp identifiying the start point for the sample to be returned Datetime
(string) startTime
2.0 ISO8601 timestamp identify the end point for the sample to be returned Datetime
(string) endTime
Table 242 Response Properties
New in Version Description
Type Property
2.0 Total physical memory on the node
Integer physicalRAM
2.0 CPU usage as a percentage
Double memoryUsage
2.0 UTC ISO 8601 datetime string for the sample
Datetime (string) timestamp
On Success this call will return 200 OK.
Error messages are returned in the following cases:
• 400 Bad Request
If no frequency is specified – “A frequency must be specified.”
◦
◦
If an invalid frequency is specified – “Invalid frequency specified: {granularity}”◦
If startTime is omitted – “Request does not specify all required parameters”◦
If startTime is badly formatted – “Invalid start point provided: {startTime}”◦
If endTime is badly formatted – “Invalid end point provided: {endTime}”◦
If endTime is prior to startTime – “endTime [{endTime}] is before startTime [{startTime}]”◦
If the requested range falls outside the available range – “requested range [{startTime}-> {endTime}] is outside of available range [{firstAvailable} -> {lastAvailable}]”
• 500 Internal Server Error
If an internal error occurs – “Internal error”
Disk
/cluster/node/{nodeNumber}/resourceMonitoring/disk/{granularity}/
This reports provides total block utilization by the given node. The report contains a collection of properties for each and every time slot, defined by the frequency within a given time period and by either the start and end times or the maximum logging period for the given frequency.
Table 243 Properties
Description Property
The number of the node of interest nodeNumber
The sampling granularity (5sec, min, hour) granularity
Read
GET /cluster/node/{nodeNumber}/resourceMonitoring/disk/{granularity}/
No authorization is needed for the Read operation.
Table 244 Request Parameters
New in Version Description
Type Property
2.0 ISO8601 timestamp identifiying the start point for the sample to be returned Datetime
(string) startTime
2.0 ISO8601 timestamp identify the end point for the sample to be returned Datetime
(string) endTime
Table 245 Response Properties
New in Version Description
Type Property
2.0 Percentage utilization of the block
devices Double
diskUsage
2.0 Number of bytes read per second from disk subsystem
Double readBytesPerSecond
2.0 Number of bytes written per second on disk subsystem
Double writeBytesPerSecond
2.0 UTC ISO 8601 datetime string for the sample
Datetime (string) timestamp
On Success this call will return 200 OK.
Error messages are returned in the following cases:
• 400 Bad Request
If no frequency is specified – “A frequency must be specified.”
◦
◦
If an invalid frequency is specified – “Invalid frequency specified: {granularity}”◦
If startTime is omitted – “Request does not specify all required parameters”◦
If startTime is badly formatted – “Invalid start point provided: {startTime}”◦
If endTime is badly formatted – “Invalid end point provided: {endTime}”Disk 185
◦
If endTime is prior to startTime – “endTime [{endTime}] is before startTime [{startTime}]”◦
If the requested range falls outside the available range – “requested range [{startTime}-> {endTime}] is outside of available range [{firstAvailable} -> {lastAvailable}]”
• 500 Internal Server Error
If an internal error occurs – “Internal error”
Ethernet (external network connections only)
/cluster/node/{nodeNumber}/resourceMonitoring/network/{granularity}/
This reports provides total utilization of each of the external ethernet ports on the given node.
The report contains a collection of properties for each and every time slot, defined by the frequency within a given time period and by either the start and end times or the maximum logging period for the given frequency.
Table 246 Properties
Description Property
The number of the node of interest nodeNumber
The sampling granularity (5sec, min, hour) granularity
Read
GET /cluster/node/{nodeNumber}/resourceMonitoring/network/{granularity}/
No authorization is needed for the Read operation.
Table 247 Request Parameters
New in Version Description
Type Property
2.0 ISO8601 timestamp identifiying the start point for the sample to be returned Datetime
(string) startTime
2.0 ISO8601 timestamp identify the end point for the sample to be returned Datetime
(string) endTime
Table 248 Response Properties
New in Version Description
Type Property
2.0 Ethernet port on the node eth0, eth1, etc.
String ethernetPort
2.0 Number of bytes received per second by the port
Double receiveRate
2.0 Number of bytes transmitted per second from the port
Double transmitRate
2.0 UTC ISO 8601 datetime string for the sample
Datetime (string) timestamp
On Success this call will return 200 OK.
Error messages are returned in the following cases:
• 400 Bad Request
If no frequency is specified – “A frequency must be specified.”
◦
◦
If an invalid frequency is specified – “Invalid frequency specified: {granularity}”◦
If startTime is omitted – “Request does not specify all required parameters”◦
If startTime is badly formatted – “Invalid start point provided: {startTime}”◦
If endTime is badly formatted – “Invalid end point provided: {endTime}”◦
If endTime is prior to startTime – “endTime [{endTime}] is before startTime [{startTime}]”◦
If the requested range falls outside the available range – “requested range [{startTime}-> {endTime}] is outside of available range [{firstAvailable} -> {lastAvailable}]”
• 500 Internal Server Error
If an internal error occurs – “Internal error”
Ethernet (external network connections only) 187