Difference between revisions of "API: Databases"

From BrainyCP
Jump to: navigation, search
m (Protected "API: Databases" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(2 intermediate revisions by the same user not shown)
Line 76: Line 76:
 
| 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">dbusage (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">add_user_db (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">name_db (post or get) * - the name of the database;</div> <div data-placeholder="Перевод" dir="ltr">name_user (post or get) * - database user;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">privilegies name_user (post or get) * = all_privilegies (all privileges);</div> <div data-placeholder="Перевод" dir="ltr">open_remote (post or get) * - remote access ip-addresses separated by commas.</div>  
 
| 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">dbusage (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">add_user_db (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">name_db (post or get) * - the name of the database;</div> <div data-placeholder="Перевод" dir="ltr">name_user (post or get) * - database user;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">privilegies name_user (post or get) * = all_privilegies (all privileges);</div> <div data-placeholder="Перевод" dir="ltr">open_remote (post or get) * - remote access ip-addresses separated by commas.</div>  
 
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Privileges applied';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Privilege is written incorrectly';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Username is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Database name must be filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 109, mess: 'DB validation failed';</div> <div data-placeholder="Перевод" dir="ltr">error: 110, mess: 'User verification error';</div> <div data-placeholder="Перевод" dir="ltr">error: 404, mess: 'mysql is not working';</div> <div data-placeholder="Перевод" dir="ltr">error: 108, mess: 'mysql is not working';</div> <div data-placeholder="Перевод" dir="ltr">error: 405, mess: 'Attempt to edit data that is not your own'.</div>  
 
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Privileges applied';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Privilege is written incorrectly';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Username is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Database name must be filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 109, mess: 'DB validation failed';</div> <div data-placeholder="Перевод" dir="ltr">error: 110, mess: 'User verification error';</div> <div data-placeholder="Перевод" dir="ltr">error: 404, mess: 'mysql is not working';</div> <div data-placeholder="Перевод" dir="ltr">error: 108, mess: 'mysql is not working';</div> <div data-placeholder="Перевод" dir="ltr">error: 405, mess: 'Attempt to edit data that is not your own'.</div>  
 +
|-
 +
| style="vertical-align: top;" | dbusage
 +
| style="vertical-align: top;" |
 +
Removing a user from the database .
 +
 +
drop_user
 +
 +
| style="vertical-align: top;" |
 +
username (post or get) * - username;<br/> password (post or get) * - user password;<br/> dbusage (post or get) * - constant, module name;<br/> drop_user (post or get) * - constant, operation name;<br/> login_user (post or get) * - database user login (to be deleted);<br/> user_edit (post or get) - the name of the user being edited;<br/> language (post or get) - can take the value: en / ru (by default ru)
 +
 +
| style="vertical-align: top;" | error: 0, mess: 'Successfully completed';<br/> error: 404, mess: 'mysql is not working';<br/> error: 101, mess: 'Username is empty';<br/> error: 105, mess: 'There is no such user';
 +
|-
 +
| style="vertical-align: top;" | dbusage
 +
| style="vertical-align: top;" |
 +
Removing the database.
 +
 +
drop_db
 +
 +
| style="vertical-align: top;" | username (post or get) * - username;<br/> password (post or get) * - user password;<br/> dbusage (post or get) * - constant, module name;<br/> drop_db (post or get) * - constant, operation name;<br/> name_db (post or get) * - the name of the database (to be deleted);<br/> user_edit (post or get) - the name of the user being edited;<br/> language (post or get) - can take the value: en / ru (ru by default);
 +
| style="vertical-align: top;" | error: 0, mess: 'Successfully completed';<br/> error: 404, mess: 'mysql is not working';<br/> error: 100, mess: 'Database name must be filled.';<br/> error: 106, mess: 'There is no such database';
 
|}
 
|}
  
 
Other useful articles:
 
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 1060px;"
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_CRON API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 308px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
|  
+
| style="width: 327px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
|  
+
| style="width: 403px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist API: MySQL processlist]'''
+
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}
  
 
&nbsp;
 
&nbsp;

Latest revision as of 14:14, 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

dbusage

List of user databases.

show_db

username (post or get) * - username;
password (post or get) * - user password;
dbusage (post or get) * - constant, module name;
show_db (post or get) * - constant, operation name;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Displaying user bases';
error: 100, mess: 'The array of bases is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

dbusage

List of users of user databases..

show_users

username (post or get) * - username;
password (post or get) * - user password;
dbusage (post or get) * - constant, module name;
show_users (post or get) * - constant, operation name;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Displaying all users';
error: 100, mess: 'The user array is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

dbusage

List of database user privileges.

show_privilegies

username (post or get) * - username;
password (post or get) * - user password;
dbusage (post or get) * - constant, module name;
show_privilegies (post or get) * - constant, operation name;
name_db (post or get) * - the name of the database;
name_user (post or get) * - database user;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Privilege list';
error: 100, mess: 'The user has no privileges. The list of privileges is empty ';
error: 101, mess: 'Username is empty';
error: 102, mess: 'Database name must be filled'.

dbusage

Add database.

add_db

username (post or get) * - username;
password (post or get) * - user password;
dbusage (post or get) * - constant, module name;
add_db (post or get) * - constant, operation name;
name_db (post or get) * - the name of the database;
user_edit (post or get) - the name of the user being edited;

language (post или get) —can take a value: en/ru (by default ru).

error: 0, message: 'Database created';
error: 100, message: 'Database name must be filled in';
error: 108, message: 'Wrong mysql root password. Please connects with server administrator ';
error: -1, message: 'Database exists';
error: 400, message: 'You do not have sufficient rights. Remove user_edit ';
error: 404, message: 'mysql is not working';
error: 107, message: 'Error. You have reached the maximum number of bases';
error: 100, message: 'DB NAME must be filled';
error: 102, message: 'DB already exists'.

dbusage

Add user.

add_user

username (post or get) * - username;
password (post or get) * - user password;
dbusage (post or get) * - constant, module name;
add_user (post or get) * - constant, operation name;
login_user (post or get) * - database user login;
password_user (post or get) * - database user password;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'User added';
error: 404, mess: 'mysql is not working';
error: 108, mess: 'Wrong mysql root password. Please connects with server administrator ';
error: 101, mess: 'Username is empty';
error: 102, mess: 'The password for user bd is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit ';
error: -1, mess: 'User exists';
error: 100, mess: 'Login must be filled';
error: 101, mess: 'Login must be no more than 7 letters'
error: 102, mess: 'Login already exists';
error: 100, mess: 'Password must be filled'.

dbusage

Add user to database.

add_user_db

username (post or get) * - username;
password (post or get) * - user password;
dbusage (post or get) * - constant, module name;
add_user_db (post or get) * - constant, operation name;
name_db (post or get) * - the name of the database;
name_user (post or get) * - database user;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default);
privilegies name_user (post or get) * = all_privilegies (all privileges);
open_remote (post or get) * - remote access ip-addresses separated by commas.
error: 0, mess: 'Privileges applied';
error: 100, mess: 'Privilege is written incorrectly';
error: 101, mess: 'Username is empty';
error: 102, mess: 'Database name must be filled in';
error: 109, mess: 'DB validation failed';
error: 110, mess: 'User verification error';
error: 404, mess: 'mysql is not working';
error: 108, mess: 'mysql is not working';
error: 405, mess: 'Attempt to edit data that is not your own'.
dbusage

Removing a user from the database .

drop_user

username (post or get) * - username;
password (post or get) * - user password;
dbusage (post or get) * - constant, module name;
drop_user (post or get) * - constant, operation name;
login_user (post or get) * - database user login (to be deleted);
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (by default ru)

error: 0, mess: 'Successfully completed';
error: 404, mess: 'mysql is not working';
error: 101, mess: 'Username is empty';
error: 105, mess: 'There is no such user';
dbusage

Removing the database.

drop_db

username (post or get) * - username;
password (post or get) * - user password;
dbusage (post or get) * - constant, module name;
drop_db (post or get) * - constant, operation name;
name_db (post or get) * - the name of the database (to be deleted);
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default); 		error: 0, mess: 'Successfully completed';
error: 404, mess: 'mysql is not working';
error: 100, mess: 'Database name must be filled.';
error: 106, mess: 'There is no such database';

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:_Databases&oldid=1921"