ISPmanager API/Reseller
Материал из ISPWiki
| Условные обозначения |
|
См. также
Реселлер
Учетные записи
Пользователи
Функция: user
Результат: список элементов
- name - Имя.
- slave - Сервер.
- preset - Шаблон.
- disabled - Учётная запись и её WWW домены временно отключены.
- unex - Для учетной записи не определены свойства и настройки панели.
- cgi - Пользователь может использовать CGI для своих WWW доменов.
- wsgi - Пользователь может использовать WSGI для своих WWW доменов.
- php - Пользователь может использовать PHP для своих WWW доменов.
- ssi - Пользователь может использовать SSI для своих WWW доменов.
- ssl - Пользователь может использовать безопасное соединение по протоколу HTTPs для своих WWW доменов.
- shell - Пользователь может использовать shell.
- usermove - Идет импорт пользователя.
- note - Заметки: .
- disk - Диск. Атрибуты :
- used - Использованное количество.
- limit - Максимально возможное значение.
- bandwidth - Трафик. Атрибуты :
- used - Использованное количество.
- limit - Максимально возможное значение.
Функция: user.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "user")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "user")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name - Имя пользователя.
- passwd - Пароль.
- confirm - Подтверждение.
- owner - Владелец.
- ip - IP-адрес.
- ip6 - IPv6-адрес. Параметр зависим от возможности ipv6.
- domain - Домен.
- preset - Шаблон.
- email - E-mail.
- welcome - Послать сообщение. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- shell - Доступ к shell. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- ssl - SSL. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности ssl.
- cgi - CGI. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности cgi. Активный параметр разрешает следующие параметры: 'phpcgi','phpfcgi'
- wsgi - WSGI. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности wsgi.
- ssi - SSI. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности ssi.
- phpmod - PHP как модуль Apache. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности phpmod.
- phpcgi - PHP как CGI. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности phpcgi.
- phpfcgi - PHP как FastCGI. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности phpfcgi.
- safemode - PHP в режиме safe_mode. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности phpmod.
- disklimit - Диск. Параметр зависим от возможности quota.
- ftplimit - FTP аккаунты. (Числовое значение. Для указания "бесконечности" используйте "10000".) Параметр зависим от возможности ftp.
- maillimit - Почтовые ящики. (Числовое значение. Для указания "бесконечности" используйте "10000".) Параметр зависим от возможности email.
- domainlimit - Домены. (Числовое значение. Для указания "бесконечности" используйте "10000".) Параметр зависим от возможности dns.
- webdomainlimit - WWW домены. (Числовое значение. Для указания "бесконечности" используйте "10000".) Параметр зависим от возможности www.
- maildomainlimit - Почтовые домены. (Числовое значение. Для указания "бесконечности" используйте "10000".) Параметр зависим от возможности email.
- baselimit - Базы данных. (Числовое значение. Для указания "бесконечности" используйте "10000".) Параметр зависим от возможности db.
- baseuserlimit - Пользователи баз данных. (Числовое значение. Для указания "бесконечности" используйте "10000".) Параметр зависим от возможности db.
- bandwidthlimit - Трафик. (Числовое значение. Для указания "бесконечности" используйте "100000000".)
- cpulimit - Ограничение на CPU. (Числовое значение. Для указания "бесконечности" используйте "100000".)
- memlimit - Ограничение на память. (Числовое значение. Для указания "бесконечности" используйте "100000".)
- proclimit - Количество процессов. (Числовое значение. Для указания "бесконечности" используйте "100000".)
- mysqlquerieslimit - Запросов к MySQL. (Числовое значение. Для указания "бесконечности" используйте "100000000".) Параметр зависим от возможности dbhaslimits.
- mysqlupdateslimit - Обновлений MySQL. (Числовое значение. Для указания "бесконечности" используйте "100000000".) Параметр зависим от возможности dbhaslimits.
- mysqlconnectlimit - Соединений к MySQL. (Числовое значение. Для указания "бесконечности" используйте "100000000".) Параметр зависим от возможности dbhaslimits.
- mysqluserconnectlimit - Одновременных соединений к MySQL. (Числовое значение. Для указания "бесконечности" используйте "100000000".) Параметр зависим от возможности dbhasuconnlimits.
- maxclientsvhost - Воркеров apache mpm-itk. (Числовое значение. Для указания "бесконечности" используйте "100000000".) Параметр зависим от возможности apache-mpm-itk.
- limitconn - Одновременных соединений на сессию. (Числовое значение. Для указания "бесконечности" используйте "65535".) Параметр зависим от возможности nginx.
- mailrate - Количество отправляемых писем. (Числовое значение. Для указания "бесконечности" используйте "100000000".) Параметр зависим от возможности mailrate.
- note - .
Функция: user.delete
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: user.enable
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: user.disable
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: iplist
Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "user").
Результат: список элементов
- name - IP-адрес.
- count - WWW доменов.
- domain - WWW-домен по умолчанию.
- rname - Реверсная зона.
Функция: iplist.edit
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "user").
- elid - уникальный идентификатор (элемент "name" из функции "iplist")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "user").
- elid - уникальный идентификатор (элемент "name" из функции "iplist")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- type - Тип адреса. При выбранном значении custom разрешается использовать параметры: 'name'
Возможные значения :
- free - Свободный
- shared - Общедоступный
- assigned - Назначенный
- owner - Владелец.
- domain - Домен по умолчанию. Параметр зависим от возможности www.
- rname - Реверсная зона. Параметр зависим от возможности ipmgr.
Функция: user.access
Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "user").
Результат: список элементов
- ftitle - Название модуля.
- name - Имя функции.
- disabled - Пользователь не имеет доступа к данной функции.
Функция: user.access.enable
Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "user").
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user.access".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: user.access.disable
Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "user").
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "user.access".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: usersystemresources
Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "user").
Результат: список элементов
- time - Дата.
- memory - Память (GB).
- utime - Пользовательское время CPU (сек).
- stime - Системное время CPU (сек).
- etime - Время работы (минуты).
- io - Операции ввода-вывода.
- mysqltime - Время MySQL.
- mysqlrequests - Количество запросов MySQL.
Функция: usersystemresources.edit
- period - Период.
Функция: new.msg
- subj - Тема.
- prio - Приоритет.
- category - Категория.
- text - Текст.
Функция: user.setfilter
Домены
WWW домены
Функция: wwwdomain
Результат: список элементов
- name - Имя.
- ip - IP-адрес.
- docroot - Директория.
- disabled - WWW домен отключен.
- cgi - Данный WWW домен может использовать CGI.
- wsgi - Данный WWW домен может использовать WSGI.
- php - Данный WWW домен может использовать PHP.
- ssi - Данный WWW домен может использовать SSI.
- frp - Данный WWW домен может использовать расширение FrontPage.
- ror - Данный WWW домен может использовать Ruby on rails.
- ssl - Для доступа к данному WWW домену может быть использован протокол HTTPS.
Функция: wwwdomain.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- domain - Доменное имя.
- alias - Псевдонимы. (Одно или несколько значений, разделенных пробелом)
- docroot - Корневая папка.
- owner - Владелец.
- version - Версия интернет протокола. Параметр зависим от возможности ipv6.
При выбранном значении ipv4 разрешается использовать параметры: 'ip4' и запрещается использовать параметры: 'ip6'
- ip - IP-адрес.
- ip6 - IPv6-адрес. Параметр зависим от возможности ipv6.
- pool - Пул приложений. Параметр зависим от возможности iis.
- admin - E-Mail администратора. Параметр зависим от возможности webemail.
- charset - Кодировка.
- index - Индексная страница. (Одно или несколько значений, разделенных пробелом)
- autosubdomain - Авто поддомены. Параметр зависим от возможности asd.
Возможные значения :
- asdnone - Отключены
- asddir - В отдельной директории
- asdsubdir - В поддиректории WWW домена
- php - PHP.
Возможные значения :
- phpnone - Нет поддержки PHP
- phpmod - PHP как модуль Apache
- phpcgi - PHP как CGI
- phpfcgi - PHP как FastCGI
- cgi - Cgi-bin. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности cgi. Активный параметр разрешает следующие параметры: 'ror'
- wsgi - wsgi-scripts. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности wsgi.
- ssi - SSI. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности ssi. Активный параметр разрешает следующие параметры: 'ssiext'
- ssiext - Расширения файлов SSI. Параметр зависим от возможности ssi.
- frp - FrontPage. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности frp. Активный параметр разрешает следующие параметры: 'fppasswd'
- fppasswd - Пароль для FrontPage. Параметр зависим от возможности frp.
- ror - Ruby on rails. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности ror. Активный параметр запрещает следующие параметры: 'autosubdomain'
- ssl - SSL. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности ssl. Активный параметр разрешает следующие параметры: 'sslport','cert'
- sslport - SSL порт. Параметр зависим от возможности ssl.
- cert - SSL сертификат. Параметр зависим от возможности ssl.
- logrequests - Журналировать запросы. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- page_php_th - .
- disable_open_basedir - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
Функция: wwwdomain.delete
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "wwwdomain".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: wwwdomain.delete.confirm
- maildomain - Удалить почтовый домен. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности email.
- dns - Сохранить записи в DNS. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Параметр зависим от возможности dns.
- docroot - Сохранить каталоги и файлы WWW домена. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
Функция: wwwdomain.enable
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "wwwdomain".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: wwwdomain.disable
Параметры:
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "wwwdomain".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: wwwdomain.log
Данная функция одновременно используется для просмотра и изменения параметров объекта
Просмотр параметров объекта:
- Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain")
- Результат: список параметров
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
Функция: errpage
Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain").
Результат: список элементов
- key - Уникальный идентификатор элемента списка.
- domain - WWW домен.
- name - Код ошибки.
- url - URL.
Функция: errpage.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - уникальный идентификатор (элемент "key" из функции "errpage")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - уникальный идентификатор (элемент "key" из функции "errpage")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- 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
Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "key" из функции "errpage".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: wwwredirect
Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain").
Результат: список элементов
- name - Путь.
- code - Код.
- url - Url.
Функция: wwwredirect.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - уникальный идентификатор (элемент "name" из функции "wwwredirect")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - уникальный идентификатор (элемент "name" из функции "wwwredirect")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- domain - WWW домен.
- name - URL-путь.
- code - Код.
- url - URL.
Функция: wwwredirect.delete
Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "wwwredirect".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: wwwaddtypes
Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain").
Результат: список элементов
- key - Уникальный идентификатор элемента списка.
- domain - WWW-домен.
- name - Тип данных.
- val - Расширение файла.
Функция: wwwaddtypes.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - уникальный идентификатор (элемент "key" из функции "wwwaddtypes")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - уникальный идентификатор (элемент "key" из функции "wwwaddtypes")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- domain - Домен.
- name - Тип данных.
- val - Расширение файла.
Функция: wwwaddtypes.delete
Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "key" из функции "wwwaddtypes".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: resets
Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain").
Результат: список элементов
- reset - Уникальный идентификатор элемента списка.
- client_ip - IP-адрес клиента.
- uri - Универсальный идентификатор ресурса (URI).
- header - HTTP-заголовок.
Функция: resets.edit
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - уникальный идентификатор (элемент "reset" из функции "resets")
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok- значение параметра должно быть не пустым, обычно "yes".
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - уникальный идентификатор (элемент "reset" из функции "resets")
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- client_ip - IP-адрес.
- uri - URI.
- header - HTTP-заголовок.
Функция: resets.delete
Параметры:
- plid - уникальный идентификатор родительского списка (элемент "name" из функции "wwwdomain").
- elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "reset" из функции "resets".
Результат: успешное выполнение операции или сообщение об ошибке
Функция: httpusage
Параметры:
- elid - уникальный идентификатор (элемент "name" из функции "wwwdomain").
Результат: список элементов
- time - Дата.
- in - Входящий трафик.
- out - Исходящий трафик.
- resptime - Суммарное время работы скриптов.
- requests - Количество запросов.
Функция: httpusage.edit
- period - Период.
- Список активных возможностей можно получить через API-функцию "featurelist"
