Child pages
  • WHM API 1 Functions - loadavg

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function retrieves the server's load average.

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/loadavg?api.version=1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/loadavg?api.version=1
Expand
titleCommand Line
Note
titleNote:

This function is not available through the command line. Instead, use WHM API 1's systemloadavg function.

 

 

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
   "one":"0.17",
   "five":"0.18",
   "fifteen":"0.19"
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<loadavg>
       <one>0.17</one>
       <five>0.18</five>
       <fifteen>0.19</fifteen>
</loadavg>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
onestring

The server's load average over the previous minute.

A decimal number.

For example, a value of .18 represents 18% of a single CPU's processor capacity.

0.17
fivestringThe server's load average over the previous five minutes.

A decimal number.

For example, a value of .18 represents 18% of a single CPU's processor capacity.

0.18
fifteenstringThe server's load average over the previous fifteen minutes.

A decimal number.

For example, a value of .18 represents 18% of a single CPU's processor capacity.

0.19