Difference between revisions of "API: Manage DNS-zones"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
 
(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>
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.&nbsp;
 
−
 
 
 
{| 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;" | &nbsp;  
 
| style="vertical-align: top;" | &nbsp;  
−
Вывод DNS-зоны.
+
show DNS-zones.
  
 
show_zones
 
show_zones
  
−
| 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">zone (post or get) * - zone name;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited.</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Successful output of the zone';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This zone does not belong to you. Or she's not there ';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'The zone array is empty.</div> <div data-placeholder="Перевод" dir="ltr">The zone array is empty. Perhaps you have no rights'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
show_zones (post или get)* — константа, имя операции;
 
−
 
 
−
zone (post или get)* — название зоны;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Успешный вывод зоны';
 
−
 
 
−
error:100, mess:'Эта зона вам не принадлежит. Или ее нет';
 
−
 
 
−
error:101, mess:'Массив зоны пустой.
 
−
 
 
−
Массив зоны пустой. Возможно у вас нет прав'
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 46: Line 24:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Список DNS-зон для пользователя/пользователей.
+
List ofDNS-zones for user/users.
  
 
list_zones
 
list_zones
  
−
| 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_zones (post or get) * - constant, operation name;</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>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'List of user zones', zones [array zones];</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'List of all zones', zones [array zones];</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'List of own zones', zones [array zones];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This zone does not belong to you. Or is she not '</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
list_zones (post или get)* — константа, имя операции;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список зон Пользователя',zones[array &nbsp;zones];
 
−
 
 
−
error:1, mess:'Список всех зон', zones[array &nbsp;zones];
 
−
 
 
−
error:2, mess:'Список своих зон', zones[array &nbsp;zones];
 
−
 
 
−
error:100, mess:'Эта зона вам не принадлежит. Или ее нет'
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 77: Line 35:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Добавление DNS-зоны.
+
Add DNS-zone.
  
 
add_zones
 
add_zones
  
 +
| 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">add_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">zone (post or get) * - zone name;</div> <div data-placeholder="Перевод" dir="ltr">IP (post or get) * - IP address;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Zone added successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'The specified zone name is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The specified IP address is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 500, mess: 'Error adding zone. Perhaps such a zone exists';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.</div>
 +
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
bindserver
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
add_zones (post или get)* — константа, имя операции;
 
−
 
 
−
zone (post или get)* — название зоны;
 
−
 
 
−
IP (post или get)* — IP-адрес;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Зона успешно добавлена';
+
delete DNS-zone.
  
−
error:1, mess:'Указанное имя зоны некорректно';
+
delete_zones
−
 
 
−
error:2, mess:'Указанный IP адрес некорректный';
 
−
 
 
−
error:500, mess:'Ошибка добавления зоны. Возможно такая зона существует';
 
−
 
 
−
error:400, mess:'У вас недостаточно прав. Уберите поле user_edit'.
 
  
 +
| 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">zone (post or get) * - zone name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Zone deleted successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This zone does not belong to you. Or she's not there ';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove the field user_edit ';</div> <div data-placeholder="Перевод" dir="ltr">error: 500, mess: 'Error deleting zone. Perhaps there is no such zone. '</div>
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 112: Line 57:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Удаление DNS-зоны.
+
Edit DNS-zone.
  
−
delete_zones
+
edit_zones
  
−
| 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">edit_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">zone (post or get) * - zone name;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - post type;</div> <div data-placeholder="Перевод" dir="ltr">value (post or get) * - value value;</div> <div data-placeholder="Перевод" dir="ltr">name (post or get) * - value of name;</div> <div data-placeholder="Перевод" dir="ltr">line (post or get) * - line number;</div> <div data-placeholder="Перевод" dir="ltr">delete (post or get) * - delete;</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">user_edit (post or get) - the name of the user being edited.</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The entry was deleted';</div> <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New entry added';</div> <div data-placeholder="Перевод" dir="ltr">error: 0, message: 'The zone record was successfully edited';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This zone does not belong to you. Or she's not there ';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Record type mismatch';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Zone name is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'The line number must be a number';</div> <div data-placeholder="Перевод" dir="ltr">error: 104, mess: 'Uneditable line numbers';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
 +
|}
  
−
password (post или get)* — пароль пользователя;
+
Other useful articles:
  
−
bindserver (post или get)* — константа, имя модуля;
+
{| style="width: 1146px;"
 +
|-
 +
| style="width: 312px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
delete_zones (post или get)* — константа, имя операции;
+
| style="width: 388px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
zone (post или get)* — название зоны;
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
|-
 +
| style="width: 312px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
| style="vertical-align: top;" | &nbsp;
+
| style="width: 388px;" |  
−
error:0, mess:'Зона успешно удалена';
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
error:100, mess:'Эта зона вам не принадлежит. Или ее нет';
+
| style="width: 424px;" |
−
 
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
−
error:400, mess:'У вас недостаточно прав. Уберите поле user_edit';
 
−
 
 
−
error:500, mess:'Ошибка удаления зоны. Возможно такой зоны нет'.
 
  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 312px;" |  
−
bindserver
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 388px;" |  
−
Редактирование DNS-зоны.
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
edit_zones
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
username (post или get)* — имя пользователя;
+
| style="width: 312px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
password (post или get)* — пароль пользователя;
+
| style="width: 388px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
bindserver (post или get)* — константа, имя модуля;
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
−
edit_zones (post или get)* — константа, имя операции;
+
|-
 +
| style="width: 312px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
zone (post или get)* — название зоны;
+
| style="width: 388px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
type (post или get)* — тип записи;
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
−
value (post или get)* — значение value;
+
|-
 +
| style="width: 312px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
name (post или get)* — начение name;
+
| style="width: 388px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
line (post или get)* — номер линии;
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
−
delete (post или get)* — удаление;
+
|-
 +
| style="width: 312px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru);
+
| style="width: 388px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
user_edit (post или get) — имя редактируемого пользователя.
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
error:0, mess:'Запись удалена';
+
| style="width: 312px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
error:0, mess:'Добавлена новая запись';
+
| style="width: 388px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
error:0, message:'Запись зоны успешно отредактирована';
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
−
error:100, mess:'Эта зона вам не принадлежит. Или ее нет';
+
|-
 +
| style="width: 312px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
error:101, mess:'Несоответствие типу записи';
+
| style="width: 388px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
error:102, mess:'Название зоны пустое';
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
−
error:103, mess:'Номер линии должен быть числом';
+
|-
 +
| style="width: 312px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
error:104, mess:'Не редактируемые номера линий';
+
| style="width: 388px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
error:400, mess:'У вас не достаточно прав. Уберите user_edit'.
+
| style="width: 424px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

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

bindserver

 

show DNS-zones.

show_zones

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
show_zones (post or get) * - constant, operation name;
zone (post or get) * - zone name;
user_edit (post or get) - the name of the user being edited.
error: 0, mess: 'Successful output of the zone';
error: 100, mess: 'This zone does not belong to you. Or she's not there ';
error: 101, mess: 'The zone array is empty.
The zone array is empty. Perhaps you have no rights'

bindserver

List ofDNS-zones for user/users.

list_zones

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
list_zones (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: 'List of user zones', zones [array zones];
error: 1, mess: 'List of all zones', zones [array zones];
error: 2, mess: 'List of own zones', zones [array zones];
error: 100, mess: 'This zone does not belong to you. Or is she not '

bindserver

Add DNS-zone.

add_zones

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
add_zones (post or get) * - constant, operation name;
zone (post or get) * - zone name;
IP (post or get) * - IP address;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Zone added successfully';
error: 1, mess: 'The specified zone name is invalid';
error: 2, mess: 'The specified IP address is invalid';
error: 500, mess: 'Error adding zone. Perhaps such a zone exists';
error: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.

bindserver

delete DNS-zone.

delete_zones

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
delete_zones (post or get) * - constant, operation name;
zone (post or get) * - zone name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Zone deleted successfully';
error: 100, mess: 'This zone does not belong to you. Or she's not there ';
error: 400, mess: 'You do not have sufficient rights. Remove the field user_edit ';
error: 500, mess: 'Error deleting zone. Perhaps there is no such zone. '

bindserver

Edit DNS-zone.

edit_zones

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
edit_zones (post or get) * - constant, operation name;
zone (post or get) * - zone name;
type (post or get) * - post type;
value (post or get) * - value value;
name (post or get) * - value of name;
line (post or get) * - line number;
delete (post or get) * - delete;
language (post or get) - can take the value: en / ru (ru by default);
user_edit (post or get) - the name of the user being edited.
error: 0, mess: 'The entry was deleted';
error: 0, mess: 'New entry added';
error: 0, message: 'The zone record was successfully edited';
error: 100, mess: 'This zone does not belong to you. Or she's not there ';
error: 101, mess: 'Record type mismatch';
error: 102, mess: 'Zone name is empty';
error: 103, mess: 'The line number must be a number';
error: 104, mess: 'Uneditable line numbers';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

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:_Manage_DNS-zones&oldid=1943"