API: Nameserver

From BrainyCP
Revision as of 13:29, 31 January 2017 by Fgsfds (talk | contribs) (Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.

Входящие данные, отмеченные звездочкой, обязательны для заполнения.

Модуль

Функция

Входящие данные

Варианты ошибок

bindserver

Старт/стоп/рестарт сервера имен.

operation

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

operation (post или get)* — константа, имя операции;

command (post или get)* — выбор

команды:        

start — Запуск bind сервера;                     

 restart — перезапуск bind сервера;                     

 stop — остановка bind сервера.

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Команда выполнена', detail [console message];

error:100, mess:'Ошибка в написании команды', detail [список команд];

error:101, mess:'Ошибка в выполнении команды';

error:400, mess:'К сожалению, модуль вам не доступен'.

bindserver

Отображение списка ns-серверов по умолчанию.

list_ns_server

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

list_ns_server (post или get)* — константа, имя операции;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Список NS серверов', detail [list_ns_server];

error:100, mess:'Список NS серверов пуст';

error:400, mess:'К сожалению, модуль вам не доступен'.

bindserver

Редактирование списка ns-серверов по умолчанию (добавление, удаление, замена, изменение порядка).

edit_ns_server

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

edit_ns_server (post или get)* — константа, имя операции;

operetion (post или get)* — принимает значения:

delete — Удалить ns сервер;  

add — добавить ns сервер;

edit_number — изменение порядка;

edit_claster — принимает массив ключ значение.

При выборе add обязательные параметры host, ip  (Название хоста и его ip).

При выборе delete обязательные параметры host  (Удаление выбранного хоста).

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Таблица NS записей по умолчанию сохранена';

error:1, mess:'Указанное имя зоны некорректно';

error:2, mess:'Указанный IP адрес некорректный';

error:100, mess:'Значение должно состоять из массива';

error:400, mess:'К сожалению, модуль вам не доступен'.

bindserver

Пересборка.

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

rebild (post или get)* — константа, имя операции;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Таблица NS записей успешно перестроена';

error:400, mess:'К сожалению, модуль вам не доступен'.

bindserver

Просмотр кластера.

show_claster

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

show_claster (post или get)* — константа, имя операции;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, message:'Просмотр массива кластера', detail [array_claster];

error:100, message:'Массив кластера пустой';

error:400, message:'К сожалению, модуль вам не доступен'.

bindserver

Генерация и сохранение ключа.

token

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

token (post или get)* — константа, имя операции;

command (post или get)* — команда:

generate — генерация ключа;  

save — сохранение ключа.

При выборе save:

 token (post или get)* — ключ который нужно сохранить.

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Ключ сгенерирован', detail [key];

error:100, mess:'Ошибка в генерации ключа';

error:101, mess:'Пустое или неправильное значение ключа';

error:400, mess:'К сожалению, модуль вам не доступен'.

bindserver

Удаление сервера из кластера.

delete_cluster

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

delete_cluster (post или get)* — константа, имя операции;

ip (post или get)* — ip-адрес удаляемого сервера из кластера;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, message:'Запрос на удаление выполнен';

error:100, message:'Неправильно введен ip адрес';

error:400, message:'К сожалению, модуль вам не доступен'.

bindserver

Редактирование сервера в кластере.

edit_cluster

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

edit_cluster (post или get)* — константа, имя операции;

ip (post или get)* — ip-адрес  редактируемого сервера из кластера;

host (post или get)* —  хост редактируемого сервера;

key (post или get)* —  ключ sha256;

type (post или get)* —  принимает 2 значения one, two;

enable (post или get) — по умолчанию 0;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

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'.

bindserver

Добавление сервера в кластер.

add_cluster

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

bindserver (post или get)* — константа, имя модуля;

edit_cluster (post или get)* — константа, имя операции;

ip (post или get)* — ip-адрес  добавляемого сервера в кластер;

host (post или get)* —  хост добавляемого сервера;

key (post или get)* —  ключ sha256;

type (post или get)* —  принимает 2 значения one, two;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

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:'К сожалению, модуль вам не доступен'.