Difference between revisions of "API: IP-address manager"

From BrainyCP
Jump to: navigation, search
m (Fgsfds переименовал страницу API: менеджер IP-адресов в API: IP-address manager)
Line 1: Line 1:
  
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
+
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.
  
 
{| border="1" cellpadding="5"
 
{| border="1" cellpadding="5"
 
|-
 
|-
−
| <p dir="ltr" style="text-align: center;">'''Модуль'''</p>  
+
| style="width: 64px;" | <p dir="ltr" style="text-align: center;">'''Module'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Функция'''</p>  
+
| style="width: 89px;" | <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; width: 64px;" |  
 
ipmanager
 
ipmanager
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 89px;" |  
−
Список ipv4.
+
List ipv4.
  
 
listipv4ipm
 
listipv4ipm
  
−
| 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">ipmanager (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">listipv4ipm (post or get) * - constant, operation name.</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The list of IP addresses was received successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while getting the list of IP addresses';</div> <div data-placeholder="Перевод" dir="ltr">error: 1003, mess: 'You do not have administrator rights'.</div>  
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
ipmanager (post или get)* — константа, имя модуля;
 
−
 
 
−
listipv4ipm (post или get)* — константа, имя операции.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список IP адресов был успешно получен';
 
−
 
 
−
error:1, mess:'Произошла ошибка при получении списка IP адресов';
 
−
 
 
−
error:1003, mess:'У вас нет прав администратора'.<br/> &nbsp;
 
−
 
 
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 64px;" |  
 
ipmanager
 
ipmanager
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 89px;" |  
−
Список ipv6.
+
List ipv6.
  
 
listipv6ipm
 
listipv6ipm
  
−
| 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">ipmanager (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">listipv6ipm (post or get) * - constant, operation name.</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The list of IP addresses was received successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while getting the list of IP addresses';</div> <div data-placeholder="Перевод" dir="ltr">error: 1003, mess: 'You do not have administrator rights'.</div>  
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
ipmanager (post или get)* — константа, имя модуля;
 
−
 
 
−
listipv6ipm (post или get)* — константа, имя операции.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список IP адресов был успешно получен';
 
−
 
 
−
error:1, mess:'Произошла ошибка при получении списка IP адресов';
 
−
 
 
−
error:1003, mess:'У вас нет прав администратора'.<br/> &nbsp;
 
−
 
 
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 64px;" |  
 
ipmanager
 
ipmanager
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 89px;" |  
−
Добавление айпи.
+
Add ip.
  
 
addipm
 
addipm
  
 +
| 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">ipmanager (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">addipm (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">ip_net (post or get) * - ip address of vip4 or vip6;</div> <div data-placeholder="Перевод" dir="ltr">netmask (post or get) * - subnet mask;</div> <div data-placeholder="Перевод" dir="ltr">gateway (post or get) * - gateway.</div>
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
&nbsp;
−
 
+
<div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New IP address was added successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while adding an IP address';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The specified IP address is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'The specified mask is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 4, mess: 'The specified gateway is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 1003, mess: 'You do not have administrator rights'.</div>
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
ipmanager (post или get)* — константа, имя модуля;
 
−
 
 
−
addipm (post или get)* — константа, имя операции;
 
−
 
 
−
ip_net (post или get)* — айпи адрес vip4 или vip6;
 
−
 
 
−
netmask (post или get)* — маска подсети;
 
−
 
 
−
gateway (post или get)* — шлюз.
 
−
 
 
−
| style="vertical-align: top;" |
 
−
error:0, mess:'Новый IP адрес был успешно добавлен';
 
−
 
 
−
error:1, mess:'Произошла ошибка при добавлении IP адреса';
 
−
 
 
−
error:2, mess:'Указанный IP адрес некорректный';
 
−
 
 
−
error:3, mess:'Указанная маска некорректна';
 
−
 
 
−
error:4, mess:'Указанный шлюз некорректный';
 
−
 
 
−
error:1003, mess:'У вас нет прав администратора'.
 
−
 
 
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 64px;" |  
 
ipmanager
 
ipmanager
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 89px;" |  
−
Удаление айпи.
+
Delete ip.
  
 
delipm
 
delipm
  
−
| 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">ipmanager (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delipm (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">ip_net (post or get) * - ip address of vip4 or vip6.</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The IP address was deleted successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while deleting the IP address';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The specified IP address is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 1003, mess: 'You do not have&nbsp;</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
ipmanager (post или get)* — константа, имя модуля;
 
−
 
 
−
delipm (post или get)* — константа, имя операции;
 
−
 
 
−
ip_net (post или get)* — айпи адрес vip4 или vip6.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'IP адрес был успешно удален';
 
−
 
 
−
error:1, mess:'Произошла ошибка при удалении IP адреса';
 
−
 
 
−
error:2, mess:'Указанный IP адрес некорректный';
 
−
 
 
−
error:1003, mess:'У вас нет прав администратора'.
 
−
 
 
 
|}
 
|}
  
−
Другие полезные статьи:
+
Other useful articles:
  
 
{| style="width: 1191px;"
 
{| style="width: 1191px;"

Revision as of 23:59, 10 April 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

ipmanager

List ipv4.

listipv4ipm

username (post or get) * - username;
password (post or get) * - user password;
ipmanager (post or get) * - constant, module name;
listipv4ipm (post or get) * - constant, operation name.
error: 0, mess: 'The list of IP addresses was received successfully';
error: 1, mess: 'An error occurred while getting the list of IP addresses';
error: 1003, mess: 'You do not have administrator rights'.

ipmanager

List ipv6.

listipv6ipm

username (post or get) * - username;
password (post or get) * - user password;
ipmanager (post or get) * - constant, module name;
listipv6ipm (post or get) * - constant, operation name.
error: 0, mess: 'The list of IP addresses was received successfully';
error: 1, mess: 'An error occurred while getting the list of IP addresses';
error: 1003, mess: 'You do not have administrator rights'.

ipmanager

Add ip.

addipm

username (post or get) * - username;
password (post or get) * - user password;
ipmanager (post or get) * - constant, module name;
addipm (post or get) * - constant, operation name;
ip_net (post or get) * - ip address of vip4 or vip6;
netmask (post or get) * - subnet mask;
gateway (post or get) * - gateway.

 

error: 0, mess: 'New IP address was added successfully';
error: 1, mess: 'An error occurred while adding an IP address';
error: 2, mess: 'The specified IP address is invalid';
error: 3, mess: 'The specified mask is invalid';
error: 4, mess: 'The specified gateway is invalid';
error: 1003, mess: 'You do not have administrator rights'.

ipmanager

Delete ip.

delipm

username (post or get) * - username;
password (post or get) * - user password;
ipmanager (post or get) * - constant, module name;
delipm (post or get) * - constant, operation name;
ip_net (post or get) * - ip address of vip4 or vip6.
error: 0, mess: 'The IP address was deleted successfully';
error: 1, mess: 'An error occurred while deleting the IP address';
error: 2, mess: 'The specified IP address is invalid';
error: 1003, mess: 'You do not have 

Other useful articles:

API: подключение

API: мониторинг

API: статус веб-сервера

API: автоустановщик CMS

API: настройка бекапов

API: трансфер между серверами

API: антивирус

API: настройки сервера

API: управление веб-сервером

API: базы данных

API: пользовательские сертификаты

API: управление почтовыми ящиками

API: информация о сервере

API: почта

API: управление DNS-зонами

API: использование трафика

API: почтовые ящики клиента

API: установка веб-сервера

API: логирование

API: сервер имен

API: хост-аккаунты

API: менеджер приложений

API: сертификаты сервисов

API: CRON

API: менеджер процессов

API: сетевые инструменты

API: FTP-сервер

API: менеджер IP-адресов

API: средняя нагрузка

API: MySQL processlist

Retrieved from "https://docs.brainycp.io/index.php?title=API:_IP-address_manager&oldid=1310"