Difference between revisions of "API: Traffic usage"

From BrainyCP
Jump to: navigation, search
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
+
 
−
 
+
<div data-placeholder="Перевод" dir="ltr">Administrative functions require API root rights in order to use any login hosted on the server. If you do not have root rights, you can only use your login.</div> <div data-placeholder="Перевод" dir="ltr">Incoming data marked with an asterisk are required.</div>
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.
 
−
 
 
 
{| border="1" cellpadding="5"
 
{| border="1" cellpadding="5"
 
|-
 
|-
−
| <p dir="ltr" style="text-align: center;">'''Модуль'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Module'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Функция'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Incoming data'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Варианты ошибок'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Error variants'''</p>  
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 15: Line 13:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Массив потребления трафика для пользователя.
+
Massive of traffic usage per user.
  
 
show_trafic
 
show_trafic
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">traffic_usage (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_trafic (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Traffic consumption';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'No average load statistics';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid date format. Example 01-01-2016 '.</div>
 +
|}
 +
 
 +
Other useful articles:
 +
 
 +
{| style="width: 992px;"
 +
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
 +
 
 +
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
 +
 
 +
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
 +
 
 +
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
 +
 
 +
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
 +
 
 +
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
 +
 
 +
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
 +
 
 +
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
 +
 
 +
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
 +
 
 +
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
 +
 
 +
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
 +
 
 +
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
 +
 
 +
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
 +
 
 +
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
 +
 
 +
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
 +
 
 +
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
 +
 
 +
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
 +
 
 +
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
 +
 
 +
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
 +
 
 +
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
 +
 
 +
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
 +
 
 +
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
 +
 
 +
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
password (post или get)* — пароль пользователя;
+
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
−
traffic_usage (post или get)* — константа, имя модуля;
+
|-
 +
| style="width: 310px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
show_trafic (post или get)* — константа, имя операции;
+
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
error:0, mess:'Потребление трафика';
+
| style="width: 310px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
error:100, mess:'Статистики средней нагрузки нет';
+
| style="width: 311px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
error:101, mess:'Неправильный формат даты. Пример 01-01-2016'.
+
| style="width: 349px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}
 +
 +
&nbsp;

Latest revision as of 14:18, 17 November 2021

 

Administrative functions require API root rights in order to use any login hosted on the server. If you do not have root rights, you can only use your login.
Incoming data marked with an asterisk are required.

Module

Function

Incoming data

Error variants

traffic_usage

Massive of traffic usage per user.

show_trafic

username (post or get) * - username;
password (post or get) * - user password;
traffic_usage (post or get) * - constant, module name;
show_trafic (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Traffic consumption';
error: 100, mess: 'No average load statistics';
error: 101, mess: 'Invalid date format. Example 01-01-2016 '.

Other useful articles:

API: connection

API: monitoring

API: web server status

API: auto installer CMS

API: configuring backups

API: transfer between servers

API: antivirus

API: server settings

API: web server management

API: database

API: custom certificates

API: mailbox management

API: server information

API: mail

API: DNS zone management

API: traffic usage

API: client mailboxes

API: web server installation

API: logging

API: name server

API: host accounts

API: application manager

API: service certificates

API: CRON

API: process manager

API: network tools

API: FTP server

API: IP address manager

API: average load

API: MySQL processlist

 

Retrieved from "https://docs.brainycp.io/index.php?title=API:_Traffic_usage&oldid=1924"