Description

This function returns a CloudLinux™ system account's LVE information.

Examples


https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=LVEInfo&cpanel_jsonapi_func=getUsage

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get LVE usage on example.com. 
$get_lve_usage = $cpanel->api2(
    'LVEInfo', 'getUsage'
    
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get LVE usage on example.com.
my $get_lve_usage = $cpliveapi->api2(
    'LVEInfo', 'getUsage',
);

 

cpapi2 --user=username LVEInfo getUsage

{
  "cpanelresult": {
    "data": [
      {
        "From": "04-18 13:24",
        "To": "04-18 13:25",
		"ID": "user" 
        "aCPU": "2.0G",
        "mCPU": "28",
        "lCPU": "100",
		"aEP": "7"
        "mEP": "15",
        "lEP": "20",
		"aVMem": "2147"
		"mVMem': "2147483"
 		"lVMem": "2147483648",
		"VMemF": "1"
        "EPf": "1",


      }
    ],
    "module": "LVEInfo",
    "func": "getUsage",
    "apiversion": 2,
    "event": {
      "result": 1
    }
  }
}

Parameters

This function does not accept parameters.

Returns

ParameterTypeDescriptionPossible valuesExample
fromstringThe LVE information sample period's start time.

The date and time in MM-DD-HH:mm format, where:

  • MM represents the month.
  • DD represents the date.
  • HH represents the hour.
  • mm represents the minute.
04-17 13:24
tointegerThe LVE information sample period's finish time.

The date and time in MM-DD-HH:mm format, where:

  • MM represents the month.
  • DD represents the date.
  • HH represents the hour.
  • mm represents the minute.
04-18 13:25
IDstringThe account's username.Any valid username.
user
aCPU integerThe account's average CPU usage.

An integer with any of the following symbols:

  • G — Gigabytes
  • M — Megabytes
  • K — Kilobytes
2.0G
mCPUstringThe account's maximum CPU usage percentage.A positive integer.
28
lCPUintegerThe account's CPU usage limit percentage.A positive integer.100
aEPintegerThe number of the account's Entry Processes.A positive integer.7
mEPintegerThe account's maximum number of Entry Processes.A positive integer.15
lEPintegerThe account's Entry Process limit.A positive integer.20
aVMemintegerThe account's average virtual memory usage limit, in bytes.A positive integer.
2147
mVmemintegerThe account's maximum level of virtual memory, in bytes.A positive integer.
2147483
lVMemintegerThe account's virtual memory usage limit, in bytes.A positive integer.2147483648
mpcpuintegerThe package's maximum CPU usage percentage.A positive integer.28
VMemFintegerThe number of the account's Out of Memory errors.A positive integer1
EPfintegerThe number of the account's Entry Process errors.A positive integer.1
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1