Difference between revisions of "API: Databases"
From BrainyCP
m (Protected "API: Databases" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))) |
|||
| 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'; | ||
|} | |} | ||
Revision as of 14:55, 15 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; |
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:
