Child pages
  • cPanel API 2 Functions - Bandwidth::gethourlyaveragebwoveryear

Versions Compared

Key

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

 

Description

Excerpt

This function returns an account's average hourly peak bandwidth use for one year.

Warning
titleWarning:

We removed this function in cPanel & WHM version 11.52. We strongly recommend that you use the following UAPI function instead of this function:

  • Bandwidth::query
    Excerpt Include
    UAPI Functions - Bandwidth::query
    UAPI Functions - Bandwidth::query
    nopaneltrue
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Bandwidth&cpanel_jsonapi_func=gethourlyaveragebwoveryear&types=all&cf=AVERAGE

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get bandwidth data for example.com.
$add_bandwidth = $cpanel->api2(
    'bandwidth', 'gethourlyaveragebwoveryear',
		array(
		'types'				=> 'all',
		'cf'				=> 'AVERAGE',
	)
  );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get bandwidth data for example.com.
my $get_bandwidth_data = $cpliveapi->api2(
	'Bandwidth', 'gethourlyaveragebwoveryear',
	{
		'types'				=> 'all',
		'cf'				=> 'AVERAGE',
    }	
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Expand
titleCommand Line
Warning
titleImportant:

Because we removed this function before we introduced this functionality, you cannot call this function via the command line. 

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "gethourlyaveragebwoveryear",
    "data": [
      {
        "ftp": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "smtp": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "http": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "pop3": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "imap": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ],
        "all": [
          [
            0,
            0
          ],
          [
            3600,
            0
          ],
          [
            7200,
            0
          ],
          [
            10800,
            0
          ],
          [
            14400,
            0
          ],
          [
            18000,
            0
          ],
          [
            21600,
            0
          ],
          [
            25200,
            0
          ],
          [
            28800,
            0
          ],
          [
            32400,
            0
          ],
          [
            36000,
            0
          ],
          [
            39600,
            0
          ],
          [
            43200,
            0
          ],
          [
            46800,
            0
          ],
          [
            50400,
            0
          ],
          [
            54000,
            0
          ],
          [
            57600,
            0
          ],
          [
            61200,
            0
          ],
          [
            64800,
            0
          ],
          [
            68400,
            0
          ],
          [
            72000,
            0
          ],
          [
            75600,
            0
          ],
          [
            79200,
            0
          ],
          [
            82800,
            0
          ]
        ]
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Bandwidth"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
typesstring

Required

The bandwidth type.

  • http
  • ftp
  • smtp
  • pop3
  • imap
  • all
all
cfstring

The RRD consolidation function.

If you do not specify a consolidation function, this value defaults to AVERAGE.

  • AVERAGE The average of the available data points.  
  • MIN The smallest of the available data points.
  • MAX — The largest of the available data points.
  • LAST — The last available data points.
AVERAGE

Returns

ReturnTypeDescriptionPossible valuesExample
allintegerThe amount of total bandwidth.A positive integer, in bits.18000,0
ftpintegerThe amount of FTP bandwidth.A positive integer, in bits.28800,0
httpintegerThe amount of HTTP bandwidth.A positive integer, in bits.27800,0
imapintegerThe amount of IMAP bandwidth.A positive integer, in bits.25300,0
pop3integerThe amount of Pop3 bandwidth.A positive integer, in bits.23200,0
smtpintegerThe amount of SMTP bandwidth.A positive integer, in bits.21600,0
reasonstring

A message of success of a reason for failure.

 

A string that describes the system's action or the error. This is an error message.
resultBoolean

Whether the function succeeded.

 

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