Difference between revisions of "API: Nameserver"

From BrainyCP
Jump to: navigation, search
m (Fgsfds переименовал страницу API: сервер имен в API: Nameserver)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
<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>
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
−
 
 
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.
 
−
 
 
 
{| 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>  
+
| style="width: 254px;" | <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| style="width: 299px;" | <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;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 254px;" |  
−
Старт/стоп/рестарт сервера имен.
+
Start/stop/restart of nameserver.
  
 
operation
 
operation
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 299px;" | <div>&nbsp;</div> <pre data-placeholder="Перевод" dir="ltr" id="tw-target-text">Username (post or get) * - username;
−
username (post или get)* — имя пользователя;
 
  
−
password (post или get)* — пароль пользователя;
+
password (post or get) * - user password;
  
−
bindserver (post или get)* — константа, имя модуля;
+
bindserver (post or get) * - constant, module name;
  
−
operation (post или get)* — константа, имя операции;
+
operation (post or get) * - constant, operation name;
  
−
command (post или get)* — выбор
+
command (post or get) * - choice
  
−
команды: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+
commands:
  
−
start — Запуск bind сервера; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+
start - Start bind server;
  
−
&nbsp;restart — перезапуск bind сервера; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+
restart - restart the bind server;
  
−
&nbsp;stop — остановка bind сервера.
+
stop - stop the bind server.
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
language (post or get) - can take the value: en / ru (ru by default).</pre>
−
 
 
−
| style="vertical-align: top;" |
 
−
error:0, mess:'Команда выполнена', detail [console message];
 
−
 
 
−
error:100, mess:'Ошибка в написании команды', detail [список команд];
 
−
 
 
−
error:101, mess:'Ошибка в выполнении команды';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
  
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Command completed', detail [console message];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Error in command writing', detail [list of commands];</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Error in command execution';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 254px;" |  
−
Отображение списка ns-серверов по умолчанию.
+
Show list of ns-servers by default.
  
 
list_ns_server
 
list_ns_server
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 299px;" | <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_ns_server (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: 'List of NS servers', detail [list_ns_server];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The list of NS servers is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
list_ns_server (post или get)* — константа, имя операции;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список NS серверов', detail [list_ns_server];
 
−
 
 
−
error:100, mess:'Список NS серверов пуст';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 254px;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Editing the default ns-server list (adding, deleting, replacing, reordering).</div>
−
Редактирование списка ns-серверов по умолчанию (добавление, удаление, замена, изменение порядка).
 
−
 
 
 
edit_ns_server
 
edit_ns_server
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 299px;" | <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_ns_server (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">operetion (post or get) * - takes values:</div> <div data-placeholder="Перевод" dir="ltr">delete - Delete ns server;</div> <div data-placeholder="Перевод" dir="ltr">add - add ns server;</div> <div data-placeholder="Перевод" dir="ltr">edit_number - change the order;</div> <div data-placeholder="Перевод" dir="ltr">edit_claster - Takes an array of key values.</div> <div data-placeholder="Перевод" dir="ltr">When you select add, the required parameters are host, ip (Hostname and its ip).</div> <div data-placeholder="Перевод" dir="ltr">If you select delete, the required parameters are host (Delete selected host).</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: 'The NS records table is saved by default';</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: 100, mess: 'The value must be an array';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
edit_ns_server (post или get)* — константа, имя операции;
 
−
 
 
−
operetion (post или get)* — принимает значения:
 
−
 
 
−
delete — Удалить ns сервер; &nbsp;
 
−
 
 
−
add — добавить ns сервер;
 
−
 
 
−
edit_number — изменение порядка;
 
−
 
 
−
edit_claster — принимает массив ключ значение.
 
−
 
 
−
При выборе add обязательные параметры host, ip &nbsp;(Название хоста и его ip).
 
−
 
 
−
При выборе delete обязательные параметры host &nbsp;(Удаление выбранного хоста).
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Таблица NS записей по умолчанию сохранена';
 
−
 
 
−
error:1, mess:'Указанное имя зоны некорректно';
 
−
 
 
−
error:2, mess:'Указанный IP адрес некорректный';
 
−
 
 
−
error:100, mess:'Значение должно состоять из массива';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |
+
| style="vertical-align: top; width: 254px;" |  
−
Пересборка.
+
Reassembling.
−
 
 
−
| style="vertical-align: top;" |
 
−
username (post или get)* — имя пользователя;
 
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
rebild (post или get)* — константа, имя операции;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Таблица NS записей успешно перестроена';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
  
 +
| style="vertical-align: top; width: 299px;" | <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">rebild (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>
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The NS records table was successfully rebuilt';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 254px;" |  
−
Просмотр кластера.
+
Show cluster.
  
 
show_claster
 
show_claster
  
 +
| style="vertical-align: top; width: 299px;" | <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_claster (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>
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
&nbsp;
−
 
+
<div>error: 0, message: 'View cluster array', detail [array_claster]; error: 100, message: 'The cluster array is empty'; error: 400, message: 'Unfortunately, the module is not available to you.'</div>
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
show_claster (post или get)* — константа, имя операции;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |
 
−
error:0, message:'Просмотр массива кластера', detail [array_claster];
 
−
 
 
−
error:100, message:'Массив кластера пустой';
 
−
 
 
−
error:400, message:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 254px;" |  
−
Генерация и сохранение ключа.
+
Generate and save key.
  
 
token
 
token
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 299px;" | <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">token (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">command (post or get) * - command:</div> <div data-placeholder="Перевод" dir="ltr">generate - key generation;</div> <div data-placeholder="Перевод" dir="ltr">save - save the key.</div> <div data-placeholder="Перевод" dir="ltr">When choosing save:</div> <div data-placeholder="Перевод" dir="ltr">token (post or get) * - the key to be saved.</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: 'Key generated', detail [key];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Error in key generation';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Empty or invalid key value';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
token (post или get)* — константа, имя операции;
 
−
 
 
−
command (post или get)* — команда:
 
−
 
 
−
generate — генерация ключа; &nbsp;
 
−
 
 
−
save — сохранение ключа.
 
−
 
 
−
При выборе save:
 
−
 
 
−
&nbsp;token (post или get)* — ключ который нужно сохранить.
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Ключ сгенерирован', detail [key];
 
−
 
 
−
error:100, mess:'Ошибка в генерации ключа';
 
−
 
 
−
error:101, mess:'Пустое или неправильное значение ключа';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 254px;" |  
−
Удаление сервера из кластера.
+
Delete server from cluster.
  
 
delete_cluster
 
delete_cluster
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 299px;" | <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_cluster (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - the ip-address of the server to be removed from the cluster;</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, message: 'Delete request completed';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, message: 'Incorrect ip address entered';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, message: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
delete_cluster (post или get)* — константа, имя операции;
 
−
 
 
−
ip (post или get)* — ip-адрес удаляемого сервера из кластера;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, message:'Запрос на удаление выполнен';
 
−
 
 
−
error:100, message:'Неправильно введен ip адрес';
 
−
 
 
−
error:400, message:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 254px;" |  
−
Редактирование сервера в кластере.
+
Edit server in cluster.
  
 
edit_cluster
 
edit_cluster
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 299px;" |  
−
username (post или get)* — имя пользователя;
+
&nbsp;
−
 
+
<div>username (post or get) * - username; password (post or get) * - user password; bindserver (post or get) * - constant, module name; edit_cluster (post or get) * - constant, operation name; ip (post or get) * - the ip-address of the edited server from the cluster; host (post or get) * - host of the edited server; key (post or get) * - sha256 key; type (post or get) * - takes 2 values ​​one, two; enable (post or get) - default 0; language (post or get) - can take the value: en / ru (ru by default).</div>
−
password (post или get)* — пароль пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Sucessfully edited';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Invalid value type', detail [type];</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid ID';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Invalid IP Address';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'Invalid HOST';</div> <div data-placeholder="Перевод" dir="ltr">error: 104, mess: 'Invalid key';</div> <div data-placeholder="Перевод" dir="ltr">error: 106, mess: 'There is no connection to server'.</div>
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
edit_cluster (post или get)* — константа, имя операции;
 
−
 
 
−
ip (post или get)* — ip-адрес &nbsp;редактируемого сервера из кластера;
 
−
 
 
−
host (post или get)* — &nbsp;хост редактируемого сервера;
 
−
 
 
−
key (post или get)* — &nbsp;ключ sha256;
 
−
 
 
−
type (post или get)* — &nbsp;принимает 2 значения one, two;
 
−
 
 
−
enable (post или get) — по умолчанию 0;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Sucessfully edited';
 
−
 
 
−
error:100, mess:'Не правильное значение type', detail [type];
 
−
 
 
−
error:101, mess:'Invalid ID';
 
−
 
 
−
error:102, mess:'Invalid IP Adress';
 
−
 
 
−
error:103, mess:'Invalid HOST';
 
−
 
 
−
error:104, mess:'Invalid key';
 
−
 
 
−
error:106, mess:'There is no connection to server'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
bindserver
 
bindserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 254px;" |  
−
Добавление сервера в кластер.
+
Adding server to cluster.
  
 
add_cluster
 
add_cluster
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 299px;" | <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_cluster (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - the ip-address of the server added to the cluster;</div> <div data-placeholder="Перевод" dir="ltr">host (post or get) * - host of the added server;</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - sha256 key;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - takes 2 values ​​one, two;</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:</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Invalid ip-address entered';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Missing host value';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Missing key value';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'Invalid value type', detail [type];</div> <div data-placeholder="Перевод" dir="ltr">error: 106, mess: 'There is no connection to server';</div> <div data-placeholder="Перевод" dir="ltr">error: 110, mess: 'Another error';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
bindserver (post или get)* — константа, имя модуля;
 
−
 
 
−
edit_cluster (post или get)* — константа, имя операции;
 
−
 
 
−
ip (post или get)* — ip-адрес &nbsp;добавляемого сервера в кластер;
 
−
 
 
−
host (post или get)* — &nbsp;хост добавляемого сервера;
 
−
 
 
−
key (post или get)* — &nbsp;ключ sha256;
 
−
 
 
−
type (post или get)* — &nbsp;принимает 2 значения one, two;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:
 
−
 
 
−
error:100, mess:'Неправильно введен ip-адрес';
 
−
 
 
−
error:101, mess:'Отсутствует значение host';
 
−
 
 
−
error:102, mess:'Отсутствует значение key';
 
−
 
 
−
error:103, mess:'Не правильное значение type', detail [type];
 
−
 
 
−
error:106, mess:'There is no connection to server';
 
−
 
 
−
error:110, mess:'Другая ошибка';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|}
 
|}
  
−
Другие полезные статьи:
+
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 1073px;"
 
|-
 
|-
−
|  
+
| style="width: 296px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 384px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 371px;" |  
−
'''[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: 296px;" |  
−
'''[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: 384px;" |  
−
'''[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: 371px;" |  
−
'''[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: 296px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 384px;" |  
−
'''[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: 371px;" |  
−
'''[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: 296px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 384px;" |  
−
'''[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: 371px;" |  
−
'''[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: 296px;" |  
−
'''[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: 384px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 371px;" |  
−
'''[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: 296px;" |  
−
'''[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: 384px;" |  
−
'''[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: 371px;" |  
−
'''[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: 296px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 384px;" |  
−
'''[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: 371px;" |  
−
'''[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: 296px;" |  
−
'''[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: 384px;" |  
−
'''[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: 371px;" |  
−
'''[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: 296px;" |  
−
'''[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: 384px;" |  
−
'''[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: 371px;" |  
−
'''[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: 296px;" |  
−
'''[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: 384px;" |  
−
'''[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: 371px;" |  
−
'''[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>]'''
  
 
|}
 
|}

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

Start/stop/restart of nameserver.

operation

 
Username (post or get) * - username;

password (post or get) * - user password;

bindserver (post or get) * - constant, module name;

operation (post or get) * - constant, operation name;

command (post or get) * - choice

commands:

start - Start bind server;

restart - restart the bind server;

stop - stop the bind server.

language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Command completed', detail [console message];
error: 100, mess: 'Error in command writing', detail [list of commands];
error: 101, mess: 'Error in command execution';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Show list of ns-servers by default.

list_ns_server

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
list_ns_server (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'List of NS servers', detail [list_ns_server];
error: 100, mess: 'The list of NS servers is empty';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Editing the default ns-server list (adding, deleting, replacing, reordering).

edit_ns_server

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
edit_ns_server (post or get) * - constant, operation name;
operetion (post or get) * - takes values:
delete - Delete ns server;
add - add ns server;
edit_number - change the order;
edit_claster - Takes an array of key values.
When you select add, the required parameters are host, ip (Hostname and its ip).
If you select delete, the required parameters are host (Delete selected host).
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'The NS records table is saved by default';
error: 1, mess: 'The specified zone name is invalid';
error: 2, mess: 'The specified IP address is invalid';
error: 100, mess: 'The value must be an array';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Reassembling.

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
rebild (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'The NS records table was successfully rebuilt';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Show cluster.

show_claster

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
show_claster (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).

 

error: 0, message: 'View cluster array', detail [array_claster]; error: 100, message: 'The cluster array is empty'; error: 400, message: 'Unfortunately, the module is not available to you.'

bindserver

Generate and save key.

token

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
token (post or get) * - constant, operation name;
command (post or get) * - command:
generate - key generation;
save - save the key.
When choosing save:
token (post or get) * - the key to be saved.
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Key generated', detail [key];
error: 100, mess: 'Error in key generation';
error: 101, mess: 'Empty or invalid key value';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Delete server from cluster.

delete_cluster

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
delete_cluster (post or get) * - constant, operation name;
ip (post or get) * - the ip-address of the server to be removed from the cluster;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, message: 'Delete request completed';
error: 100, message: 'Incorrect ip address entered';
error: 400, message: 'Unfortunately, the module is not available to you.'

bindserver

Edit server in cluster.

edit_cluster

 

username (post or get) * - username; password (post or get) * - user password; bindserver (post or get) * - constant, module name; edit_cluster (post or get) * - constant, operation name; ip (post or get) * - the ip-address of the edited server from the cluster; host (post or get) * - host of the edited server; key (post or get) * - sha256 key; type (post or get) * - takes 2 values ​​one, two; enable (post or get) - default 0; language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Sucessfully edited';
error: 100, mess: 'Invalid value type', detail [type];
error: 101, mess: 'Invalid ID';
error: 102, mess: 'Invalid IP Address';
error: 103, mess: 'Invalid HOST';
error: 104, mess: 'Invalid key';
error: 106, mess: 'There is no connection to server'.

bindserver

Adding server to cluster.

add_cluster

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
edit_cluster (post or get) * - constant, operation name;
ip (post or get) * - the ip-address of the server added to the cluster;
host (post or get) * - host of the added server;
key (post or get) * - sha256 key;
type (post or get) * - takes 2 values ​​one, two;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess:
error: 100, mess: 'Invalid ip-address entered';
error: 101, mess: 'Missing host value';
error: 102, mess: 'Missing key value';
error: 103, mess: 'Invalid value type', detail [type];
error: 106, mess: 'There is no connection to server';
error: 110, mess: 'Another error';
error: 400, mess: 'Unfortunately, the module is not available to you.'

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:_Nameserver&oldid=1935"