Child pages
  • WHM API 1 Functions - systemloadavg

Versions Compared

Key

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

 

Description

Excerpt

This function retrieves the system'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/systemloadavg?api.version=1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/systemloadavg?api.version=1
Expand
titleCommand Line
Code Block
languagebash
whmapi1 systemloadavg

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
      "data":{
         "one":"0.17",
         "five":"0.18",
         "fifteen":"0.19"
      },
      "metadata":{
         "result":1,
         "reason":"OK",
         "version":1,
         "command":"systemloadavg"
      }
   }
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
   <data>
      <one>0.17</one>
      <five>0.18</five>
      <fifteen>0.19</fifteen>
   </data>
   <metadata>
      <result>1</result>
      <reason>OK</reason>
      <version>1</version>
      <command>systemloadavg</command>
   </metadata>
</result>

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