cPanel API 2 Functions - LVEInfo::getUsage - Knowledgebase

Description

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

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Get LVE usage on example.com.

$get_lve_usage = $cpanel->api2(

'LVEInfo', 'getUsage'

);

LiveAPI Perl Module

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',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username LVEInfo getUsage

Notes:

You must URI-encode values.
username represents your account-level username.

Output (JSON)

{

"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

}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Parameter	Type	Description	Possible values	Example
from	string	The 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
to	integer	The 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
ID	string	The account's username.	Any valid username.	user
aCPU	integer	The account's average CPU usage.	An integer with any of the following symbols: G — Gigabytes M — Megabytes K — Kilobytes	2.0G
mCPU	string	The account's maximum CPU usage percentage.	A positive integer.	28
lCPU	integer	The account's CPU usage limit percentage.	A positive integer.	100
aEP	integer	The number of the account's Entry Processes.	A positive integer.	7
mEP	integer	The account's maximum number of Entry Processes.	A positive integer.	15
lEP	integer	The account's Entry Process limit.	A positive integer.	20
aVMem	integer	The account's average virtual memory usage limit, in bytes.	A positive integer.	2147
mVmem	integer	The account's maximum level of virtual memory, in bytes.	A positive integer.	2147483
lVMem	integer	The account's virtual memory usage limit, in bytes.	A positive integer.	2147483648
mpcpu	integer	The package's maximum CPU usage percentage.	A positive integer.	28
VMemF	integer	The number of the account's Out of Memory errors.	A positive integer	1
EPf	integer	The number of the account's Entry Process errors.	A positive integer.	1
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories