Конструктор сайтов (sitebuilder)

sitebuilder

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

Конструктор сайтов

Уровень доступа: admin user

Параметр	Значение
`domain`	Доменное имя.
`ip`	IP-адрес.
`username`	Имя пользователя.
`id`	Id.
`pricelist`	Тариф.
`account`	Клиент.
`project`	Провайдер.
`datacentername`	Дата-центр.
`processingmodule`	Модуль обработки.
`createdate`	Дата создания.
`expiredate`	Действует до.
`autoprolong`	Автопродление.
`status_msg`	Описание текущего состояния.
`item_status`	Статус услуги. Может принимать значения: 1 — заказана; 2 — активна; 3 — остановлена; 4 — удалёна; 5 — обрабатывается
`cost`	Стоимость.

Принудительная перезагрузка сервера в панели управления

Функция: service.hardreboot

Принудительная перезагрузка сервера в панели управления.

Уровень доступа: admin user

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

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

Войти в панель с правами пользователя

Функция: sitebuilder.su

Войти в панель с правами пользователя.

Уровень доступа: admin

Включить

Функция: sitebuilder.resume

Включить.

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

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

Статистика по использованию ресурсов

Функция: service.stat

Уровень доступа: admin user

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

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

Параметры:
- elid — уникальный идентификатор (элемент id из функции sitebuilder);
Результат: список параметров объекта.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции sitebuilder);
Результат: успешное выполнение операции или сообщение об ошибке.

Задать вопрос по услуге

Функция: service.ask

Задать вопрос по услуге

Уровень доступа: user

Остановить услугу

Функция: service.stop

Услуга перейдёт в остановленное состояние, тарификация будет производиться по правилам для приостановленных услуг. Позже можно запустить услугу самостоятельно.

Уровень доступа: admin user

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

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

Доменное имя услуги

Функция: sitebuilder.domain

Уровень доступа: admin user

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

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

Параметры:
- elid — уникальный идентификатор (элемент id из функции sitebuilder).
Результат: список параметров объекта.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok.
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok.
- elid — уникальный идентификатор (элемент id из функции sitebuilder).
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметр	Значение
`freedomain_name`	Бесплатное доменное имя.
`additional_domain`	Дополнительное доменное имя.
`owndomain`	Доменное имя.
`ordereddomain`	Доменное имя.

Перезагрузка сервера в панели управления

Функция: service.reboot

Перезагрузка сервера в панели управления.

Уровень доступа: admin user

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

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

Конфигурация услуги

Функция: service.detail

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

Конфигурация услуги.

Уровень доступа: admin+

Параметр	Значение
`id`	Id.
`name`	Наименование.
`addonlimit`	Включено в тариф.
`value`	Заказано дополнительно.
`props`	Стоимость.

Удалить выделенные записи

Функция: service.detail.delete

Удалить выделенные записи.

Уровень доступа: admin+

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент idkey из функции service.detail.

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

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

Функция: service.detail.edit

Уровень доступа: admin+

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметр	Значение
`plid`	Уникальный идентификатор родительского списка (элемент `id` из функции `sitebuilder`).
`elid`	Уникальный идентификатор (элемент `idkey` из функции `service.detail`).
`sok`	Значение параметра должно быть не пустым, обычно `ok`.
`name`	Наименование. Укажите наименование для ресурса, которое будет отображаться в интерфейсе и документах.
`pricelist_measure`	Единица измерения дополнения.
`manualvalue`	Количество предоставляемого ресурса.
`intvalue`	Дополнительно заказано. Значения от до.
`boolvalue`	Значение ресурса. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`enumerationitem`	Значение. Выберите значение ресурса.
`no_check_addon`	Значение дополнения к услуге будет изменено без выполнения проверки модулем обработки. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`addonlimit`	Включено в тариф.
`addonbool`	Значение ресурса, предоставляемое тарифным планом. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`addonenumerationitem`	Включено в тариф.
`noexpense`	Выберите опцию, если не нужно списывать или возвращать деньги за текущую операцию изменения ресурсов. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`reboot`	Перезагрузить сервер после применения параметров. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.

Заказать новую услугу

Функция: sitebuilder.order

Заказать новую услугу

Уровень доступа: user

IP-адрес

Функция: service.ip

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

IP-адреса.

Уровень доступа: admin user

Параметр	Значение
`id`	Id.
`name`	IP-адрес.
`mask`	Маска.
`gateway`	Шлюз.
`domain`	Домен.
`type`	Тип.
`ip_status`	Статус.
`ip_clientstatus`	Статус клиента.

Проверка статуса IP-адреса

Функция: service.ip.checkadd

Уровень доступа: admin user

Проверяет статус выданного IP-адреса со стороны интегрируемой платформы. Если IP-адрес уже занят услугой, платформа выбирает другой IP-адрес.

Параметры:
- ip — IP-адрес для проверки. Допустимы IPv4 и IPv6;
- item — id услуги, для которой надо проверить возможность использования указанного IP-адреса.
Результат:
- если указанный IP-адрес занят услугой, отличной от переданной в параметре item , функция возвращает флаг ip_on_active_item=on ;
- если указанный IP-адрес свободен или занят той же услугой, что указана в параметре item , флаг не возвращается.

Перенос IP-адреса

Функция: service.ip.move

Уровень доступа: admin user

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
- elid — уникальный идентификатор (элемент id из функции service.ip);
Результат: список параметров объекта.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
- elid — уникальный идентификатор (элемент id из функции service.ip);
Результат: успешное выполнение операции или сообщение об ошибке.

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

item — Id услуги, к которой переносится IP-адрес;
noexpense — IP-адрес будет добавлен без списания средств со счёта клиента. Чтобы включить опцию, используйте значение on. Необязательный параметр;
postpaid — Если опция выбрана, то при нехватке средств на счёте расход будет создан в долг. Чтобы включить опцию, используйте значение on. Необязательный параметр.

IP-адрес

Функция: service.ip.edit

Уровень доступа: admin user

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

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

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
- elid — уникальный идентификатор (элемент id из функции service.ip);
Результат: список параметров объекта.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok.
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
- elid — уникальный идентификатор (элемент id из функции service.ip);
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметр	Значение
`type`	Тип добавляемого IP-адреса.
`pools`	Пул IP. Укажите пул, в котором находится данный IP-адрес.
`domain`	Домен. Обратная PTR-запись для IP-адреса.
`ippool`	Пул IP. Укажите пул, в котором находится данный IP-адрес.
`name`	IP-адрес.
`mask`	Маска подсети, используется другими продуктами для настройки сети.
`gateway`	Адрес шлюза, используется другими продуктами для настройки сети.
`addinpanel`	Отключите опцию, если не нужно добавлять адрес в панель управления. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`addinipmgr`	Отключите опцию, если не нужно резервировать IP-адрес в IPmanager. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`count`	Количество создаваемых адресов. Значения от 1 до 1000.
`noexpense`	IP-адрес будет добавлен без списания средств со счёта клиента. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`postpaid`	Если опция включена, то при нехватке средств на счёте расход будет создан в долг. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`reboot`	Перезагрузить сервер после применения параметров. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.

Удаление IP-адреса

Функция: service.ip.del.admin

Уровень доступа: admin+

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
- elid — уникальный идентификатор (элемент id из функции service.ip);
Результат: список параметров объекта

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder);
- elid — уникальный идентификатор (элемент id из функции service.ip);
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметр	Значение
`noexpense`	IP-адрес будет удалён без возврата средств на счёт клиента. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`manual`	Адрес будет удалён только из биллинга. Наличие адреса в панели управления и IPmanager не проверяется. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`ipcount`	Общее количество удаляемых IP-адресов.
`cost`	Сумма возврата, которая будет зачислена на счёт клиента после удаления IP-адресов.

Удалить

Функция: service.ip.delete

Удалить

Уровень доступа: user

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент id из функции service.ip

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

История IP-адреса

Функция: service.ip.history

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

История IP-адреса.

Уровень доступа: admin user

Параметр	Значение
`changedate`	Дата изменения.
`desc`	Описание.
`user`	Имя пользователя.
`ip`	IP-адрес.
`action`	Функция.

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

Функция: sitebuilder.edit

Уровень доступа: admin user

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

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

Параметры:
- elid — уникальный идентификатор (элемент id из функции sitebuilder).
Результат: список параметров объекта.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok.
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции sitebuilder);
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметр	Значение
`processingmodule`	Модуль обработки
`autoprolong`	Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия.
`createdate`	Дата заказа услуги.
`opendate`	Дата фактического начала действия услуги.
`expiredate`	Действует до. Срок действия услуги.
`scheduledclose`	Запланировано удаление по окончанию оплаченного периода. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`reboot`	Перезагрузка. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.
`note`	Комментарий к услуге. Виден только сотрудникам провайдера.
`noexpense`	Выберите опцию, если не нужно списывать или возвращать деньги за текущую операцию изменения ресурсов. Чтобы включить опцию, используйте значение `on`. Необязательный параметр.

Выключить конструктор сайтов

Функция: sitebuilder.suspend

Выключить конструктор сайтов.

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

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

Установить фильтр по клиенту

Функция: sitebuilder.setfilter

Установить фильтр по клиенту.

Уровень доступа: admin

Написать запрос клиенту

Функция: ticket.write.service

Написать запрос клиенту.

Уровень доступа: admin

Смена пароля

Функция: service.changepassword

Уровень доступа: admin user

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

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

Параметры:
- elid — уникальный идентификатор (элемент id из функции sitebuilder);
Результат: список параметров объекта

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции sitebuilder);
Результат: успешное выполнение операции или сообщение об ошибке.

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

passwd — новый пароль для услуги;
confirm — подтверждение.

Инструкция об использовании услуги

Функция: service.instruction.html

Инструкция об использовании услуги.

Уровень доступа: admin user

Продление услуги

Функция: service.prolong

Уровень доступа: admin user

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

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

Параметры:
- elid — уникальный идентификатор (элемент id из функции sitebuilder).
Результат: список параметров объекта

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok.
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции sitebuilder).
Результат: успешное выполнение операции или сообщение об ошибке.

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

period — Период. Выберите период, на который необходимо продлить услугу.

Удалить выделенные услуги

Функция: sitebuilder.delete

Удалить выделенные услуги.

Уровень доступа: admin user

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

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

Запустить услугу

Функция: service.start

Услуга перейдёт в запущенное состояние, тарификация будет производиться по правилам для запущенных услуг.

Уровень доступа: admin user

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделённых запятой и пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

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

Открытие услуги

Функция: sitebuilder.open

Уровень доступа: admin

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

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

Параметры:
- elid — уникальный идентификатор (элемент id из функции sitebuilder);
Результат: список параметров объекта.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
Результат: успешное выполнение операции или сообщение об ошибке.

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

Параметры:
- sok — значение параметра должно быть не пустым, обычно ok;
- elid — уникальный идентификатор (элемент id из функции sitebuilder);
Результат: успешное выполнение операции или сообщение об ошибке.

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

processingmodule — Модуль обработки, назначенный услуге.

Установка фильтра

Функция: sitebuilder.filter

Сменить тариф

Функция: service.changepricelist

Сменить тариф.

Уровень доступа: admin

Параметры:

elid — id лицензии;
pricelist — id тарифа;
su — логин администратора.

История изменения услуги

Функция: service.history

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

История изменения услуги.

Уровень доступа: admin user

Параметр	Значение
`changedate`	Дата изменения.
`desc`	Описание изменения.
`user`	Имя пользователя.
`ip`	IP-адрес.
`action`	Функция.