DNSmanager API/Administrator
Материал из ISPWiki
|
См. также
Администратор
Главное
Пользователи
Функция: user
Результат: список элементов
- name - Логин.
- owner - Владелец.
- level - .
- disabled - Учётная запись и её домены временно отключены.
- level_12 - Администратор.
- level_11 - Реселлер.
- level_10 - Пользователь.
- view - Пространство имён DNS.
- domains - Домены. Атрибуты :
- used - Использованное количество.
- limit - Максимально возможное значение.
Функция: user.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "user")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "user")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name - Логин.
- level - Уровень доступа. При выбранном значении admin запрещается использовать параметры: 'view','ip','domlimit'
- view - Пространство имён DNS.
- ip - IP-адрес.
- passwd - Пароль.
- confirm - Подтверждение.
- domlimit - Кол-во доменов.
Функция: user.delete
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: user.enable
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: user.disable
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: user.su
Статистика
Текущая активность
Функция: session
Результат: список элементов
- id - Номер сессии.
- name - Пользователь.
- lv_12 - .
- lv_11 - .
- lv_10 - .
- lv_7 - Администратор.
- lv_6 - Реселлер.
- lv_5 - Пользователь.
- lv_4 - Пользователь с доступом к shell.
- lv_3 - FTP аккаунт.
- lv_2 - Почтовый ящик.
- ip - IP-адрес.
- idle - Ожидание.
Функция: session.delete
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "id" из функции "session".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: session.su
Журнал операций
Функция: journal
Результат: список элементов
- id - Уникальный идентификатор элемента списка.
- time - Время.
- user - Пользователь.
- ip - Удалённый IP-адрес.
- funcname - Функция.
Функция: journal.edit
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "id" из функции "journal")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "id" из функции "journal")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- time - Время.
- user - Пользователь.
- ip - Удалённый IP-адрес.
- funcname - Функция.
- params - Параметры.
Настройки
Настройка бренда
Функция: brand
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- site - Ссылка на логотипе (http://my-hosting-company.com).
- mainlogo - .
- loginlogo - .
- favicon - .
- reset - Сбросить все настройки бренда. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- h - Тон.
- s - Насыщенность.
- l - Яркость.
- headinclude - Дополнение к HEAD.
Плагины
Функция: plugin
Результат: список элементов
- name - Имя плагина.
- desc - Краткое описание.
- version - Версия.
- bad - Описание плагина содержит ошибки. Он не работает..
- newver - .
Функция: plugin.collection
Результат: список элементов
- name - Имя плагина.
- desc - Описание.
- version - Версия.
- author - Автор.
Функция: plugin.install
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "plugin.collection")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "plugin.collection")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- agree - Я полностью осознаю последствия своих действий. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
Функция: plugin.info
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "plugin.collection")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "plugin.collection")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- description - Подробное описание.
- interpretator - Язык программирования.
- require - Необходимые модули.
- author - Автор.
- contact - Контакты.
Функция: plugin.info
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "plugin")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "plugin")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- description - Подробное описание.
- interpretator - Язык программирования.
- require - Необходимые модули.
- author - Автор.
- contact - Контакты.
Функция: plugin.update
Функция: plugin.delete
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "plugin".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: plugin.source
Результат: список элементов
- url - URL источника.
Функция: plugin.source.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "url" из функции "plugin.source")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "url" из функции "plugin.source")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- url - URL источника.
Функция: plugin.source.delete
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "url" из функции "plugin.source".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: plugin.source.refresh
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "url" из функции "plugin.source".
Результат: успешное выполнение операции или сообщение об ошибке
Связь с IPmanager
Функция: ipmgr
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- server - Адрес (URL) IPmanager.
- user - Логин.
- passwd - Пароль.
Список IP-адресов
Функция: iplist
Результат: список элементов
- name - IP-адрес.
- usedby - Используется.
- access - Доступ.
Функция: iplist.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "iplist")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "iplist")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name - IP-адрес.
- atype - Доступ. При выбранном значении allow запрещается использовать параметры: 'memb'
- members - Реселлеры. (Одно или несколько значений, разделенных пробелом)
Функция: iplist.delete
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "iplist".
Результат: успешное выполнение операции или сообщение об ошибке
Доступ к модулям
Функция: access
Результат: список элементов
- name - Имя функции.
- ftitle - Название модуля.
- lv_12 - Модуль доступен на уровне администратора.
- lv_11 - Модуль доступен на уровне реселлера.
- lv_10 - Модуль доступен на уровне пользователя.
- lv_7 - Модуль доступен на уровне администратора панели управления.
- lv_6 - Модуль доступен на уровне реселлера.
- lv_5 - Модуль доступен на уровне пользователя панели управления.
- lv_4 - Модуль доступен на уровне пользователя с доступом к shell.
- lv_3 - Модуль доступен на уровне FTP аккаунта.
- lv_2 - Модуль доступен на уровне почтового пользователя.
- status - Статус.
Функция: access.edit
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "access")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "access")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name - Название модуля.
- ftype - Тип доступа.
Возможные значения :
- allow - Разрешён всем
- deny - Запрещён всем
- allow_partial - Разрешён выборочно
- deny_partial - Запрещён выборочно
- userlist - Список пользователей. (Одно или несколько значений, разделенных пробелом)
Настройки панели
Функция: usrparam
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- name - Имя пользователя.
- email - E-mail для уведомлений.
- email - E-mail для уведомлений. Параметр зависим от возможности billmgr.
- changed - Тема.
- theme - Тема.
- lang - Язык.
- timezone - Временная зона.
- passwd - Пароль.
- confirm - Подтверждение.
- atype - Доступ к панели управления. При выбранном значении atany запрещается использовать параметры: 'addr'
- addr - Список IP-адресов. (Одно или несколько значений, разделенных пробелом)
- startpage - Стартовая страница.
- rows - Строк на странице.
- recordlimit - Количество записей.
- buttonview - Вид кнопок.
Справка
Лицензия
Функция: softinfo
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- os - Операционная система.
- mgrver - Текущая версия.
- mgrbuild - Дата компиляции.
- licid - ID лицензии.
- licip - IP лицензии.
- licname - Имя лицензии.
- licdate - Действует до.
Обновления
Функция: updatelist
Результат: список элементов
- id - Уникальный идентификатор элемента списка.
- version - Версия.
- release - Дата выпуска.
- lines - Количество изменений.
- backup - Дата резервной копии.
Функция: updatelist.changelog
Параметры:
- elid - уникальный идентификатор (элемент "id" из функции "updatelist").
Результат: список элементов
- id - Уникальный идентификатор элемента списка.
- description - Описание изменения.
- isp1 - ISPmanager Lite.
- isp2 - ISPmanager Pro.
- isp3 - ISPmanager Cluster.
- bill1 - BILLmanager Standard.
- bill2 - BILLmanager Advanced.
- bill3 - BILLmanager Corparate.
- changetype - Тип изменения.
Функция: updatelist.restore
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "id" из функции "updatelist")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "id" из функции "updatelist")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
Функция: updatelist.settings
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- os - Операционная система.
- mgrver - Текущая версия.
- mgrbuild - Дата компиляции.
- vertype - Тип версии.
- srvver - Последняя версия.
- mirror - Зеркало.
- autoupdate - Автоматическое обновление. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
Функция: updatelist.updatenow
Запрос улучшений
Функция: wishlist
Результат: список элементов
- id - Код задачи.
- name - Аннотация.
- created - Дата создания.
- vote - Голоса.
- jobeval - Трудоемкость.
- prio - Приоритет.
- status - Состояние.
Функция: wishlist.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "id" из функции "wishlist")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "id" из функции "wishlist")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name - Аннотация.
- desc - Описание.
- myvote - Доступно голосов.
- vote - Добавить мой голос.
Функция: wishlist.vote
- myvote - Доступно голосов.
- vote - Добавить мои голоса (за каждое улучшение).
Функция: wishlist.refresh
Журнал ошибок
Функция: errorjournal
Результат: список элементов
- date - Дата события.
- funcname - Функция.
- lv_12 - .
- lv_11 - .
- lv_10 - .
- lv_7 - Администратор.
- lv_6 - Реселлер.
- lv_5 - Пользователь.
- lv_4 - Пользователь с доступом к shell.
- lv_3 - FTP аккаунт.
- lv_2 - Почтовый ящик.
- user - Пользователь.
- status - Состояние.
Функция: errorjournal.settings
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- level - Уровень.
Функция: errorjournal.edit
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "date" из функции "errorjournal")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "date" из функции "errorjournal")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- email - E-Mail.
- drop - Удалить отчет после отправки. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- data - .
Функция: errorjournal.delete
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "date" из функции "errorjournal".
Результат: успешное выполнение операции или сообщение об ошибке
- Список активных возможностей можно получить через API-функцию "featurelist"
