ISPmanager API/User (siteadmin)

Материал из ISPWiki

Перейти к: навигация, поиск
Условные обозначения
  • Image:isp_lite.png - доступно в ISPmanager Lite
  • Image:isp_pro.png - доступно в ISPmanager Professional
  • Image:isp_cluster.png - доступно в ISPmanager Cluster

Содержание

См. также


Пользователь (администратор сайта)

Главное

FTP аккаунты

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
FTP аккаунты

Функция: ftp

Результат: список элементов

  • name - Имя.
  • home - Домашняя директория.
  • disabled - Доступ временно закрыт.
  • shell - Доступ к shell.
  • note - Заметки: .
  • disk - Диск. Атрибуты :
    • used - Использованное количество.
    • limit - Максимально возможное значение.


Создание. Изменение. FTP аккаунт

Функция: ftp.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя.
  • passwd - Пароль.
  • confirm - Подтверждение.
  • htype - Домашняя директория.
    При выбранном значении docroot разрешается использовать параметры: 'domain' и запрещается использовать параметры: 'dir','disklimit', 'shell'
При выбранном значении custom разрешается использовать параметры: 'dir' и запрещается использовать параметры: 'domain','disklimit','shell'
При выбранном значении private разрешается использовать параметры: 'disklimit','shell' и запрещается использовать параметры: 'domain', 'dir'
  • domain - Домен.
  • dir - Директория.
  • disklimit - Дисковая квота. Параметр зависим от возможности quota.
  • shell - Доступ к shell. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности InsecureHome.
  • note - Заметки. Image:isp_pro.png Image:isp_cluster.png


Удалить FTP аккаунты

Функция: ftp.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "ftp".

Результат: успешное выполнение операции или сообщение об ошибке


Включить FTP аккаунты

Функция: ftp.enable

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "ftp".

Результат: успешное выполнение операции или сообщение об ошибке


Временно отключить FTP аккаунты

Функция: ftp.disable

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "ftp".

Результат: успешное выполнение операции или сообщение об ошибке


World Wide Web

Редиректы

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Перенаправление URL

Функция: wwwredirect

Результат: список элементов

  • name - Путь.
  • code - Код.
  • url - Url.


Создание. Изменение. Параметры перенаправления

Функция: wwwredirect.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • domain - WWW домен.
  • name - URL-путь.
  • code - Код.
  • url - URL.


Удалить перенаправления

Функция: wwwredirect.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "wwwredirect".

Результат: успешное выполнение операции или сообщение об ошибке


Страницы ошибок

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Страницы ошибок

Функция: errpage

Результат: список элементов

  • key - Уникальный идентификатор элемента списка.
  • domain - WWW домен.
  • name - Код ошибки.
  • url - URL.


Создание. Изменение. Параметры страницы ошибки

Функция: errpage.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • domain - WWW домен.
  • name - Код ошибки.

Возможные значения :

    • 400 - 400 - Bad Request
    • 401 - 401 - Unauthorized
    • 402 - 402 - Payment Required
    • 403 - 403 - Forbidden
    • 404 - 404 - Not Found
    • 405 - 405 - Method Not Allowed
    • 406 - 406 - Not Acceptable
    • 407 - 407 - Proxy Authentication Required
    • 408 - 408 - Request Timeout
    • 409 - 409 - Conflict
    • 411 - 411 - Length Required
    • 412 - 412 - Precondition Failed
    • 413 - 413 - Request Entity Too Large
    • 414 - 414 - Request-URI Too Long
    • 415 - 415 - Unsupported Media Type
    • 416 - 416 - Requested Range Not Satisfiable
    • 417 - 417 - Expectation Failed
    • 500 - 500 - Internal Server Error
    • 501 - 501 - Not Implemented
    • 502 - 502 - Bad Gateway
    • 503 - 503 - Service Unavailable
    • 504 - 504 - Gateway Timeout
    • 505 - 505 - HTTP Version Not Supported
  • url - URL.


Удалить страницы ошибки

Функция: errpage.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "key" из функции "errpage".

Результат: успешное выполнение операции или сообщение об ошибке


MIME типы

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
MIME типы

Функция: wwwaddtypes

Результат: список элементов

  • key - Уникальный идентификатор элемента списка.
  • domain - WWW-домен.
  • name - Тип данных.
  • val - Расширение файла.


Создание. Изменение. MIME-тип

Функция: wwwaddtypes.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • domain - Домен.
  • name - Тип данных.
  • val - Расширение файла.


Удалить MIME-типы

Функция: wwwaddtypes.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "key" из функции "wwwaddtypes".

Результат: успешное выполнение операции или сообщение об ошибке


Журнал

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Журналы WWW запросов

Функция: logs

Результат: список элементов

  • name - Имя.
  • size - Размер.
  • time - Время изменения.
  • count - Количество.
  • total - Общий размер.


Журнал . Просмотр. Изменение

Функция: logs.edit

Данная функция одновременно используется для просмотра и изменения параметров объекта

Просмотр параметров объекта:

  • Параметры:
    • elid - уникальный идентификатор (элемент "name" из функции "logs")
  • Результат: список параметров

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • lines - Количество строк.

Возможные значения :

    • 100 -
    • 500 -
    • 1000 -
    • 2000 -
    • 10000 -
  • fdata - .


Очистить/удалить журналы

Функция: logs.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "logs".

Результат: успешное выполнение операции или сообщение об ошибке


Ограничение доступа

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Ограничение доступа

Функция: diraccess

Результат: список элементов

  • name - Путь.


Ограничение доступа к директории. Просмотр. Изменение

Функция: diraccess.edit

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • name - Путь.
  • name - Путь.


Снять защиту с директорий

Функция: diraccess.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "diraccess".

Результат: успешное выполнение операции или сообщение об ошибке


Пользователи защищённой директории

Функция: diraccess.user

Параметры:

  • elid - уникальный идентификатор (элемент "name" из функции "diraccess").

Результат: список элементов

  • name - Имя пользователя.


Создание. Изменение. Параметры пользователя

Функция: diraccess.user.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "diraccess").
    • elid - уникальный идентификатор (элемент "name" из функции "diraccess.user")
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "diraccess").
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "diraccess").
    • elid - уникальный идентификатор (элемент "name" из функции "diraccess.user")
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя пользователя.
  • passwd - Пароль.
  • confirm - Подтверждение.


Удалить пользователей

Функция: diraccess.user.delete

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "name" из функции "diraccess").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "diraccess.user".

Результат: успешное выполнение операции или сообщение об ошибке


E-Mail

Почтовые группы

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Почтовые группы

Функция: emailgroup

Результат: список элементов

  • name - E-mail адрес.
  • members - Участники.


Создание. Изменение. Параметры почтовой группы

Функция: emailgroup.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя группы.
  • domain - Почтовый домен.
  • members - Участники. (Одно или несколько значений, разделенных пробелом)
  • greylist - Включить greylisting. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности greylist.
  • spamassassin - Включить SpamAssassin. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности sa.


Удалить почтовые группы

Функция: emailgroup.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "emailgroup".

Результат: успешное выполнение операции или сообщение об ошибке


Почтовые редиректы

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Почтовые редиректы

Функция: emailredirect

Результат: список элементов

  • name - E-mail адрес.
  • forward - Перенаправить на.


Создание. Изменение. Параметры почтового редиректа

Функция: emailredirect.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя редиректа.
  • domain - Почтовый домен.
  • forward - Перенаправлять на.
  • greylist - Включить greylisting. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности greylist.


Удалить почтовые редиректы

Функция: emailredirect.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "emailredirect".

Результат: успешное выполнение операции или сообщение об ошибке


Почтовые автоответчики

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Почтовые автоответчики

Функция: emailresponder

Результат: список элементов

  • email - Адрес e-mail.


Создание. Изменение. Параметры автоответчика

Функция: emailresponder.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя.
  • domain - Домен.
  • rtype - Действие.
    При выбранном значении send_mail разрешается использовать параметры: 'body','subject','file' и запрещается использовать параметры: 'command'
  • command - Скрипт.
  • subject - Тема.
  • body - Текст.
  • file - Файл.


Удалить почтовые автоответчики

Функция: emailresponder.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "email" из функции "emailresponder".

Результат: успешное выполнение операции или сообщение об ошибке


Списки рассылки

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Списки рассылки

Функция: maillist

Результат: список элементов

  • name - Название.
  • owner - Администратор.
  • count - Количество подписчиков.


Создание. Изменение. Настройки списка рассылки

Функция: maillist.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Название.
  • domain - Домен.
  • policy - Политика.
  • owner - Администратор.
  • password - Пароль.
  • maxlen - Макс. размер.
  • prefix - Заголовок.
  • info - Информация.
  • anonymous - Анонимная. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)


Удалить списки рассылки

Функция: maillist.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "maillist".

Результат: успешное выполнение операции или сообщение об ошибке


Подписчики списка рассылки

Функция: maillist.subscriber

Параметры:

  • elid - уникальный идентификатор (элемент "name" из функции "maillist").

Результат: список элементов

  • name - Адрес.


Создание. Изменение. Редактировать адрес подписчика

Функция: maillist.subscriber.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "maillist").
    • elid - уникальный идентификатор (элемент "name" из функции "maillist.subscriber")
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "maillist").
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "maillist").
    • elid - уникальный идентификатор (элемент "name" из функции "maillist.subscriber")
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Адрес.


Удалить подписчиков

Функция: maillist.subscriber.delete

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "name" из функции "maillist").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "maillist.subscriber".

Результат: успешное выполнение операции или сообщение об ошибке


Отправители списка рассылки

Функция: maillist.sender

Параметры:

  • elid - уникальный идентификатор (элемент "name" из функции "maillist").

Результат: список элементов

  • name - Адрес.


Создание. Изменение. Редактировать адрес отправителя

Функция: maillist.sender.edit

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "maillist").
    • elid - уникальный идентификатор (элемент "name" из функции "maillist.sender")
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "maillist").
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok- значение параметра должно быть не пустым, обычно "yes".
    • plid - уникальный идентификатор родительского списка (элемент "name" из функции "maillist").
    • elid - уникальный идентификатор (элемент "name" из функции "maillist.sender")
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Адрес.


Удалить отправителей

Функция: maillist.sender.delete

Параметры:

  • plid - уникальный идентификатор родительского списка (элемент "name" из функции "maillist").
  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "maillist.sender".

Результат: успешное выполнение операции или сообщение об ошибке


Инструменты

Web-скрипты (APS)

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Web-скрипты (APS)

Функция: webaps

Результат: список элементов

  • key - Уникальный идентификатор элемента списка.
  • name - Название.
  • version - Версия.
  • domain - Домен.
  • path - Путь.


Коллекция web-скриптов (APS)

Функция: webaps.collection

Результат: список элементов

  • name - Название.
  • version - Версия.
  • summary - Описание.
  • status - Статус.
  • inrep - Web-скрипт загружен.


Добавление web-скрипта. Просмотр. Изменение

Функция: webaps.collection.add

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • path - Путь до архива.


Установка web-скрипта. Просмотр. Изменение

Функция: webaps.install

Данная функция одновременно используется для просмотра и изменения параметров объекта

Просмотр параметров объекта:

  • Параметры:
    • elid - уникальный идентификатор (элемент "name" из функции "webaps.collection")
  • Результат: список параметров

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • domain - Домен.
  • path - Путь.


Информация о APS web-скрипте. Просмотр. Изменение

Функция: webaps.collection.edit

Данная функция одновременно используется для просмотра и изменения параметров объекта

Просмотр параметров объекта:

  • Параметры:
    • elid - уникальный идентификатор (элемент "name" из функции "webaps.collection")
  • Результат: список параметров

Изменение объекта:

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Имя.
  • version - Версия.
  • author - Автор.
  • packager - Упаковщик.
  • description - Описание.


'

Функция: webaps.collection.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "webaps.collection".

Результат: успешное выполнение операции или сообщение об ошибке


Доступ к web-скрипту

Функция: webaps.collection.access

  • ftype - Тип доступа.

Возможные значения :

    • allow - Разрешён всем
    • deny - Запрещён всем
    • allow_partial - Разрешён выборочно
    • deny_partial - Запрещён выборочно
При выбранном значении allow_partial разрешается использовать параметры: 'userlist'
При выбранном значении deny_partial разрешается использовать параметры: 'userlist'
  • userlist - Список пользователей. (Одно или несколько значений, разделенных пробелом)


Обновление коллекции web-скриптов. Просмотр. Изменение

Функция: webaps.collection.update

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):


Удалить установленный web-скрипт

Функция: webaps.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "key" из функции "webaps".

Результат: успешное выполнение операции или сообщение об ошибке


Обслуживание

Сохранить данные

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Сохранение файлов пользователя. Просмотр. Изменение

Функция: backuponeclick

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • destdir - Каталог для архива.


Статистика

Использование диска

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Использование диска

Функция: diskusage

Результат: список элементов

  • name - Имя файла или директории.
  • size - Размер (МБ).


Удалить файл или директорию

Функция: diskusage.delete

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "diskusage".

Результат: успешное выполнение операции или сообщение об ошибке


Системные ресурсы

Использование системных ресурсов

Функция: usersystemresources

Результат: список элементов

  • time - Дата.
  • memory - Память (GB).
  • utime - Пользовательское время CPU (сек).
  • stime - Системное время CPU (сек).
  • etime - Время работы (минуты).
  • io - Операции ввода-вывода.
  • mysqltime - Время MySQL.
  • mysqlrequests - Количество запросов MySQL.


Период отчёта. Просмотр. Изменение

Функция: usersystemresources.edit

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • period - Период.



  • Список активных возможностей можно получить через API-функцию "featurelist"
Была ли эта информация полезной? Да | Нет
Личные инструменты