BILLmanager API

Материал из ISPWiki
Перейти к: навигация, поиск

На этой странице расположено описание функций панели управления и их параметров, сгенерированное автоматически.

Про то как работать с API и вызывать эти фунцкии описано в статье Взаимодействие_через_API.

Так как страница сгенерирована автоматически, она может содержать отличия, в зависимости от конкретной конфигурации. Точное имя фунции и параметры можно получить, открыв лог файл панели управления, и выполнить нужную функцию через интерфейс.

Имя функции и все параметры будут присутствовать в логе.


Содержание

Реферальная программа

Функция: affiliate.client

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

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

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

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

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

  • affiliate - Реферальная программа. Выберите реферальную программу, в которой собираетесь участвовать
  • url - Реферальная ссылка. Так выглядит ваша реферальная ссылка
  • promocode - Промокод. Клиенты, которые введут этот промокод, будут считаться приведенными вами

Перечисления

Функция: enumeration

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

Перечисления

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

  • id - Id
  • name - Наименование
  • intname - Внутреннее наименование

Удалить

Функция: enumeration.delete

Удалить

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

Параметры:

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

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

Перечисление

Функция: enumeration.edit

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

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

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

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

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

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

  • name - Наименование. Наименование
  • intname - Внутреннее наименование. Внутреннее (служебное) наименование

Наименование

Функция: enumerationitem

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

Элементы перечисления

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

  • id - Id
  • name - Наименование
  • intname - Внутреннее наименование

Удалить

Функция: enumerationitem.delete

Удалить

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

Параметры:

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

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

Элемент перечисления

Функция: enumerationitem.edit

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

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

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

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

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

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

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

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


  • name - Наименование. Наименование
  • intname - Внутреннее наименование. Внутреннее (служебное) наименование

Сотрудники

Функция: employee

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

Сотрудники

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

  • id - Id
  • name - Логин
  • realname - ФИО
  • email - Email
  • department - Отделы
  • status - Параметры

Отключить сотруднику доступ к биллингу

Функция: employee.suspend

Отключить сотруднику доступ к биллингу

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

Параметры:

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

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

Отдел

Функция: employee.department

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

Отделы, в которые входит сотрудник

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

  • id - Id
  • name - Отдел
  • status - Состояние

Исключить сотрудника из отдела

Функция: employee.department.suspend

Исключить сотрудника из отдела

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

Параметры:

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

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

Включить сотрудника в отдел

Функция: employee.department.resume

Включить сотрудника в отдел

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

Параметры:

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

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

Войти с правами сотрудника

Функция: employee.su

Войти с правами сотрудника

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

Удалить

Функция: employee.delete

Удалить

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

Параметры:

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

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

Наименование

Функция: rights2.user

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

Права пользователя

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

  • caption - Наименование
  • access - Доступ

Включить

Функция: rights2.user.resume

Включить

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

Параметры:

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

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

Выключить

Функция: rights2.user.suspend

Выключить

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

Параметры:

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

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

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

rights2.user.filter

Частично ограничить доступ к элементам списка. Устанавливать фильтр для списка. Отфильтрованные (исключенные) записи будут недоступны

Функция: rights2.user.hardfilter

Частично ограничить доступ к элементам списка. Устанавливать фильтр для списка. Отфильтрованные (исключенные) записи будут недоступны

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

Настройки центра поддержки сотрудника

Функция: employee.support_tool_settings

Настройки центра поддержки сотрудника

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

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

employee.filter

Включить сотруднику доступ к биллингу

Функция: employee.resume

Включить сотруднику доступ к биллингу

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

Параметры:

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

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

Отправка СМС сообщения

Функция: employee.sms

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

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

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

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

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

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

  • type - Выбор номера телефона. Тип номера телефона, на который будет отправлено сообщение
  • phone - Номер. Номер телефона, на который будет отправлено сообщение
  • message - Сообщение. Отправляемое сообщение

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

Функция: employee.edit

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

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

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

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

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

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

  • name - Логин. Логин для входа
  • realname - ФИО. Фамилия, Имя, Отчество
  • position - Должность. Должность сотрудника. Отображается в запросах в интерфейсе BILLmanager 6. Например, Консультант службы технической поддержки
  • passwd - Пароль. Пароль доступа
  • confirm - Подтверждение. Подтверждение пароля
  • department - Отделы. Выберите отделы, в которые необходимо включить данного сотрудника
  • email - Email. Укажите Email адрес сотрудника
  • phone - Номер телефона. Номер телефона сотрудника. Может быть использован для отправки СМС уведомлений
  • default_access_allow - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить сотруднику полный доступ, никак не ограничивая его в правах.

Регламент

Функция: ticket_schedule

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

Регламент

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

  • id - Id
  • locale_name - Наименование
  • project - Провайдер
  • schedule - Регламент
  • attitude - Характеристика клиента
  • priority - Приоритет
  • user_department - Отдел
  • account_group - Группа клиентов

Удалить

Функция: ticket_schedule.delete

Удалить

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

Параметры:

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

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

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

ticket_schedule.filter

Настройки регламента

Функция: ticket_schedule.edit

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

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

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

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

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

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

  • type - Условие. Условие применения регламента. Недоступно для изменения после создания регламента
  • comparison - Сравнение. Условие сравнения
  • value - Значение. Значение параметра
  • amount - Сумма. Сумма
  • project - Провайдер. Провайдер, к которому относится регламент. Недоступно для изменения после создания регламента
  • pricelist - Тарифный план. Тарифный план услуги
  • pricelist_addon - Дополнение. Дополнение тарифного плана
  • enumerationitem - Значение дополнения. Заказанное значение перечисления
  • account_client - Клиент. Клиент, для которого применяется регламент
  • account_group - Группа клиентов. Группа клиентов, для которой настраивается регламент
  • attitude - Характеристика клиента. Характеристика клиента, создавшего запрос
  • priority - Приоритет запроса. Приоритет запроса
  • user_department - Отдел. Отдел, на который назначен запрос
  • time_schedule - Регламент ответа. Время, за которое должен быть получен ответ
  • highpriority - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди

Заблокированные email

Функция: gateway_blacklist

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

Заблокированные email адреса

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

  • id - Id
  • name - Email адрес

Удалить

Функция: gateway_blacklist.delete

Удалить

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

Параметры:

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

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

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

gateway_blacklist.filter

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

Функция: sitebuilder

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

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

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

  • domain - Доменное имя
  • ip - IP-адрес
  • username - Имя пользователя
  • id - Id
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

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

Функция: service.hardreboot

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

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

Параметры:

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

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

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

Функция: sitebuilder.su

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

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

Включить

Функция: sitebuilder.resume

Включить

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

Параметры:

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

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

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

Функция: service.stat

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

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

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

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

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

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

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

Функция: service.ask

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

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

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

Функция: service.stop

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

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

Параметры:

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

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

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

Функция: sitebuilder.domain

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

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

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

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

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

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

  • 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".
    • plid - уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

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

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

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


  • 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.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 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) IP адрес будет добавлен без списания средств со счета клиента
  • 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-адреса. Тип добавляемого IP-адреса
  • pools - Пул IP. Укажите пул, в котором находится данный IP-адрес
  • domain - Домен. Обратная PTR запись для IP адреса
  • ippool - Пул IP. Укажите пул, в котором находится данный IP-адрес
  • name - IP-адрес. IP-адрес
  • mask - Маска подсети. Маска подсети, используется другими продуктами для настройки сети
  • gateway - Адрес шлюза. Адрес шлюза, используется другими продуктами для настройки сети
  • addinpanel - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Снимите галочку, если не нужно добавлять адрес в панель управления
  • addinipmgr - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Снимите галочку, если не нужно резервировать IP-адрес в IPmanager'е
  • count - Количество. Количество создаваемых адресов. Значения от 1 до 1000
  • noexpense - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) IP адрес будет добавлен без списания средств со счета клиента
  • 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 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) IP-адрес будет удален без возврата средств на счет клиента
  • manual - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Адрес будет удален только из биллинга. Наличие адреса в панели управления и IPmanager не проверяется
  • ipcount - Количество адресов. Общее количество удаляемых IP-адресов
  • cost - Сумма возврата. Сумма, которая будет зачислена на счет клиента после удаления IP-адресов

Удалить

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

Удалить

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

Параметры:

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

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

Наименование

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

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

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

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

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

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

Функция: sitebuilder.edit

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

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

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

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

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

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

  • 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

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

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

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

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

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

  • passwd - . Новый пароль для услуги
  • confirm - Подтверждение.

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

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

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

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

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

Функция: service.prolong

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

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

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

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

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

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

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

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

Функция: sitebuilder.delete

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

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

Параметры:

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

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

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

Функция: service.start

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

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

Параметры:

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

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

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

Функция: sitebuilder.open

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

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

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

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

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

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

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

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

sitebuilder.filter

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

Функция: service.changepricelist

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

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

Наименование

Функция: service.history

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

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

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

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

Отчеты

Функция: reportlist

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

Отчеты

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

  • report - Наименование отчета

Генерация отчета

Функция: report.open

Генерация отчета

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

Виртуальные серверы

Функция: vds

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

Виртуальные выделенные серверы

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

  • domain - Доменное имя
  • ip - IP-адрес
  • ostempl - Шаблон ОС
  • processingnode - Узел кластера
  • serverid - Наименование
  • id - Id
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

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

Функция: vds.delete

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

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

Параметры:

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

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

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

Функция: vds.su

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

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

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

vds.filter

Выключить

Функция: vds.suspend

Выключить

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

Параметры:

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

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

Включить

Функция: vds.resume

Включить

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

Параметры:

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

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

Создание запроса на перенос Виртуального сервера в ВДЦ

Функция: vds.movetovdc

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

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

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

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

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

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

  • vdc - Виртуальный дата-центр. Выберите в какой виртуальный дата-центр будут перенесены виртуальные серверы

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

Функция: vds.order

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

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

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

Функция: vds.setfilter

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

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

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

Функция: vds.edit

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

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

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

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

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

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

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

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

Функция: vds.open

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

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

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

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

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

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

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

Планировщик

Функция: scheduler

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

Планировщик

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

  • command - Команда
  • interval - Период
  • schedule_type - Расписание
  • state - Статус
  • description - Описание

Восстановление

Функция: scheduler.prop

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

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

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

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

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

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

  • mailto - Адрес e-mail. Адрес электронной почты для отправки отчетов о выполнении заданий
  • path - Путь. Пути поиска исполняемых файлов. Пути разделяются двоеточием

Выполнить задание сейчас

Функция: run

Выполнить задание сейчас

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

Удалить

Функция: scheduler.delete

Удалить

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

Параметры:

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

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

Задание

Функция: scheduler.edit

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

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

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

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

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

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

  • mailto - Адрес e-mail. Адрес e-mail можно указать в настройках планировщика
  • command - Команда. Команда, выполняемая по расписанию
  • description - Описание. Произвольное описание задания
  • active - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Задание будет выполняться в заданное время, если оно включено
  • schedule_type - Расписание. Расписание можно настроить как в базовом режиме, выбрав из предложенных вариантов, так и в экспертном режиме, введя соответствующие значения
  • run_every - Выполнять. Период выполнения задания
  • time_hour - Выполнить в. Часы и минуты начала выполнения задания
  • time_min - . Часы и минуты начала выполнения задания
  • wday1 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждый понедельник
  • wday2 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждый вторник
  • wday3 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждую среду
  • wday4 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждый четверг
  • wday5 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждую пятницу
  • wday6 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждую субботу
  • wday0 - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждое воскресенье
  • month - Месяц. Месяц выполнения задания
  • month_day - День месяца. Число месяца, в которое будет выполняться задание
  • input_min - Минуты. Формат: * - все минуты; */n - каждые n минут; n - с началом минуты n; a,b,c-e - с началом минут a,b,c,d,e
  • input_hour - Часы. Формат: * - все часы; */n - каждые n часов; n - с началом часа n; a,b,c-e - с началом часа a,b,c,d,e
  • input_dmonth - Дни месяцев. Формат: * - все дни месяца; */n - каждые n-й день месяца; n - с началом n-го дня месяца; a,b,c-e - с началом дня номер a,b,c,d,e
  • input_month - Месяцы. Формат: * - все месяцы; */n - каждые n-й месяц; n - с началом n-го месяца; a,b,c-e - с началом месяца номер a,b,c,d,e
  • input_dweek - Дни недели. Формат: * - все дни недели; */n - каждые n-й день недели; n - с началом n-го дня недели; a,b,c-e - с началом дня недели номер a,b,c,d,e (0 - воскресенье)
  • hideout - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Скрыть результат выполнения команды, отчет не будет отправляться на e-mail, указанный в параметрах планировщика

Выключить

Функция: scheduler.suspend

Выключить

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

Параметры:

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

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

Включить

Функция: scheduler.resume

Включить

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

Параметры:

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

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

Запросы

Функция: clientticket

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

Список запросов

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

  • id - Id
  • name - Тема
  • last_message - Последнее сообщение
  • wait_time - Задержка
  • create_user - Автор
  • tstatus - Статус

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

clientticket.filter

Купить обращения в техническую поддержку для администрирования ваших услуг

Функция: incident

Купить обращения в техническую поддержку для администрирования ваших услуг

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

Запрос

Функция: clientticket.edit

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

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

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

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

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

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

  • name - Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item - Услуга. Услуга, к которой относится запрос
  • ticket_project_select - Провайдер. Провайдер, к которому относится тема запроса
  • client_department - Отдел. Отдел провайдера, в который будет передан запрос
  • item - Услуга. Услуга, к которой относится запрос
  • client_priority - Приоритет. Приоритет запроса
  • priority - Приоритет. Приоритет запроса
  • message - Текст сообщения. Текст добавляемого сообщения
  • show_optional - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут отображены дополнительные настройки запроса
  • note_message - .
  • ticket_expense - Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count - .
  • show_abuse - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score - Количество баллов. Количество баллов за нарушение
  • action - Функция.
  • deadline_date - .
  • deadline_time - .
  • score_note - Комментарий. Комментарий к нарушению

Переместить запрос в архив

Функция: clientticket.archive

Переместить запрос в архив

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

Параметры:

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

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

Запросы

Функция: ticket

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

Запросы

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

  • id - Id
  • ticket - Запрос
  • name - Тема
  • client - Клиент
  • delay - Задержка
  • date_start - Дата создания
  • deadline - Осталось
  • responsible - Ответственный
  • project - Провайдер
  • queue - Очередь
  • location - Размещение
  • props - Свойства

Разблокировать запрос

Функция: ticket.unblock

Разблокировать запрос

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

Параметры:

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

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

Наименование

Функция: ticket.message

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

Список сообщений запроса

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

  • id - Id
  • message - Сообщение
  • date_post - Дата написания
  • message_user - Автор

Редактирование сообщения

Функция: ticket.message.edit

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

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

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

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

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

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

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

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


  • message - Сообщение. Текст сообщение

Разделить запрос на два начиная с выбранного сообщения

Функция: ticket.split

Разделить запрос на два начиная с выбранного сообщения

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

Параметры:

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

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

Скрыть сообщение от клиента

Функция: ticket.message.delete

Скрыть сообщение от клиента

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

Параметры:

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

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

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

ticket.filter

Добавить запрос в избранные и отслеживать историю по нему

Функция: ticket.favorite

Добавить запрос в избранные и отслеживать историю по нему

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

Параметры:

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

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

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

Функция: ticket.su

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

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

Запрос

Функция: ticket.edit

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

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

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

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

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

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

  • name - Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item - Услуга. Услуга, к которой относится запрос
  • ticket_project_select - Провайдер. Провайдер, к которому относится тема запроса
  • client_department - Отдел. Отдел провайдера, в который будет передан запрос
  • item - Услуга. Услуга, к которой относится запрос
  • client_priority - Приоритет. Приоритет запроса
  • priority - Приоритет. Приоритет запроса
  • message - .
  • show_optional - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут отображены дополнительные настройки запроса
  • note_message - .
  • ticket_expense - Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count - Обращения в поддержку. Количество "обращений в поддержку" списанных за запрос. При увеличении указанного количества будут списаны дополнительные "обращения", при уменьшении разница будет возвращена клиенту
  • show_abuse - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score - Количество баллов. Количество баллов за нарушение
  • action - Функция.
  • deadline_date - .
  • deadline_time - .
  • score_note - Комментарий. Комментарий к нарушению

Закрыть запрос (удалить из очереди)

Функция: ticket.delete

Закрыть запрос (удалить из очереди)

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

Параметры:

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

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

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

Функция: ticket.setfilter

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

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

Шаблоны ответов

Функция: anstempl

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

Шаблоны ответов

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

  • id - Id
  • name - Наименование
  • project - Провайдер
  • template_type - Тип шаблона
  • department - Отдел
  • orderpriority - Порядок сортировки
  • props - Свойства

Переместить на одну позицию вверх

Функция: anstempl.up

Переместить на одну позицию вверх

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

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

anstempl.filter

Удалить

Функция: anstempl.delete

Удалить

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

Параметры:

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

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

Шаблон ответа

Функция: anstempl.edit

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

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

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

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

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

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

  • name - Наименование. Наименование
  • message - Текст сообщения. Текст сообщения шаблона. Можно использовать макросы:
    %PROJECT% - наименование провайдера
    %SUPPORTUSER% - ФИО сотрудника, отвечающего в запросе
    %USER% - ФИО пользователя клиента
    %SERVICE% - наименование выбранной услуги
  • orderpriority - Порядок сортировки. Порядок сортировки шаблонов в форме вставки
  • project - Провайдер. Провайдер, для которого будет использоваться шаблон
  • shared_for_all - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает доступ к шаблону всем сотрудникам, либо сотрудникам выбранного отдела
  • user_department - Отдел. Отдел, которому будет доступен шаблон

Переместить на одну позицию вниз

Функция: anstempl.down

Переместить на одну позицию вниз

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

Контроль качества

Функция: selecttickets

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

Контроль качества

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

  • id - Id
  • name - Наименование

Наименование

Функция: selecttickets.rate.category

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

Категории оценок

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

  • id - Id
  • name - Наименование

Редактирование категории оценок

Функция: selecttickets.rate.category.edit

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

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

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

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

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

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

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

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


  • name - Наименование. Наименование

Удалить

Функция: selecttickets.rate.category.delete

Удалить

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

Параметры:

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

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

Показать записи, попавшие в выборку

Функция: selecttickets.selection

Показать записи, попавшие в выборку

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

Выборка запросов

Функция: selecttickets.edit

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

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

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

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

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

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

  • name - Наименование. Наименование
  • type - Тип выборки. В выборку будут попадать чаты или запросы
  • email_list - Список email. Список email-адресов, которые будут доступны для выбора при отправке оцененного запроса

Наименование

Функция: selecttickets.rule

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

Условия на выборку запросов

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

  • id - Id
  • rule - Условие
  • rulegroup - Группа условий

Удалить

Функция: selecttickets.rule.delete

Удалить

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

Параметры:

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

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

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

Функция: selecttickets.rule.edit

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

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

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

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

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

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

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

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


  • type - Тип.
  • group - Группа условий. Условия в группе будут объединены оператором ИЛИ. Группы между собой связаны по оператору И. Пример: есть условия A, B и С объединенные в одну группу и есть условия D и E объединенные в другую группу. Итоговое выражение тогда будет - (A ИЛИ B ИЛИ С) И (D ИЛИ E)
  • groupname - Имя группы. Введите имя группы условий

Запустить отбор запросов по правилам

Функция: selecttickets.runselection

Запустить отбор запросов по правилам

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

Параметры:

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

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

Удалить

Функция: selecttickets.delete

Удалить

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

Параметры:

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

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

Поддержка по обращениям

Функция: paidsupport

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

Поддержка по обращениям

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

  • ticket_usage - Использование
  • id - Id
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

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

Функция: paidsupport.order

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

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

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

Функция: paidsupport.delete

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

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

Параметры:

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

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

Покупка дополнительной поддержки

Функция: paidsupport.edit

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

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

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

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

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

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

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

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

paidsupport.filter

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

Функция: paidsupport.open

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

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

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

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

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

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

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

Включить

Функция: paidsupport.resume

Включить

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

Параметры:

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

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

Выключить

Функция: paidsupport.suspend

Выключить

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

Параметры:

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

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

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

Функция: paidsupport.setfilter

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

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

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

Функция: paidsupport.su

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

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

Глобальные настройки

Функция: settings

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

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

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

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

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

  • DeleteManualSuspend - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Политика включает удаление по расписанию услуг, остановленных администратором. По умолчанию удаляются только услуги, остановленные в результате истечения срока действия или при нехватке средств на продление. Срок удаления задается в настройках тарифного плана либо в настройках типа продукта
  • AllowDeleteNotification - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Политика разрешает клиентам удаление уведомлений из соответствующего раздела
  • NoProjectSelect - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция отключает возможность клиенту переключить провайдера после авторизации
  • HideClosedItem - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Во всех списках где отображаются услуги, услуги со статусом "Удалена" не будут отображаться
  • DeleteInactiveAccount - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает автоматическое удаление клиентов, без зачисленных платежей, расходов и активных услуг, последняя активность которых была более чем указанное количество дней. При проверке активности анализируются: созданные платежи, заказанные услуги, запросы в техподдержку и привлеченные по реферальной программе клиенты
  • DeleteInactiveAccountPeriod - При отсутствии активности более. Срок, в течении которого клиент не проявлял активности
  • DeleteInactiveAccountNotify - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает отправку клиенту уведомления об удалении учетной записи
  • NearDeleteInactiveAccountNotify - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает отправку предварительных уведомлений о скором удалении учетной записи
  • NearDeleteInactiveAccountPeriod - Срок отправки предварительного уведомления. Количество дней до даты удаления через пробел
  • ignore_accounts - Исключить клиентов из отчетов. Список Id клиентов, которые не будут учитываться в отчетах. Числа через запятую. Некоторые отчеты используют статистику, которая собирается ежедневно, в таких отчетах новодобавленный клиент будет исключен со следующего дня.
  • HideDiscount - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция отключает отображение размера скидки на шаге заказа услуг
  • PostPaidPaymentExpenseDate - Счет по неоплаченным расходам. Способ включения в ежемесячный счет неоплаченных расходов
  • ProRataCreateDate - Дата оказания услуги при календарном списании. Выбор выставления даты оказания услуги при календарном списании
  • PaymentWizardOrder - Порядок совершения оплаты. Порядок шагов при выписке счета
  • AllowAnyCountryForProfile - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить клиенту создавать плательщиков из стран, отличных от указанной при регистрации страны. Не рекомендуется использовать, если используются ставки налогов. Подробно о логике работы приложения при включении данной опции читайте статью справки
  • ProhibitDifferentProfileTypes - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить клиентам создавать плательщиков с разным статусом. Клиент не сможет одновременно быть и юридическим, и физическим лицом
  • AutoPayment - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить автоматическое выставление счетов при низком балансе
  • CountProfileType_1 - Количество физических лиц. Ограничить количество плательщиков с типом "Физическое лицо" для одного клиента. Пустое значение - без ограничений.
  • CountProfileType_2 - Количество юридических лиц. Ограничить количество плательщиков с типом "Юридическое лицо" для одного клиента. Пустое значение - без ограничений.
  • CountProfileType_3 - Количество индивидуальных предпринимателей. Ограничить количество плательщиков с типом "Индивидуальный предприниматель" для одного клиента. Пустое значение - без ограничений.
  • ProfileValidationPolicy - Политика изменения данных. Политика поведения системы для верифицированных плательщиков
  • DefaultInvoiceType - Тип генерации актов. Тип генерации актов, выставляемый плательщикам по умолчанию
  • InvoiceCurrencyDate - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При создании акта по неоплаченным расходам, в случае если валюта выставления акта отличается от валюты лицевого счета, по умолчанию курс валюты берется на текущую дату. При наличии данной опции, курс будет браться на дату указанную как дата создания акта выполненных работ
  • ProfileCreateNotification - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции на email плательщика будет отправлено информационное уведомление. Только для физических лиц и индивидуальных предпринимателей
  • StatNotificationType - Отправлять уведомление. Политика оптравки уведомлений при списании за потребление ресурсов сверх включенных в тарифный план
  • StatExpensePolicy - При недостаточном количестве средств для списания. Действие системы при недостаточном балансе для проведения списания за перерасход ресурса
  • StatNotificationLimit - Порог отправки уведомлений о приближении к лимиту. % от максимально допустимого значения потребления ресурса, по достижению которого будет отправляться соответствующее уведомление
  • SupportToCc - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает отправку уведомлений на email адреса указанные в копии, для письма полученного от клиента
  • SupportUsePriority - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность клиенту указать приоритет запроса при создании, а также сотруднику управлять приоритетом
  • SupportFileSize - Максимальный размер файлов. Укажите максимально допустимый размер файлов, прикрепляемых клиентами к сообщениям в запросах
  • SupportMessageSize - Максимальный размер сообщения. Укажите максимально допустимый размер одного сообщения в запросе
  • SupportHightPrioritySchedule - Повышать приоритет запросов с оставшимся временем на ответ меньше. Опция позволяет регулировать приоритет запросов, время на ответ на которые осталось менее указанного значения
  • AbuseRateStat - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает суммирование баллов за нарушения и возможность применения штрафных санкций при достижении заданного порога баллов
  • AbuseBlockItemRate - Заблокировать услуги при достижении. Будут заблокированы имеющиеся услуги клиента, а так же запрещен заказ новых услуг
  • ArchiveTicket - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает автоматическое перемещение запросов в архив при отсутствии по ним активности
  • ArchiveTicketDays - При отсутствии активности в течении. Срок в днях. Если в течение этого периода не будет активности по запросу, он будет автоматически перемещен в архив
  • ValidateOrder - Порядок проверки. Порядок, в котором будет запрашиваться проверка данных, при совпадении момента проверки
  • FraudValidateType - Подтверждение номера телефона. Момент указания и подтверждения номера телефона, который будет отображен как проверенный и может быть использован для подтверждения при удалении услуг
  • fraud_phone_trycount - Количество попыток получения кода. Количество попыток получения кода подтверждения номера телефона при прохождении процедуры верификации
  • fraud_code_trycount - Количество попыток ввода кода. Количество попыток ввода кода, при достижении указанного лимита, требуется получение нового кода
  • EmailValidateType - Подтверждение по email. Момент подтверждения email адреса, указанного при регистрации
  • WaitTimeSend - Период отправки письма. Время в секундах до возможности повторной отправки письма для подтверждения email, по умолчанию 300 секунд
  • ManualValidateType - Ручное подтверждение. Ручное подтверждения учетной записи
  • ManualValidateDepartment - Отдел. Отдел, в который будут направлены задачи на ручное подтверждение учетной записи клиента
  • AllowRecoveryBySms - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает отправку кода подтверждения восстановления пароля на проверенный номер телефона. Если проверенного номера нет, клиент получит на свой email письмо с ссылкой для смены пароля
  • PhoneRestoreMaxSendTime - Количество отправок кода. Максимальное количество попыток получения кода сброса пароля по телефону
  • PhoneRestoreSendTimeOut - Таймаут на получение кода. Минимальное время в секундах, между попытками получения кода сброса пароля по телефону
  • AllowRecoveryByEmail - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает клиенту выбор способа получения кода для сброса пароля по СМС или на email
  • ProfilePhoneValidateType - Подтверждение номера телефона. Момент подтверждения номера телефона плательщика
  • ProfilePhoneTryCount - Количество попыток получения кода. Количество попыток получения кода подтверждения номера телефона при прохождении процедуры верификации
  • ProfilePhoneCodeTryCount - Количество попыток ввода кода. Количество попыток ввода кода, при достижении указанного лимита, требуется получение нового кода
  • ProfileEmailValidateType - Подтверждение email. Момент подтверждения email адреса плательщика
  • ProfileEmailWaitTimeSend - Период отправки письма. Время в секундах до возможности повторной отправки письма для подтверждения email, по умолчанию 300 секунд
  • ProfileManualValidateType - Ручное подтверждение. Ручная верификация данных плательщиков
  • ProfileManualValidateDepartment - Отдел. Отдел, в который будут направлены задачи на ручное подтверждение данных плательщика клиента
  • RequireEmailValidation - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Политика запрещает отправку уведомлений на непроверенные e-mail адреса пользователей. После регистрации в системе, пользователю будет предложено пройти процедуру верификации e-mail адреса. Отправить проверочный e-mail можно и непосредственно из настроек пользователя. Так же на непроверенные e-mail адреса не будут доставляться рассылки.
  • ParseMailSystemAutoreplay - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает обработку автоматических ответов почтовых систем о невозможности доставки email уведомления. Включение опции имеет смысл только при настройке шлюза входящих сообщений на адрес, с которого выполняется рассылка сообщений
  • BuymoreMaxCount - Количество предложений. Ограничить количество предложений сопутствующих товаров в корзине клиента
  • RegFormType - Форма регистрации. Тип формы регистрации
  • RegistrationPhone - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает возможность указания номера телефона при регистрации
  • RecaptchaType - Тип reCAPTCHA на форме регистрации. Опция включает использование reCAPTCHA на форме регистрации клиента. Не забудьте учесть эту настройки при наличии интеграции формы регистрации в сайт
  • RecaptchaPublicKey - Ключ. Публичный ключ сервиса reCAPTCHA
  • RecaptchaPrivateKey - Секретный ключ. Секретный ключ сервиса reCAPTCHA
  • RecaptchaAuthType - Тип reCAPTCHA на форме авторизации. Опция включает использование reCAPTCHA на форме авторизации клиента
  • RecaptchaAuthPublicKey - Ключ. Публичный ключ сервиса reCAPTCHA
  • RecaptchaAuthPrivateKey - Секретный ключ. Секретный ключ сервиса reCAPTCHA
  • ShowroomBehavior - Поведение. Действие при открытии страницы billmgr незарегистрированным пользователем
  • ShowroomLinkType - Тип ссылки. Тип ссылки, которая будет отображена на форме авторизации
  • OneDedicatedIp - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) После включения данной политики будет выделен только один адрес, если тариф включает в себя более одного выделенного IP-адреса, но при заказе услуги клиент не заказывал дополнительных IP-адресов. Остальные включенные в тариф IP-адреса клиент может добавить самостоятельно в разделе "IP-адреса".
  • CheckIpInUse - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Только для услуг с типом "Выделенный сервер": перед удалением IP-адреса проверять его доступность; если адрес активен, удаление не происходит

IPmanager

Функция: processing.ipmgr

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

Связь с IPmanager

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

  • id - Id
  • name - Наименование
  • status - Состояние

Удалить

Функция: processing.ipmgr.delete

Удалить

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

Параметры:

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

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

Перейти в панель

Функция: processing.ipmgr.gotoserver

Перейти в панель

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

Подключение к IPmanager

Функция: processing.ipmgr.edit

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

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

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

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

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

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

  • name - Наименование. Наименование подключения
  • url - URL. URL IPmanager
  • login - Имя пользователя. Имя пользователя
  • password - Пароль. Укажите пароль для доступа к панели управления
  • adminlogin - Логин администратора. Логин администратора в IPmanager'е
  • adminpassword - Пароль администратора. Пароль администратора в IPmanager'е
  • hiddentypes - Не учитывать типы IP-адресов. Укажите через пробел типы IP-адресов которые не нужно проверять на соответствие с базой данных биллинга

Виртуальный ДЦ

Функция: vdc

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

Виртуальный дата-центр

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

  • vdcname - Наименование
  • id - Id
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

Networks

Функция: vdc.network

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

Сети

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

  • id - Id
  • name - Наименование
  • vm_group -
  • router - Маршрутизатор
  • gateway - Шлюз
  • mask - Маска сети
  • network_subnets - Адреса подсетей
  • network_pools - Пул IP-адресов
  • status - Состояние

Наименование

Функция: vdc.network.subnet

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

Подсети

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

  • id - Id
  • name - Наименование
  • cidr - Адрес подсети
  • gateway - Адрес шлюза
  • status - Состояние
  • status - Состояние
Удалить

Функция: vdc.network.subnet.delete

Удалить

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

Параметры:

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

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

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

Функция: vdc.network.subnet.edit

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

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

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

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

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

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

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

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


  • name - Наименование. Наименование
  • subnet_type - Тип выбора сетевого адреса. Тип выбора сетевого адреса
  • pool - Пул. Выберите сетевой адрес из пула
  • mask - Маска подсети. Маска подсети
  • cidr - Адрес подсети. Адрес подсети
  • use_gateway - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать шлюз для данной подсети. Под шлюз будет занят один из адресов подсети
  • gateway - Адрес шлюза. Адрес шлюза используемый в подсети. Для назначения адреса автоматически, необходимо оставить пустым
  • use_dhcp - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать DHCP для данной подсети. Под DHCP будет занят один из адресов подсети

Удалить

Функция: vdc.network.delete

Удалить

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

Параметры:

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

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

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

Функция: vdc.network.edit

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

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

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

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

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

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

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


  • name - Наименование. Наименование
  • vdc_vm_group - Группа виртуальных серверов. Позволяет создать сеть доступную только внутри группы виртуальных серверов
  • create_subnet - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность создать подсеть вместе одновременно с сетью
  • subnet_name - Наименование подсети. Наименование подсети
  • subnet_type - Тип выбора сетевого адреса. Тип выбора сетевого адреса
  • subnet_pool - Пул. Выберите сетевой адрес из пула
  • subnet_mask - Маска подсети. Маска подсети
  • subnet_cidr - Адрес подсети. Адрес подсети в виде 'адрес_сети/маска_сети'. Например 192.168.0.0/24
  • subnet_use_gateway - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать шлюз для данной подсети. Под шлюз будет занят один из адресов подсети
  • subnet_gateway - Адрес шлюза. Адрес шлюза используемый в подсети. Для назначения адреса автоматически, необходимо оставить пустым
  • subnet_use_dhcp - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать DHCP для данной подсети. Под DHCP будет занят один из адресов подсети
  • gateway - Шлюз. Шлюз
  • mask - Маска сети. Маска сети
  • dns1 - Первичный DNS. Первичный DNS сервер, используемый в сети
  • dns2 - Вторичный DNS. Вторичный DNS сервер, используемый в сети
  • dns_suffix - DNS суффикс. DNS суффикс, используемый в сети
  • subnet_vdc_router - .
  • vdc_router - Подключить к марщрутизатору. При создании сеть будет подключена к выбранному маршрутизатору виртуального дата-центра
  • vdc_network - Подключить к сети ВДЦ. Сеть будет подключена к выбранной сети виртуального дата-центра
  • network_pools - .
  • network_dhcp - .

Выключить

Функция: vdc.network.suspend

Выключить

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

Параметры:

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

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

Включить

Функция: vdc.network.resume

Включить

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

Параметры:

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

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

Virtual machines

Функция: vdc.vm

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

Список виртуальных серверов

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

  • id - Id
  • name - Наименование
  • vm_group - Группа
  • vmtempl - Шаблон ВС
  • ostempl_name - Шаблон ОС
  • external_ip - Внешние IP
  • internal_ip - Внутренние IP
  • ncpu_m - Процессор, шт.
  • mem_m - Оперативная память, МиБ
  • disc_total_m - Диск, ГиБ
  • status - Состояние
  • status - Состояние

Доступ к консоли сервера

Функция: vdc.vm.webconsole

Доступ к консоли сервера

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

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

Функция: vdc.vm.edit

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

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

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

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

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

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

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


  • name - Наименование. Наименование виртуального сервера
  • vmtempl - Набор параметров. Набор параметров виртуального сервера
  • source - Базовый объект. Выберите базовый объект, на основе которого будет создан виртуальный сервер
  • ostempl - Операционная система. Шаблон операционной системы, из которого будет создан виртуальный сервер
  • vdc_volume - Диск. Можно выбрать только загрузочный диск не используемый ни одним из виртуальных серверов
  • vdc_volume_snapshot - Снимок диска. На основе снимка будет создан новый диск, который будет подключен к виртуальному серверу
  • vdc_vm_snapshot - Снимок виртуального сервера. На основе снимка будет создан новый виртуальный сервер
  • vdc_vm_group - Группа для размещения. Группа для размещения виртуального сервера
  • vm_group_name - Имя группы. Имя группы виртуальных серверов
  • vdc_network - Сеть. Сеть виртуального дата-центра, к которой будет подключен создаваемый виртуальный сервер
  • create_volume - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для виртуального сервера будет создан диск указанного размера
  • disc - Диск. Объем жесткого диска виртуального сервера
  • ncpu - Процессоры. Количество процессоров виртуального сервера
  • mem - Оперативная память. Объем оперативной памяти выделяемой виртуальному серверу
  • password - Пароль. Пароль доступа к виртуальному серверу
  • confirm - Подтверждение.

Имя диска

Функция: vdc.vm.volume

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

Список дисков, подключенных к виртуальному серверу

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

  • id - Id
  • name - Имя диска
  • size - Размер диска, ГиБ
Присоединение диска к виртуальному серверу

Функция: vdc.vm.volume.edit

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

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

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

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

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

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

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

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


  • volumelist - Имя диска. Имя диска, присоединяемого к виртуальномуу серверу
Отключить диск от виртуального сервера

Функция: vdc.vm.volume.delete

Отключить диск от виртуального сервера

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

Параметры:

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

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

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

vdc.vm.filter

Перезагрузить виртуальный сервер

Функция: vdc.vm.reboot

Перезагрузить виртуальный сервер

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

Параметры:

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

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

Остановить виртуальный сервер

Функция: vdc.vm.suspend

Остановить виртуальный сервер

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

Параметры:

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

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

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

Функция: vdc.vm.hardreboot

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

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

Параметры:

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

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

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

Функция: vdc.vm.delete

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

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

Параметры:

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

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

Наименование

Функция: vdc.vm.network

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

Подключения к сетям виртуального дата-центра

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

  • id - Id
  • network_name - Имя сети
  • ip_address - IP-адрес
  • network_subnet - Подсеть
  • mac - MAC-адрес
Отключить виртуальный сервер от сети

Функция: vdc.vm.network.delete

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

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

Параметры:

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

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

Добавление нового подключения

Функция: vdc.vm.network.edit

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

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

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

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

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

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

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

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


  • network - Сеть. Сеть виртуального дата-центра, к которой необходимо подключить виртуальный сервер

Наименование

Функция: vdc.vm.ip

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

Внешние IP-адреса, подключенные к виртуальному серверу

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

  • id - Id
  • ip - IP-адрес
  • status - Состояние
Присоединение IP к виртуальному серверу

Функция: vdc.vm.ip.edit

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

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

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

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

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

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

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

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


  • iplist - IP-адрес. IP-адрес, присоединяемый к виртуальному серверу
  • port - Порт подключения. Порт виртуального сервера, к которому будет подключен внешний IP-адрес
Открепить IP от виртуального сервера

Функция: vdc.vm.ip.delete

Открепить IP от виртуального сервера

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

Параметры:

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

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

Запустить виртуальный сервер

Функция: vdc.vm.resume

Запустить виртуальный сервер

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

Параметры:

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

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

Имя диска

Функция: vdc.volume

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

Дисковые хранилища

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

  • id - Id
  • name - Имя диска
  • size - Размер диска, ГиБ
  • externalid - ID диска
  • vdc_vm_name - Виртуальный сервер
  • type - Тип диска
  • bootable - Загрузочный диск
  • ss - Снимки
  • status - Состояние

Имя

Функция: vdc.volume.snapshot

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

Снимки диска

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

  • id - Id
  • name - Имя
  • externalid - ID снимка
  • vdc_volume - Диск
  • status - Состояние
Удалить

Функция: vdc.volume.snapshot.delete

Удалить

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

Параметры:

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

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

Снимок

Функция: vdc.volume.snapshot.edit

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

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

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

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

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

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

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

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


  • name - Имя. Наименование

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

Функция: vdc.volume.edit

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

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

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

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

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

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

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


  • name - Имя диска. Имя диска
  • type - Тип. Тип диска
  • source_type - Источник. Источник создания диска
  • ostempl - Образ. Образ, из которого будет создан диск
  • snapshot - Снимок. Снимок из которого будет создан диск
  • size - Размер диска. Размер диска в гигабайтах
  • bootable - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Загрузочный диск

Удалить

Функция: vdc.volume.delete

Удалить

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

Параметры:

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

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

Выключить

Функция: vdc.suspend

Выключить

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

Параметры:

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

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

Включить

Функция: vdc.resume

Включить

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

Параметры:

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

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

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

vdc.filter

Виртуальный дата-центр

Функция: vdc.edit

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

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

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

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

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

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

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

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

Функция: vdc.delete

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

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

Параметры:

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

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

Заказ виртуального дата-центра

Функция: vdc.order.pricelist

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

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

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

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

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

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

  • datacenter - Выберите дата-центр. Дата-центр, в котором будет открыта услуга

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

Функция: vdc.setfilter

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

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

Наименование

Функция: vdc.loadbalancer

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

Список балансировщиков

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

  • id - Id
  • name - Наименование
  • externalid - ID балансировщика
  • vm - Виртуальный сервер
  • protocol - Протокол
  • port - Порт
  • method - Метод
  • monitortype - Протокол мониторинга
  • delay - Интервал, сек
  • retries - Количество попыток
  • timeout - Таймаут, сек
  • status - Состояние

Редактировать балансировщик

Функция: vdc.loadbalancer.edit

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

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

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

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

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

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

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


  • name - Наименование. Наименование
  • subnet - Подсети. Выберите подсеть
  • protocol - Протокол. Выберите протокол
  • port - Порт. Выберите порт. Значение должно быть от 1 до 65535
  • method - Метод. Метод распределения трафика между участника пула
  • vm - Виртуальный сервер. Виртуальные серверы, входящие в пул
  • monitortype - Протокол мониторинга. Тип протокола мониторинга
  • delay - Интервал, сек. Интервал опроса, в секундах
  • retries - Количество попыток. Количество успешных проверок перед изменением состояния участника пула. Значение от 1 до 10
  • timeout - Таймаут, сек. Максимальное время ожидания подключения, в секундах

Наименование

Функция: vdc.loadbalancer.vm

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

Виртуальные серверы, подключенные к балансировщику

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

  • id - Id
  • vm -
  • subnet - Подсеть
Присоединение виртуального сервера к балансировщику

Функция: vdc.loadbalancer.vm.edit

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

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

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

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

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

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

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

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


  • vm - Виртуальный сервер. Виртуальный сервер, присоединяемый к балансировщику
Удалить

Функция: vdc.loadbalancer.vm.delete

Удалить

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

Параметры:

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

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

Наименование

Функция: vdc.loadbalancer.ip

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

IP-адреса, подключенные к балансировщику

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

  • id - Id
  • ip - IP-адрес
  • status - Состояние
Присоединение IP к балансировщику

Функция: vdc.loadbalancer.ip.edit

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

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

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

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

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

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

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

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


  • iplist - IP адрес. IP-адрес, присоединяемый к балансировщику
Открепить IP от балансировщика

Функция: vdc.loadbalancer.ip.delete

Открепить IP от балансировщика

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

Параметры:

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

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

Удалить балансировщик

Функция: vdc.loadbalancer.delete

Удалить балансировщик

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

Параметры:

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

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

Routers

Функция: vdc.router

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

Список маршутизаторов виртуального дата-центра

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

  • id - Id
  • externalid - Идентификатор маршрутизатора
  • name - Наименование маршрутизатора
  • routertempl_name - Конфигурация
  • network - Внешняя сеть
  • external_ip - IP-адреса
  • status - Состояние
  • status - Состояние

Выключить

Функция: vdc.router.suspend

Выключить

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

Параметры:

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

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

Наименование

Функция: vdc.router.lbp

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

Список пулов

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

  • id - Id
  • name - Наименование
  • description - Описание
  • members - Участников пула, шт.
  • service - Службы
  • port - Порты
  • monitor_port - Порт мониторинга
  • method - Метод
  • interval - Интервал
  • timeout - Таймаут
  • status - Состояние
Удаление пула

Функция: vdc.router.lbp.delete

Удаление пула

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

Параметры:

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

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

Параметры пула

Функция: vdc.router.lbp.edit

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

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

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

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

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

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

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

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


  • name - Наименование. Наименование пула балансировщика нагрузки. Может содержать только быквы латинского алфавита, цифры, тире, нижнее подчеркивание и должно начинаться с буквы
  • description - Описание. Произвольное описание пула
  • uri - URI проверки доступности. URI для проверки доступности службы HTTP

Наименование тоннеля

Функция: vdc.router.vpn

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

Управление IPSec VPN тоннелями маршрутизатора

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

  • id - Id
  • name - Наименование тоннеля
  • connection_type - Тип подключения
  • local_ip_address - Локальный IP-адрес
  • peer_ip_address - Внешний IP-адрес
  • network_local - Локальные сети
  • network_peer - Внешние сети
  • encryption_protocol - Протокол шифрования
  • status - Состояние
  • status - Состояние
Параметры IPSec VPN тоннеля маршрутизатора

Функция: vdc.router.vpn.edit

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

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

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

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

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

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

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

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


  • name - Наименование. Наименование
  • description - Описание.
  • connection_type - Тип подключения. Тип подключения IPSec VPN туннеля
  • vdc_router_peer - Маршрутизатор. Маршрутизатор виртуального дата-центра, для которого настраивается IPSec VPN туннель
  • vdc_network_local - Локальные сети. Локальные сети, подключенные к маршрутизатору
  • vdc_network_peer - Внешние сети. Внешние сети, подключенные к маршрутизатору виртуального дата-центра
  • peer_cidr - Внешние сети. Внешние сети, для которой настраивается IPSec VPN туннель в формате адрес_сети/маска, через пробел. Например 192.168.0.0/24 192.168.1.0/24
  • local_endpoint - Локальная точка подключения. Интерфейс маршрутизатора, который будет использован для создания VPN соединения. Если необходимо использовать публичный IP адрес соединения, необходимо отметить опцию "Публичный IP-адрес"
  • local_endpoint_use_public_ip - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • peer_endpoint - Внешняя точка подключения. Интерфейс маршрутизатора, который будет использован для создания VPN соединения. Если необходимо использовать публичный IP адрес соединения, необходимо отметить опцию "Публичный IP-адрес"
  • peer_endpoint_use_public_ip - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • local_id - Локальный ID. Локальный ID IPSec VPN туннеля
  • peer_id - Внешний ID. Внешний ID IPSec VPN туннеля
  • peer_ip_address - Внешний IP-адрес. Адрес внешней точки подключения
  • encryption_protocol - Протокол шифрования. Протокол шифрования соединения
  • shared_key - Ключ шифрования. Ключ шифрования. Допустимо использование латинских символов и цифр. Длина ключа должна быть не короче 32 и не длинее 128 символов
  • mtu - MTU. Максимальный размер пакета для передачи по IPSec VPN туннелю
Удалить

Функция: vdc.router.vpn.delete

Удалить

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

Параметры:

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

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

Выключить

Функция: vdc.router.vpn.suspend

Выключить

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

Параметры:

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

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

Включить

Функция: vdc.router.vpn.resume

Включить

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

Параметры:

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

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

Наименование

Функция: vdc.router.lbs

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

Список серверов

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

  • id - Id
  • name - Наименование
  • description - Описание
  • ip - IP-адрес
  • vdc_loadbalancer_pool_name - Пул
  • service_name - Имя службы
  • service_port - Порт службы
  • service_persistence - Метод
  • status - Состояние
  • status - Состояние
Выключить

Функция: vdc.router.lbs.suspend

Выключить

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

Параметры:

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

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

Удаление сервера

Функция: vdc.router.lbs.delete

Удаление сервера

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

Параметры:

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

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

Параметры сервера

Функция: vdc.router.lbs.edit

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

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

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

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

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

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

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

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


  • name - Наименование. Наименование сервера балансировщика нагрузки. Может содержать только быквы латинского алфавита, цифры, тире, нижнее подчеркивание и должно начинаться с буквы
  • description - Описание. Произвольное описание сервера
  • vdc_network - Сеть. Сеть маршрутизатора, для которой будет активен балансировщик нагрузки
  • ip - IP-адрес. IP-адрес сервера балансировщика нагрузки
  • pool - Пул. Пул настроек балансировщика нагрузки
  • use_log - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает журналирование трафика, проходящего через сервер балансировщика нагрузки
Включить

Функция: vdc.router.lbs.resume

Включить

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

Параметры:

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

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

Наименование правила

Функция: vdc.router.firewall

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

Управление Firewall маршрутизатора

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

  • id - Id
  • name - Наименование правила
  • source_desc - Источник
  • destination_desc - Адрес назначения
  • protocol - Протокол
  • policy - Политика
  • status - Состояние
  • status - Состояние
Удалить

Функция: vdc.router.firewall.delete

Удалить

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

Параметры:

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

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

Выключить

Функция: vdc.router.firewall.suspend

Выключить

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

Параметры:

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

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

Редактирование правила Firewall

Функция: vdc.router.firewall.edit

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

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

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

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

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

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

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

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


  • name - Наименование правила. Наименование правила
  • protocol - Протокол. Протокол, к которому применяется правило
  • source - Источник. Источник трафика. Допустимым значением может быть IP-адрес, CIDR, диапазон IP-адресов, "any","internal" и "external". Значение можно выбрать из списка или указать самостоятельно
  • source_port - Порт источника. Порт источника. Значение можно выбрать из списка или указать самостоятельно
  • destination - Адрес назначения. Адрес назначения трафика. Допустимым значением может быть IP-адрес, CIDR, диапазон IP-адресов, "any","internal" и "external". Значение можно выбрать из списка или указать самостоятельно
  • destination_port - Порт адреса назначения. Порт адреса назначения. Значение можно выбрать из списка или указать самостоятельно
  • policy - Политика. Политика, применяемая к трафику
  • use_log - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает ведение журнала трафика, попадаемого под правило
Включить

Функция: vdc.router.firewall.resume

Включить

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

Параметры:

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

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

Наименование

Функция: vdc.router.interface

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

Интерфейсы маршрутизатора

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

  • id - Id
  • externalid - Идентификатор интерфейса маршрутизатора
  • network - Сеть
  • subnet - Подсеть
  • fixedips - IP-адрес
  • type - Тип интерфейса
  • status - Состояние
Восстановление

Функция: vdc.router.interface.edit

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

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

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

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

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

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

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

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


  • subnet - Подсеть. Подсеть, к которой будет привязан маршрутизатор

Функция: vdc.router.interface.param


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

Удалить выделенные интерфейсы

Функция: vdc.router.interface.delete

Удалить выделенные интерфейсы

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

Параметры:

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

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

Включить

Функция: vdc.router.resume

Включить

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

Параметры:

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

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

Наименование

Функция: vdc.router.dhcp

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

Управление DHCP маршрутизатора

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

  • id - Id
  • network - Сеть дата-центра
  • ip_range - Диапазон адресов
  • default_lease_time - Время аренды по умолчанию
  • max_lease_time - Максимальное время аренды
  • status - Состояние
Выключить

Функция: vdc.router.dhcp.suspend

Выключить

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

Параметры:

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

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

Включить

Функция: vdc.router.dhcp.resume

Включить

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

Параметры:

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

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

Удалить

Функция: vdc.router.dhcp.delete

Удалить

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

Параметры:

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

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

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

Функция: vdc.router.dhcp.edit

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

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

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

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

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

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

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

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


  • vdc_network - Сеть дата-центра. Сеть дата-центра, для которой активируется DHCP диапазон
  • ip_range - Диапазон адресов. Диапазон адресов, из которого будут выдаваться IP адреса
  • default_lease_time - Время аренды по умолчанию. Время аренды IP-адреса по умолчанию
  • max_lease_time - Максимальное время аренды. Максимальное время аренды IP-адреса

Редактирование маршрутизатора

Функция: vdc.router.edit

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

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

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

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

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

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

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


  • name - Наименование маршрутизатора. Наименование
  • routertempl - Конфигурация. Конфигурация маршрутизатора
  • external_network - Внешняя сеть. Внешняя сеть, к которой будет подключен создаваемый маршрутизатор
  • use_dhcp - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить DHCP для маршрутизатора
  • use_firewall - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить Firewall для маршрутизатора
  • firewall_policy - Политика по умолчанию. Политика обработки пакетов по умолчанию
  • use_vpn - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить использование VPN для маршрутизатора

Удалить выделенные маршрутизаторы

Функция: vdc.router.delete

Удалить выделенные маршрутизаторы

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

Параметры:

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

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

Наименование

Функция: vdc.router.nat

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

Управление NAT маршрутизатора

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

  • id - Id
  • network - Сеть дата-центра
  • rule_type - Тип правила
  • original_ip_range - Исходный адрес/диапазон
  • original_port_desc - Исходный порт
  • translated_ip_range - Транслируемый адрес/диапазон
  • translated_port_desc - Транслируемый порт
  • protocol - Протокол
  • status - Состояние
Выключить

Функция: vdc.router.nat.suspend

Выключить

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

Параметры:

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

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

Удалить

Функция: vdc.router.nat.delete

Удалить

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

Параметры:

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

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

Редактирование правила NAT

Функция: vdc.router.nat.edit

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

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

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

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

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

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

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

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


  • vdc_network - Сеть дата-центра. Сеть дата-центра, для которой применяется правило NAT
  • rule_type - Тип правила. Тип правила трансляции адресов. SNAT - трансляция исходящих из внутренней сети запросов, DNAT - трансляция входящих во внутреннюю сеть запросов
  • description - Описание. Произвольное описание правила
  • protocol - Протокол. Протокол, для которого будет применяться правило NAT
  • original_ip_range - Исходный адрес/диапазон. Для SNAT правила это внутренний IP-адрес или диапазон IP-адресов, для правила DNAT - внешний IP-адрес или диапазон IP-адресов. Значение можно выбрать из списка или указать самостоятельно
  • original_port - Исходный порт. Исходный порт, для которого выполняется трансляция. Значение можно выбрать из списка или указать самостоятельно
  • translated_ip_range - Транслируемый адрес/диапазон. Для SNAT правила это внешний IP-адрес или диапазон IP-адресов, для правила DNAT - внутренний IP-адрес или диапазон IP-адресов. Значение можно выбрать из списка или указать самостоятельно
  • translated_port - Транслируемый порт. Транслируемый порт, по которому идет обращение. Значение можно выбрать из списка или указать самостоятельно
Включить

Функция: vdc.router.nat.resume

Включить

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

Параметры:

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

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

Синхронизирация объектов услуги с объектами на стороне ВДЦ

Функция: vdc.sync

Синхронизирация объектов услуги с объектами на стороне ВДЦ

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

Параметры:

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

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

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

Функция: vdc.su

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

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

Реферальные программы

Функция: affiliate

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

Реферальные программы

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

  • id - Id
  • locale_name - Наименование
  • reward - Вознаграждение, %
  • period - Период вознаграждения, месяц
  • locale_url - URL сайта
  • project_name - Провайдер

Удалить

Функция: affiliate.delete

Удалить

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

Параметры:

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

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

Редактирование реферальной программы

Функция: affiliate.edit

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

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

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

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

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

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

  • project - Провайдер. Выберите провайдера, у которого действует данная реферальная программа
  • name - Наименование. Наименование реферальной программы, которое отображается клиенту
  • promocode - Шаблон промокода. Укажите шаблон промокода, используйте @ID@ в том месте, куда нужно вставить Id партнера. Если реферал введет промокод соответсвующий этому шаблону, то будет засчитано, что клиента завербовал партнер.
  • reward - Размер вознаграждения. Проценты от расходов реферала, которые будут начислены партнеру в начале следующего месяца.
  • period - Период вознаграждения. Период в месяцах, в течении которого клиенту будут выплачивать проценты от расходов реферала
  • url - URL сайта. Укажите URL сайта провайдера. У каждого партнера будет уникальная ссылка, для этого в конец данного URL будет добавлен Id клиента.
  • account_group - Группа клиентов. Группа клиентов, для которых будет доступно участие в реферальной программе
  • account_group_restrict - Запретить состоящим в группе. Выберите группу, клиентам состоящим в этой группе не будет начисляться вознаграждение по реферальной программе

Наименование

Функция: affiliate.reward

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

Затраты на реферальную программу

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

  • cdate - Дата
  • amount - Сумма

Клиент

Функция: affiliate.reward.partner

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

Затраты на реферальную программу

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

  • id - Id
  • name - Клиент
  • amount - Сумма
Войти в панель с правами пользователя

Функция: affiliate.reward.partner.su

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

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

Наименование

Функция: affiliate.itemtype

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

Особые правила начисления вознаграждения

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

  • id - Id
  • locale_name - Тип продукта
  • pricelist_locale_name - Тариф
  • reward - Вознаграждение, %

Редактирование правила

Функция: affiliate.itemtype.edit

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

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

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

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

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

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

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

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


  • reward - Размер вознаграждения. Проценты от расходов реферала за услуги выбранного типа

Удалить

Функция: affiliate.itemtype.delete

Удалить

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

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции affiliate.itemtype.

Результат: успешное выполнение операции или сообщение об ошибке

Лицензии ISPsystem

Функция: soft

Результат: список элементов

Лицензии ISPsystem

Уровень доступа: admin user

  • id - Номер
  • licname - Название лицензии
  • ip - IP-адрес
  • period - Период
  • update_expiredate - Получение обновлений до
  • real_ipchange - Дата IP-адреса
  • real_keychange - Дата ключа
  • id - Номер
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

Лицензия

Функция: soft.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • remoteip - IP-адрес сервера. В поле указывается IP-адрес, с которого будут приходить запросы на получение лицензии. В случае, если это значение совпадает с IP адресом, на который будет выдана лицензия, данное поле можно оставить пустым
  • update_expiredate - Срок получения обновлений. Панель сможет получать обновления до указанной даты
  • processingmodule - Модуль обработки. Модуль обработки
  • autoprolong - Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate - Дата заказа. Дата заказа услуги
  • opendate - Дата создания. Дата фактического начала действия услуги
  • expiredate - Действует до. Срок действия услуги
  • scheduledclose - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note - Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Заказать новую услугу

Функция: soft.order

Заказать новую услугу

Уровень доступа: user

Включить

Функция: soft.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции soft.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить выделенные услуги

Функция: soft.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции soft.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: soft.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции soft.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: soft.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Войти в панель с правами пользователя

Функция: soft.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установка фильтра.

soft.filter

Открытие услуги

Функция: soft.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки, назначенный услуге

CRM контакты

Функция: crm

Результат: список элементов

CRM-контакты

Уровень доступа: admin

  • id - Id
  • cdate - Дата
  • description - Описание
  • employee - Сотрудник
  • account - Клиент
  • type - Тип
  • channel - Канал
  • project - Провайдер
  • info - Комментарий
  • status - Статус

Копирование CRM-контакта

Функция: crm.clone

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • description - Описание контакта. Дополнительное описание контакта
  • employee - Сотрудник. Сотрудник создавший контакт
  • account - Клиент. Клиент связанный с контактом
  • project - Провайдер. Провайдер, к которому относится данный CRM-контакт
  • type - Тип контакта. Тип контакта
  • channel - Канал. Канал, по которому привлечен контакт
  • contactperson - Контактное лицо. Контактное лицо
  • email - Email. Email адрес контакта
  • phone - Номер телефона. Номер телефона контакта
  • attitude - Статус клиента. Характеристика клиента
  • info - Комментарий.

Установить фильтр по клиенту (включая данный список)

Функция: crm.setfilterall

Установить фильтр по клиенту (включая данный список)

Уровень доступа: admin

Установка фильтра.

crm.filter

Открыть привязанный к контакту запрос

Функция: crm.ticket

Открыть привязанный к контакту запрос

Уровень доступа: admin

Удалить

Функция: crm.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции crm.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: crm.remind

Результат: список элементов

Список напоминаний CRM-контакта

Уровень доступа: admin

  • id - Id
  • remind_date - Дата
  • comment - Комментарий
  • status - Состояние

Изменить статус напоминания на "Выполнено"

Функция: crm.remind.resume

Изменить статус напоминания на "Выполнено"

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции crm.remind.

Результат: успешное выполнение операции или сообщение об ошибке

Изменить статус напоминания на "Не выполнено"

Функция: crm.remind.suspend

Изменить статус напоминания на "Не выполнено"

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции crm.remind.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить напоминание из списка

Функция: crm.remind.delete

Удалить напоминание из списка

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции crm.remind.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование напоминания

Функция: crm.remind.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции crm).
    • elid - уникальный идентификатор (элемент id из функции crm.remind)
  • Результат: список параметров объекта

Создание объекта:

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции crm).
    • elid - уникальный идентификатор (элемент id из функции crm.remind)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • remind_date - Дата. Дата напоминания
  • comment - Комментарий. Произвольный текстовый комментарий

Закрыть CRM-контакт

Функция: crm.suspend

Закрыть CRM-контакт

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции crm.

Результат: успешное выполнение операции или сообщение об ошибке

CRM-контакт

Функция: crm.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • description - Описание контакта. Дополнительное описание контакта
  • employee - Сотрудник. Сотрудник создавший контакт
  • account - Клиент. Клиент связанный с контактом
  • project - Провайдер. Провайдер, к которому относится данный CRM-контакт
  • type - Тип контакта. Тип контакта
  • channel - Канал. Канал, по которому привлечен контакт
  • contactperson - Контактное лицо. Контактное лицо
  • email - Email. Email адрес контакта
  • phone - Номер телефона. Номер телефона контакта
  • attitude - Статус клиента. Характеристика клиента
  • info - Комментарий.

Услуга

Функция: crm.item

Результат: список элементов

Список услуг CRM-контакта

Уровень доступа: admin

  • id - Id
  • name - Услуга
  • opendate - Дата активации
  • status - Статус услуги
  • project - Провайдер
  • itemtype - Тип продукта
  • pricelist - Тариф
  • contact - CRM-контакты
  • relationstatus - Статус

Выключить

Функция: crm.item.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции crm.item.

Результат: успешное выполнение операции или сообщение об ошибке

Изменить

Функция: crm.item.edit

Изменить

Уровень доступа: admin

Включить

Функция: crm.item.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции crm.item.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

crm.item.filter

Открыть CRM-контакт

Функция: crm.resume

Открыть CRM-контакт

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции crm.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: crm.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Редактирование информации о пользователе

Функция: user.edit

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • email - Email. Укажите Email адрес пользователя, который будет использоваться в качестве имени пользователя, в дальнейшем изменение невозможно
  • verify_email - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) До проверки email адреса, пользователь не будет получать уведомления о новостях компании и событиях в личном кабинете
  • name - Логин. Логин для входа
  • realname - ФИО. Фамилия, Имя, Отчество
  • phone - Номер телефона. Номер телефона пользователя для получения СМС уведомлений
  • passwd - Пароль. Пароль доступа
  • confirm - Подтверждение.
  • default_access_allow - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить пользователю полный доступ, никак не ограничивая его в правах.

Домены

Функция: domain

Результат: список элементов

Домены

Уровень доступа: admin user

  • id - Id
  • domain - Имя домена
  • account - Клиент
  • pricelist - Тариф
  • project - Провайдер
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • status_msg -
  • item_status -
  • cost - Стоимость

Информация о домене

Функция: domain.whois

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • whois_data - Информация о домене. WHOIS информация о домене

Зарегистрировать новый домен/домены

Функция: domain.order.register

Зарегистрировать новый домен/домены

Уровень доступа: user

Включить

Функция: domain.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: domain.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки, назначенный услуге

Серверы имен

Функция: domain.ns

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • ns0 - NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
  • ns1 - NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
  • ns2 - NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
  • ns3 - NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
  • ns_additional - Дополнительные NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2". Каждый дополнительный сервер имен указывается с новой строки
  • provider - .

Установить фильтр по клиенту

Функция: domain.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Имя файла

Функция: domain.doc

Результат: список элементов

Документы

Уровень доступа: admin user

  • id - Id
  • profile - Контакт домена
  • doctype - Тип документа
  • name - Имя файла
  • size - Размер
  • props - Свойства

Тип документа

Функция: domain.doc.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid - уникальный идентификатор (элемент id из функции domain.doc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции domain).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid - уникальный идентификатор (элемент id из функции domain.doc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • doctype - Тип документа. Тип загружаемого документа

Добавить документ

Функция: domain.doc.upload

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid - уникальный идентификатор (элемент id из функции domain.doc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции domain).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid - уникальный идентификатор (элемент id из функции domain.doc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • doctype - Тип документа. Тип загружаемого документа

Удалить документ

Функция: domain.doc.delete

Удалить документ

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Просмотреть выбранный файл

Функция: domain.doc.file

Просмотреть выбранный файл

Уровень доступа: admin user

Отправить файлы для подтверждения данных контакта домена

Функция: domain.doc.verify

Отправить файлы для подтверждения данных контакта домена

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Выставить документу статус верификации

Функция: domain.doc.verified

Выставить документу статус верификации

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Скачать документ

Функция: domain.doc.download

Скачать документ

Уровень доступа: admin user

Войти в панель с правами пользователя

Функция: domain.su

Войти в панель с правами пользователя

Уровень доступа: admin

Перенести домен/домены от другого регистратора

Функция: domain.order.transfer

Перенести домен/домены от другого регистратора

Уровень доступа: user

Редактирование услуги

Функция: domain.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки
  • autoprolong - Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate - Дата заказа. Дата заказа услуги
  • opendate - Дата создания. Дата фактического начала действия услуги
  • expiredate - Действует до. Срок действия услуги
  • scheduledclose - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note - Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: domain.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Запросить данные и состояние домена у регистратора

Функция: domain.sync

Запросить данные и состояние домена у регистратора

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

domain.filter

Локализации

Функция: locale

Результат: список элементов

Локализации

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • langcode - Код
  • status - Состояние

Удалить

Функция: locale.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции locale.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: locale.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции locale.

Результат: успешное выполнение операции или сообщение об ошибке

Выставить локаль по умолчанию

Функция: locale.setdefault

Выставить локаль по умолчанию

Уровень доступа: admin

Редактирование локализации

Функция: locale.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Наименование. Наименование локализации (примеры: Русский, Французский)
  • langcode - Код языка. Код языка, который будет использоваться для идентификации локализованных сообщений

Выключить

Функция: locale.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции locale.

Результат: успешное выполнение операции или сообщение об ошибке

Забота о сервере

Функция: servicemonitor

Результат: список элементов

Забота о сервере

Уровень доступа: admin user

  • url - URL
  • monserver - Сервер
  • id - Id
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

Открытие услуги

Функция: servicemonitor.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки, назначенный услуге

Редактирование услуги

Функция: servicemonitor.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки
  • autoprolong - Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate - Дата заказа. Дата заказа услуги
  • opendate - Дата создания. Дата фактического начала действия услуги
  • expiredate - Действует до. Срок действия услуги
  • scheduledclose - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note - Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Установка фильтра.

servicemonitor.filter

Войти в панель с правами пользователя

Функция: servicemonitor.su

Войти в панель с правами пользователя

Уровень доступа: admin

Удалить выделенные услуги

Функция: servicemonitor.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции servicemonitor.

Результат: успешное выполнение операции или сообщение об ошибке

Заказать новую услугу

Функция: servicemonitor.order

Заказать новую услугу

Уровень доступа: user

Включить

Функция: servicemonitor.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции servicemonitor.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: servicemonitor.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции servicemonitor.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: servicemonitor.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Шаблоны сообщений

Функция: notifytype

Результат: список элементов

Типы шаблонов сообщений

Уровень доступа: admin

  • type - Тип

Наименование

Функция: notifytype.template

Результат: список элементов

Шаблоны сообщений

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • notice - Вид сообщения
  • project - Провайдер
  • intname - Внутреннее наименование
  • changetemplate - Дата изменения
  • status - Состояние

Включить

Функция: notifytypecontent.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции notifytype.template.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: notifytype.template.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции notifytype.template.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование шаблона сообщения

Функция: notifytype.template.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции notifytype).
    • elid - уникальный идентификатор (элемент id из функции notifytype.template)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции notifytype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции notifytype).
    • elid - уникальный идентификатор (элемент id из функции notifytype.template)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Наименование. Наименование
  • project - Провайдер. Выберите провайдера, которым будет использоваться данный шаблон
  • notice - Тип уведомления. Тип уведомления определяет, при каком событии будет отправлено сообщение
  • subject - Заголовок сообщения. С указанным заголовком будет отправлено уведомление пользователю
  • allowcopy - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При отправке письмо будет скопировано в меню "Уведомления"
  • allowunverifiedemail - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает отправку уведомлений по данному шаблону на непроверенные адреса электронной почты
  • blindcopy - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Скрытая копия
  • blindcarboncopy - Email. Укажите email для отправки "скрытой" копии письма
  • content - Шаблон сообщения. Шаблон сообщения в формате xslt или ejs

Наименование

Функция: notifytypecontent.history

Результат: список элементов

История изменения шаблона

Уровень доступа: admin

  • changedate - Дата изменения
  • desc - Описание
  • user - Пользователь
  • ip - IP-адрес
  • action - Функция
Вернуться к предыдущему списку

Функция: notify.template

Вернуться к предыдущему списку

Уровень доступа: admin

Выключить

Функция: notifytypecontent.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции notifytype.template.

Результат: успешное выполнение операции или сообщение об ошибке

Вернуть шаблон к исходному тексту

Функция: notifytype.template.restoredefault

Вернуть шаблон к исходному тексту

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции notifytype.template.

Результат: успешное выполнение операции или сообщение об ошибке

Испытать шаблон

Функция: notifytype.template.try

Испытать шаблон

Уровень доступа: admin

Акты вып. работ

Функция: invoice

Результат: список элементов

Акты выполненных работ

Уровень доступа: admin user

  • id - Id
  • number - Номер
  • cdate - Дата
  • company - Компания
  • customer - Плательщик
  • amount_iso - Сумма
  • invoice_status - Статус
  • warning_message - Сообщение об ошибке
  • sdate - Дата отправки

Генерация актов

Функция: invoice.generate

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • invoice_status - Статус. Статус создаваемых актов
  • company - Компания. Выберите компанию, для которой создается акт выполненных работ
  • gentype - Плательщики. Выберите, для кого будет сгененерированы акты
  • profiletype - Тип плательщика. Выберите типы плательщиков для которых необходимо сгенерировать акты
  • customer - Плательщик. Плательщик, которому будет выставлен акт
  • cdate - Дата акта. Укажите дату выставления акта
  • fromdate - Расходы с даты. Укажите дату начала периода по которому выписываются акты
  • todate - Расходы по дату. Укажите дату завершения периода, по которому выписываются акты

Выставить статус "Подписан" для акта выполненных работ

Функция: invoice.status.4

Выставить статус "Подписан" для акта выполненных работ

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции invoice.

Результат: успешное выполнение операции или сообщение об ошибке

Скачать документ в формате PDF

Функция: invoice.print.pdf

Скачать документ в формате PDF

Уровень доступа: admin user

Написать запрос клиенту

Функция: ticket.write.invoice

Написать запрос клиенту

Уровень доступа: admin

Редактирование акта выполненных работ

Функция: invoice.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • number - Номер. Номер акта выполненных работ
  • cdate - Дата. Дата выставления акта выполненных работ
  • invoice_status - Статус. Статус акта выставляется вручную, если не подключен электронный документооборот

Запрос оригинала акта

Функция: invoice.request

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

Наименование

Функция: invoice.history

Результат: список элементов

История изменения акта

Уровень доступа: admin user

  • changedate - Дата изменения
  • desc - Описание
  • user - Пользователь
  • ip - IP-адрес
  • action - Функция

Печать акта выполненных работ

Функция: invoice.print

Печать акта выполненных работ

Уровень доступа: admin user

Описание

Функция: invoice.item

Результат: список элементов

Выполненные работы по акту

Уровень доступа: admin user

  • id - Id
  • name - Описание
  • amount - Сумма
  • payments - Номера платежей

Пункт акта

Функция: invoice.item.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции invoice).
    • elid - уникальный идентификатор (элемент id из функции invoice.item)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции invoice).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции invoice).
    • elid - уникальный идентификатор (элемент id из функции invoice.item)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Описание. Описание услуги/работ

Установка фильтра.

invoice.item.filter

Войти в панель с правами пользователя

Функция: invoice.su

Войти в панель с правами пользователя

Уровень доступа: admin

Распечатать конверт для отправки акта почтой

Функция: invoice.envelope

Распечатать конверт для отправки акта почтой

Уровень доступа: admin

Удалить

Функция: invoice.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции invoice.

Результат: успешное выполнение операции или сообщение об ошибке

Аннулирование акта

Функция: invoice.revocation

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • revocation_comment - Комментарий. Укажите комментарий к предложению об аннулировании документа

Установить фильтр по клиенту

Функция: invoice.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Отправка актов выполненных работ

Функция: invoice.send

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • method - Способ отправки. Способ отправки актов клиентам
  • sdate - Дата отправки. Дата отправки актов будет выставлена в указанное значение
  • currency - Валюта. Валюта, в которой указана стоимость отправки и сумма актов для бесплатной отправки.
  • cost - Стоимость отправки. Если за отправление актов почтой вы хотите снимать деньги с клиента, укажите сумму в данном поле. Расход будет создан с наименованием "Операционные расходы". Если средств на счету не достаточно, то баланс окажется отрицательным.
  • freepostsum - Сумма актов для бесплатной отправки. Вы можете указать сумму актов одного клиента, при достижении которой отправка будет бесплатной

Перегенерация акта

Функция: invoice.regenerate

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • invoice_status - Статус. Статус создаваемых актов
  • cdate - Дата акта. Укажите дату выставления акта
  • fromdate - Расходы с даты. Укажите дату начала периода по которому выписываются акты
  • todate - Расходы по дату. Укажите дату завершения периода, по которому выписываются акты

Выставить статус "Создан" для акта выполненных работ

Функция: invoice.status.1

Выставить статус "Создан" для акта выполненных работ

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции invoice.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

invoice.filter

Единицы измерения

Функция: measure

Результат: список элементов

Единицы измерения

Уровень доступа: admin

  • id - Id
  • name - Наименование

Удалить

Функция: measure.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции measure.

Результат: успешное выполнение операции или сообщение об ошибке

Единица измерения

Функция: measure.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Наименование. Наименование
  • intname - Внутреннее имя. Внутреннее имя, которое используется в системе
  • lessmeasure - Имеет соотношение к. Единица измерения, к которой установится соотношение
  • relation - Соотношение. Значение соотношения к выбранной единице измерения

Список нарушений

Функция: abuse_task

Результат: список элементов

Список нарушений

Уровень доступа: admin

  • id - Id
  • ticket - Запрос
  • subject - Тема
  • opendate - Дата создания
  • deadline - Срок устранения
  • account - Клиент
  • author - Инициатор
  • score - Количество баллов
  • status - Состояние
  • action - Функция

Закрыть нарушение

Функция: abuse_task.finish

Закрыть нарушение

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции abuse_task.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: abuse_task.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: abuse_task.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Нарушение

Функция: abuse_task.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • subject - Тема. Тема нарушения
  • account - Клиент. Клиент, на которого будет назначено нарушение
  • score - Количество баллов. Количество баллов за нарушение
  • action - Действие. Действие, которое необходимо выполнить при отсутствии реакции от клиента до установленного срока
  • abuse_item - Услуга. Услуга клиента, к которой относится нарушение. Также услуга будет выбрана для создаваемого запроса
  • user_responsible - Отдел. Отдел, в которой будет передан запрос при ответе клиента
  • user_deadline_responsible - Отдел. Отдел, в которой будет передан запрос при отсутствии реакции клиента
  • deadline_date - Дата устранения нарушения. Срок устранения нарушения, дата
  • deadline_time - Время устранения нарушения. Срок устранения нарушения, время
  • message - Сообщение. Сообщение, отправляемое клиенту. Так же это сообщение будет первым в создаваемом запросе
  • score_note - Комментарий. Комментарий к нарушению

Установка фильтра.

abuse_task.filter

Удалить

Функция: abuse_task.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции abuse_task.

Результат: успешное выполнение операции или сообщение об ошибке

Типы продуктов

Функция: itemtype

Результат: список элементов

Типы продуктов

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • intname - Внутреннее наименование
  • orderpriority - Сортировка

Редактирование типа продукта

Функция: itemtype.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Наименование. Наименование типа продукта
  • intname - Внутреннее имя. Внутреннее имя типа, которое используется для его идентификации. Также по внутреннему имени отбираются поддерживаемые обработчики
  • itemname - Шаблон наименования услуги. XSLT шаблон, на основе которого формируется наименование услуги и расходов за услуги данного типа. При отсутствии заполнения используется стандартный шаблон для типа
  • trialtype - Триальная версия. Выберите способ предоставления клиентам триальной версии услуг данного типа
  • splitexpense - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает равномерное распределение расходов по месяцам, например: при оплате услуги за год будет создано 12 или 13 расходов за каждый месяц, в котором будет активна услуга. Удобно для актов выполненных работ, а также учета расходов будущих периодов
  • nostopholidays - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Установите опцию, если не хотите, чтобы услуги клиентов останавливались в выходные дни: субботу и воскресенье
  • open_duration_limit - Регламент на обработку. Регламент на время обработки услуг. Формат чч:мм
  • suspendperiod - Период автоудаления. Укажите, через сколько дней после остановки неоплаченную услугу необходимо удалить
  • closetype - Правила удаления услуг. Политика доступа клиентов к удалению услуг данного типа
  • closesubtype - При удалении клиентом. Правила удаления услуги, если удаляет сам клиент
  • trial - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить триальный период
  • day - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в день
  • monthly - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в месяц
  • quarterly - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в три месяца
  • semiannual - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в полгода
  • annually - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в год
  • biennial - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в два года
  • triennial - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в три года
  • quadrennial - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в четыре года
  • quinquennial - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в пять лет
  • decennial - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в десять лет
  • lifetime - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить единоразовую оплату
  • transfer - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить трансфер
  • orderview - Отображение тарифов. Переключает режим отображения выбора тарифа при заказе услуги клиентом. Настроить описание тарифа можно в его настройках
  • show_addon_image - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность настройки и отображение иконок ресурсов при заказе и редактировании услуг

Наименование

Функция: itemtype.detail

Результат: список элементов

Содержание типа продукта

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • intname - Внутреннее наименование
  • orderpriority - Сортировка

Переместить на одну позицию выше

Функция: itemtype.detail.up

Переместить на одну позицию выше

Уровень доступа: admin

Удалить

Функция: itemtype.detail.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.detail.

Результат: успешное выполнение операции или сообщение об ошибке

Дополнение к типу продукта

Функция: itemtype.detail.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid - уникальный идентификатор (элемент id из функции itemtype.detail)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid - уникальный идентификатор (элемент id из функции itemtype.detail)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Наименование. Наименование типа продукта
  • intname - Внутреннее имя. Внутреннее имя дополнения к типу продукта
  • description - Описание. Краткое описание дополнения для отображения в BILLmanager 6
  • orderpriority - Сортировка (в прямом порядке). Порядок сортировки дополнений на форме
  • showoninfo - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Используется при детализации услуги. Отображается только в пользовательском интерфейсе BILLmanager 6
  • select_paramgroup - Группа. Принадлежность к одной из групп. Используется при детализации услуги. Отображается только в пользовательском интерфейсе BILLmanager 6

Переместить на одну позицию ниже

Функция: itemtype.detail.down

Переместить на одну позицию ниже

Уровень доступа: admin

Наименование

Функция: itemtype.param

Результат: список элементов

Параметры услуг

Уровень доступа: admin

  • id - Id
  • locale_name - Наименование
  • intname - Внутреннее наименование
  • orderpriority - Сортировка

Переместить параметр услуги на одну позицию вверх

Функция: itemtype.param.up

Переместить параметр услуги на одну позицию вверх

Уровень доступа: admin

Редактирование параметра

Функция: itemtype.param.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid - уникальный идентификатор (элемент id из функции itemtype.param)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid - уникальный идентификатор (элемент id из функции itemtype.param)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Наименование. Наименование
  • tune_pricelists - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При отключенной опции параметр подключен ко всем тарифным планам, активная опция позволяет производить настройку подключения вручную
  • intname - Внутреннее имя. Внутреннее имя параметра для использования в обработчиках услуг
  • ordervisible - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте галочку, если при заказае необходимо попросить пользователя указать этот параметр
  • openvisible - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте галочку, если параметр необходимо заполнить при открытии услуги. Заполняется автоматическим обработчиком или вручную.
  • listvisible - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте галочку, если параметр необходимо показывать в списке услуг
  • editreadlevel - Доступ на чтение. Минимальный уровень пользователя, для которого будет виден параметр
  • editwritelevel - Доступ для изменения. Минимальный уровень пользователя, которому будет доступно изменение параметра
  • needsetparam - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При изменении параметра будет вызван модуль обработки с командой setparam
  • crypted - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Выставите флаг, если значение параметра необходимо хранить в зашифрованном виде
  • hint - Подсказка. Подсказка к полю, которая появляется при наведении на символ вопроса
  • description - Описание. Краткое описание параметра для отображения в BILLmanager 6
  • orderpriority - Сортировка. Сортировка параметров при отображении на форме заказа и редактирования услуги
  • select_paramgroup - Группа. Принадлежность к одной из групп. Используется при детализации услуги. Отображается только в пользовательском интерфейсе BILLmanager 6
  • selecttype - Тип отображения. Используется только в пользовательском интерфейсе BILLmanager 6
  • inputtype - Тип поля ввода. Укажите данные какого типа будут вводиться в поле
  • zoom - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает возможность ввода нескольких значений, разделенных пробелом. Выбранный валидатор будет применен к каждому значению в отдельности
  • inputrows - Количество строк ввода. Укажите количество строк ввода в текстовом поле
  • required - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить пустое значение для параметра
  • validator - Функция проверки. Выберите функцию проверки введенного значения. Это не позволит пользователю ввести значение в неправильном формате
  • select_ip - Тип адреса. Тип IP-адреса
  • num_range - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Диапазон допустимых значений
  • r_start_int - Начало диапазона. Начальное значение диапазона
  • r_end_int - Конец диапазона. Конечное значение диапазона
  • r_start_float - Начало диапазона. Начальное значение диапазона
  • r_end_float - Конец диапазона. Конечное значение диапазона

Переместить параметр услуги на одну позицию вниз

Функция: itemtype.param.down

Переместить параметр услуги на одну позицию вниз

Уровень доступа: admin

Тарифный план

Функция: itemtype.param.pricelist

Результат: список элементов

Тарифные планы

Уровень доступа: admin

  • id - Id
  • name - Тарифный план
  • status - Состояние
Подключить параметр к тарифному плану

Функция: itemtype.param.pricelist.resume

Подключить параметр к тарифному плану

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Отключить параметр от тарифного плана

Функция: itemtype.param.pricelist.suspend

Отключить параметр от тарифного плана

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: itemtype.param.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: itemtype.param.value

Результат: список элементов

Значения для параметров с типом список

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • intname - Внутреннее имя
  • tags - Тэги
  • orderpriority - Сортировка
  • status - Состояние
Подключить значение параметра ко всем тарифным планам

Функция: itemtype.param.value.resume

Подключить значение параметра ко всем тарифным планам

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.value.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование значения

Функция: itemtype.param.value.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype.param).
    • elid - уникальный идентификатор (элемент id из функции itemtype.param.value)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype.param).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype.param).
    • elid - уникальный идентификатор (элемент id из функции itemtype.param.value)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Наименование. Наименование
  • intname - Внутреннее имя. Внутреннее имя значения. Обычно используется модулями обработки
  • tags - Тэги. Список тэгов, разделенных знаком ","
  • disablepricelists - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При активной опции значение параметра автоматически не подключается к тарифным планам, в том числе при создании нового тарифного плана
  • info - Краткая информация. Краткая информация к значению списка, которая будет показана клиенту при выборе
  • orderpriority - Сортировка. Позволяет задать порядок отображения параметра в списке выбора на форме редактирования услуги
  • valuegroup - Группа параметров. Позволяет задать группу, в которой будет отображаться параметр на форме заказа и редактирования услуги. Отображается только в пользовательском интерфейсе BILLmanager 6
Отключить значение параметра от всех тарифных планов

Функция: itemtype.param.value.suspend

Отключить значение параметра от всех тарифных планов

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.value.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить значение параметра услуги на одну позицию вниз в списке

Функция: itemtype.param.value.down

Переместить значение параметра услуги на одну позицию вниз в списке

Уровень доступа: admin

Установка фильтра.

itemtype.param.value.filter

Переместить значение параметра услуги на одну позицию вверх в списке

Функция: itemtype.param.value.up

Переместить значение параметра услуги на одну позицию вверх в списке

Уровень доступа: admin

Модуль обработки

Функция: itemtype.param.value.processing

Результат: список элементов

Обработчики услуг

Уровень доступа: admin

  • id - Id
  • name - Модуль обработки
  • status - Состояние
Выключить

Функция: itemtype.param.value.processing.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.value.processing.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: itemtype.param.value.processing.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.value.processing.

Результат: успешное выполнение операции или сообщение об ошибке

Тарифный план

Функция: itemtype.param.value.pricelist

Результат: список элементов

Тарифные планы

Уровень доступа: admin

  • id - Id
  • name - Тарифный план
  • status - Состояние
Включить

Функция: itemtype.param.value.pricelist.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.value.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: itemtype.param.value.pricelist.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.value.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: itemtype.param.value.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.param.value.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: itemtype.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: itemtype.orderpage

Результат: список элементов

Страницы заказа

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • intname - Внутреннее наименование
  • orderpriority - Сортировка
  • status - Состояние

Удалить

Функция: itemtype.orderpage.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.orderpage.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить страницу на одну позицию вверх

Функция: itemtype.orderpage.up

Переместить страницу на одну позицию вверх

Уровень доступа: admin

Редактирование страницы заказа

Функция: itemtype.orderpage.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid - уникальный идентификатор (элемент id из функции itemtype.orderpage)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid - уникальный идентификатор (элемент id из функции itemtype.orderpage)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Наименование. Наименование страницы
  • intname - Внутреннее имя. Внутреннее имя страницы, которое используется для его идентификации
  • orderpriority - Сортировка. Порядок сортировки
  • defaultpage - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Страница по умолчанию для распределения тарифов. При выборе этого пункта данный флаг у текущей страницы по умолчанию будет снят

Переместить страницу на одну позицию вниз

Функция: itemtype.orderpage.down

Переместить страницу на одну позицию вниз

Уровень доступа: admin

Переместить тип продукта на одну позицию вниз

Функция: itemtype.down

Переместить тип продукта на одну позицию вниз

Уровень доступа: admin

Переместить тип продукта на одну позицию вверх

Функция: itemtype.up

Переместить тип продукта на одну позицию вверх

Уровень доступа: admin

Уведомления

Функция: notification

Результат: список элементов

Уведомления

Уровень доступа: admin user

  • id - Id
  • subject - Заголовок
  • cdate - Дата

Удалить

Функция: notification.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции notification.

Результат: успешное выполнение операции или сообщение об ошибке

Просмотр уведомления

Функция: notification.view

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

DNS-хостинг

Функция: dnshost

Результат: список элементов

DNS-хостинг

Уровень доступа: admin user

  • id - Id
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

Установка фильтра.

dnshost.filter

Заказать новую услугу

Функция: dnshost.order

Заказать новую услугу

Уровень доступа: user

Открытие услуги

Функция: dnshost.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки, назначенный услуге

Удалить выделенные услуги

Функция: dnshost.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции dnshost.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: dnshost.su

Войти в панель с правами пользователя

Уровень доступа: admin

Выключить

Функция: dnshost.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции dnshost.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: dnshost.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Включить

Функция: dnshost.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции dnshost.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование услуги

Функция: dnshost.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки
  • autoprolong - Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate - Дата заказа. Дата заказа услуги
  • opendate - Дата создания. Дата фактического начала действия услуги
  • expiredate - Действует до. Срок действия услуги
  • scheduledclose - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note - Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Игровой хостинг

Функция: gamehost

Результат: список элементов

Игровой хостинг

Уровень доступа: admin user

  • id - Id
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

Заказать новую услугу

Функция: gamehost.order

Заказать новую услугу

Уровень доступа: user

Выключить

Функция: gamehost.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции gamehost.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: gamehost.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: gamehost.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Установка фильтра.

gamehost.filter

Включить

Функция: gamehost.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции gamehost.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование услуги

Функция: gamehost.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки
  • autoprolong - Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate - Дата заказа. Дата заказа услуги
  • opendate - Дата создания. Дата фактического начала действия услуги
  • expiredate - Действует до. Срок действия услуги
  • scheduledclose - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note - Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: gamehost.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции gamehost.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: gamehost.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки, назначенный услуге

Серверы имен

Функция: processing.nameserver

Результат: список элементов

Серверы имен

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • module - Панель управления
  • status - Состояние

Перейти в панель

Функция: processing.nameserver.gotoserver

Перейти в панель

Уровень доступа: admin

Создать

Функция: processing.nameserver.add

Создать

Уровень доступа: admin

Удалить

Функция: processing.nameserver.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.nameserver.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование сервера имен

Функция: processing.nameserver.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • project - Провайдер. Провайдер, к которому относится сервер имен
  • module - Панель управления. Выберите панель управления
  • name - Наименование. Наименование сервера имен
  • url - URL. URL панели управления
  • login - Имя пользователя. Укажите имя пользователя для доступа к панели управления (уровень пользователя для DNSmanager - реселлер или пользователь; для ISPmanager - реселлер или администратор)
  • password - Пароль. Укажите пароль для доступа к панели управления
  • freedomain - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сервер может использоваться для создания бесплатных доменных имен
  • dnsprovider - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сервер может использоваться для создания доменных имен провайдера
  • dnsprovidercount - Количество доменов. Максимальное количество доменов на учетную запись
  • dnsprivate - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сервер может использоваться для создания собственных доменных имен
  • dnsprivatecount - Количество доменов. Максимальное количество доменов на учетную запись

Журнал операций

Функция: journal

Результат: список элементов

Журнал операций

Уровень доступа: user

  • time - Время
  • user - Пользователь
  • ip - Удалённый IP-адрес
  • funcname - Функция

Установка фильтра.

journal.filter

Просмотр журнала

Функция: journal.edit

Уровень доступа: user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • time - Время. Время выполнения операции с панелью управления
  • user - Пользователь. Пользователь, выполнивший операцию с панелью управления
  • ip - Удалённый IP-адрес. IP-адрес, с которого пользователь выполнил операцию с панелью управления
  • funcname - Функция. Имя вызванной функции панели управления
  • params - Параметры. Список параметров, переданных функции панели управления

Наименование

Функция: journal.stat

Результат: отчёт

Использование функций за период

Уровень доступа: admin+

Обработчики услуг

Функция: processing

Результат: список элементов

Обработчики услуг

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • module - Обработчик
  • datacenter_name - Дата-центр
  • pusage - Использование
  • balance_info - Баланс обработчика
  • orderpriority - Сортировка
  • status - Состояние

Наименование

Функция: processing.customparam

Результат: список элементов

Параметры модуля обработки

Уровень доступа: admin

  • id - Id
  • param - Параметр
  • value - Значение

Вы можете задать условия отбора для данного списка. Они будут применяться всякий раз при его отображении до тех пор пока фильтр не будет изменен или снят

Функция: processing.customparam.filter

Вы можете задать условия отбора для данного списка. Они будут применяться всякий раз при его отображении до тех пор пока фильтр не будет изменен или снят

Уровень доступа: admin

Редактирование параметра

Функция: processing.customparam.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid - уникальный идентификатор (элемент id из функции processing.customparam)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid - уникальный идентификатор (элемент id из функции processing.customparam)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • param - Параметр. Укажите тип параметра
  • value - Значение. Значение параметра

Удалить выбранные параметры

Функция: processing.customparam.delete

Удалить выбранные параметры

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.customparam.

Результат: успешное выполнение операции или сообщение об ошибке

Обновить конфигурацию модуля обработки

Функция: processing.updateconfig

Обновить конфигурацию модуля обработки

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.

Результат: успешное выполнение операции или сообщение об ошибке

Создать

Функция: processing.add

Создать

Уровень доступа: admin

Установка фильтра.

processing.filter

Переместить модуль обработки на одну позицию выше

Функция: processing.up

Переместить модуль обработки на одну позицию выше

Уровень доступа: admin

Наименование

Функция: processing.pricelist

Результат: список элементов

Тарифы, обрабатываемые модулем

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • status - Состояние

Включить

Функция: processing.pricelist.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: processing.pricelist.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить модуль обработки на одну позицию ниже

Функция: processing.down

Переместить модуль обработки на одну позицию ниже

Уровень доступа: admin

Удалить

Функция: processing.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: processing.import

Результат: список элементов

Импорт услуг

Уровень доступа: admin

  • id - Id
  • item_name - Наименование
  • expiredate - Действует до
  • account - Клиент
  • status - Статус

Очистить список услуг

Функция: processing.import.clear

Очистить список услуг

Уровень доступа: admin

Наименование

Функция: processing.import.service_profile

Результат: список элементов

Загруженные профили услуги

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • item_count - Количество услуг
Параметры контакта

Функция: service_profile.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing.import).
    • elid - уникальный идентификатор (элемент id из функции processing.import.service_profile)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing.import).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing.import).
    • elid - уникальный идентификатор (элемент id из функции processing.import.service_profile)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Название профиля. Название профиля используется для упрощения идентификации его в списке профилей услуг
  • profiletype - Тип контакта. Юридический статус контакта

Удалить выделенные услуги

Функция: processing.import.delete

Удалить выделенные услуги

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.import.

Результат: успешное выполнение операции или сообщение об ошибке

Получение списка услуг

Функция: processing.import.load

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid - уникальный идентификатор (элемент id из функции processing.import)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid - уникальный идентификатор (элемент id из функции processing.import)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • itemtype - Тип услуг. Тип услуг, для которого будут получены данные
  • search - Условие поиска. Условие, по которому будут отобраны услуги. Если необходимо импортировать все услуги, то нужно оставить пустым. Если интересует определенная услуга, то введите часть ее наименования или доменное имя. Пример: foo.bar

Назначение услуги клиенту

Функция: processing.import.assign

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid - уникальный идентификатор (элемент id из функции processing.import)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid - уникальный идентификатор (элемент id из функции processing.import)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • account - Клиент. Клиент, к которому переносится услуга

Включить

Функция: processing.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование модуля обработки

Функция: processing.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • datacenter - Дата-центр. Дата-центр
  • name - Наименование. Произвольное наименование обработчика для отображения в интерфейсе
  • department - Ответственный. Ответственный отдел, на который будут назначаться задачи в случае необходимости
  • orderpriority - Сортировка. Приоритет обработчика
  • threshold - Минимальный баланс обработчика. Минимальный баланс обработчика, для успешного продления услуг

Перейти в панель

Функция: gotomoduleserver

Перейти в панель

Уровень доступа: admin

Выключить

Функция: processing.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции processing.

Результат: успешное выполнение операции или сообщение об ошибке

Шаблоны документов

Функция: doctmpl

Результат: список элементов

Шаблоны документов

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • doctype - Тип
  • templatetype - Разметка
  • locale - Язык документа

Сброс на значение по умолчанию шаблона

Функция: doctmpl.restoredefault

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • doctmpl - Шаблон. Позволяет использовать один из встроенных шаблонов как основу создаваемого документа

Редактирование шаблона документа

Функция: doctmpl.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Наименование. Наименование шаблона
  • doctype - Тип документа. Тип документа используется для фильтрации списка документов при выборе его в качестве шаблона печатной формы
  • language - Язык. Язык текста документа
  • doctmpl - Шаблон. Позволяет использовать один из встроенных шаблонов как основу создаваемого документа
  • content - Содержимое шаблона документа. Содержимое шаблона документа в формате XSLT или EJS

Удалить

Функция: doctmpl.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции doctmpl.

Результат: успешное выполнение операции или сообщение об ошибке

Виртуальный хостинг

Функция: vhost

Результат: список элементов

Виртуальный хостинг

Уровень доступа: admin user

  • domain - Доменное имя
  • ip - IP-адрес
  • processingnode - Узел кластера
  • username - Имя пользователя
  • id - Id
  • pricelist - Тариф
  • account - Клиент
  • project - Провайдер
  • datacentername - Дата-центр
  • processingmodule - Модуль обработки
  • createdate - Дата создания
  • expiredate - Действует до
  • autoprolong - Автопродление
  • status_msg -
  • item_status -
  • cost - Стоимость

Редактирование услуги

Функция: vhost.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки
  • autoprolong - Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate - Дата заказа. Дата заказа услуги
  • opendate - Дата создания. Дата фактического начала действия услуги
  • expiredate - Действует до. Срок действия услуги
  • scheduledclose - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note - Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: vhost.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции vhost.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: vhost.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции vhost.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: vhost.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule - Модуль обработки. Модуль обработки, назначенный услуге

Заказать новую услугу

Функция: vhost.order

Заказать новую услугу

Уровень доступа: user

Войти в панель с правами пользователя

Функция: vhost.su

Войти в панель с правами пользователя

Уровень доступа: admin

Выключить

Функция: vhost.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции vhost.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

vhost.filter

Установить фильтр по клиенту

Функция: vhost.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Тарифные планы

Функция: pricelist

Результат: список элементов

Тарифные планы

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • itemtype_name - Тип
  • project - Провайдер
  • processingmodules - Обработчики
  • pricelist_cost - Стоимость
  • orderpriority - Сортировка
  • status - Состояние

Наименование

Функция: pricelist.history

Результат: список элементов

История изменения тарифного плана

Уровень доступа: admin

  • changedate - Дата изменения
  • desc - Описание тарифа
  • user - Пользователь
  • ip - IP-адрес
  • action - Функция

Наименование

Функция: itemtype.orderreference

Результат: список элементов

Правила заказа тарифа

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • status - Состояние

Включить

Функция: itemtype.orderreference.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.orderreference.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: pricelist.orderreference

Результат: список элементов

Правила заказа тарифа

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • status - Состояние
Включить

Функция: pricelist.orderreference.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.orderreference.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: pricelist.orderreference.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.orderreference.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: itemtype.orderreference.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции itemtype.orderreference.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: pricelist.detail

Результат: список элементов

Содержание тарифного плана

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • price - Цены
  • orderpriority - Сортировка
  • status - Состояние

Наименование

Функция: pricelist.detail.integer

Результат: список элементов

Цены при разных количествах

Уровень доступа: admin

  • id - Id
  • value - Количество
  • price - Цены
Удалить

Функция: pricelist.detail.integer.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.detail.integer.

Результат: успешное выполнение операции или сообщение об ошибке

Специальная цена

Функция: pricelist.detail.integer.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • elid - уникальный идентификатор (элемент id из функции pricelist.detail.integer)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • elid - уникальный идентификатор (элемент id из функции pricelist.detail.integer)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • value - Количество. Количество ресурсов, при достижении которого (больше или равно) будет применяться специальная цена. Значения от до

Включить

Функция: pricelist.detail.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.detail.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: pricelist.detail.enum

Результат: список элементов

Цены

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • price - Цена
  • orderpriority - Сортировка
  • status - Состояние
Включить

Функция: pricelist.detail.enum.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.detail.enum.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: pricelist.detail.enum.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.detail.enum.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить на одну позицию вверх

Функция: pricelist.detail.enum.up

Переместить на одну позицию вверх

Уровень доступа: admin

Цены

Функция: pricelist.detail.enum.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • elid - уникальный идентификатор (элемент id из функции pricelist.detail.enum)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • elid - уникальный идентификатор (элемент id из функции pricelist.detail.enum)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • orderpriority - Сортировка. Порядок сортировки элемента перечисления в списке выбора
Переместить на одну позицию вниз

Функция: pricelist.detail.enum.down

Переместить на одну позицию вниз

Уровень доступа: admin

Переместить дополнение к тарифу на одну позицию вверх

Функция: pricelist.detail.up

Переместить дополнение к тарифу на одну позицию вверх

Уровень доступа: admin

Редактирование ресурса

Функция: pricelist.detail.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • elid - уникальный идентификатор (элемент id из функции pricelist.detail)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • elid - уникальный идентификатор (элемент id из функции pricelist.detail)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • billtype - Тип учета. Способ списания средств за дополнение с клиента
  • chargestoped - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При выключенном флаге клиент получает компенсацию за часы простоя остановленной услуги.
  • itemtype - Тип. Тип дополнения. Определяет ресурс, который регулируется данным дополнением
  • addontype - Тип значения. Способ задания значения дополнения к тарифу
  • selecttype - Тип отображения. Используется только в пользовательском интерфейсе BILLmanager 6
  • scaletype - Тип шкалы значений. Параметр используется при расчете стоимости дополнения при заданной шкале цен
  • restrictclientchange - Изменение ресурса после заказа. Политика изменение клиентом ресурса после заказа
  • minperiodtype - Мин. период заказа. Минимальный период, по истечению которого клиент сможет изменить дополнение в сторону уменьшения
  • minperiodlen - Длительность. Длина минимального периода заказа дополнения
  • manualprocessing - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для обработки ресурса будет создана задача в технический отдел
  • manualprocessing_skipdefault - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если данная опция включена, и для дополнения выбрано значение по умолчанию, то это дополнение не будет добавлено в задачу на ручную обработку.
  • manualname - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции в качестве наименования дополнения будет использовано указанное значение
  • name - Наименование. Наименование тарифного плана
  • intname - Служебное имя. Указывается при необходимости переопределения стандартного служебного имени дополнения, например для расчета статистики использования ресурсов по нескольким параметрам, или в случае если имя параметра отличается от служебного имени дополнения
  • processing_feature - Проверять возможность. При выборе дополнения с указанной возможностью будет выбран обработчик, у которого данная возможность присутствует
  • roundtype - Способ округления. Способ округления расчитанного значения
  • addonstattype - Считать превышение. Выберите, за какой период считать превышение
  • addonstatcomparison - Если параметров несколько. Выберите как считать, если параметров одного типа несколько. К примеру, трафик может быть входящим и исходящим.
  • addonstatcalculation - Цена указана. Укажите, за что указана цена. Если за единицу в месяц, то статистика будет считаться как: (превышение за день) * (цену) / (количество дней в месяце)
  • addonstatchargestoped - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При проставленной опции списание по данному дополнению будут идти и на остановленной услуге
  • allowpostpaid - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает списание средств за перерасход ресурса без учета баланса клиента
  • summarizeinvoice - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Суммировать значение параметра за весь период при генерации акта выполненных работ
  • measure - Единица измерения. Единица измерения, в которой задается дополнение. При передаче значения дополнения в панель управления заказанное значение будет переведено в единицу измерения используемую панелью управления
  • addonlimit - Включено в тариф. Значение по умолчанию для дополнения
  • addonstep - Шаг. Шаг заказа дополнения
  • addonmin - Минимальное значение. Минимальное значение для заказа. Не может быть меньше чем включено в тариф.
  • addonmax - Максимальное значение. Максимальное доступное для заказа значение ресурса
  • addonlimittrial - Включено в тариф на триальном периоде. Значение по умолчанию для дополнения на триальном периоде
  • addonmaxtrial - Максимальное значение на триальном периоде. Максимальное доступное для заказа значение ресурса которое можно заказать на триальном периоде
  • enumeration - Перечисление. Перечисление, из которого будут браться значения для дополнений к услугам
  • enumerationitem - Значение по умолчанию. Элемент перечисления, включенный по умолчанию при заказе услуги
  • orderpolicy - Стоимость при изменении. Способ расчета стоимости изменения значения дополнения
  • addonbool - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Значение по умолчанию для дополнения
  • orderpriority - Сортировка (в прямом порядке). Позволяет задать приоритет дополнения тарифа при сортировке
  • description - Описание дополнения. Описание дополнения. Поддерживается простой html. Для переноса строки используйте <br/>, для выделения жирным шрифтом или курсивом <b></b> и <i></i>
  • description_markdown - Описание дополнения (markdown). Описание дополнения. Для составления описания используется markdown разметка

Удалить

Функция: pricelist.detail.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.detail.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить дополнение тарифу на одну позицию вниз

Функция: pricelist.detail.down

Переместить дополнение тарифу на одну позицию вниз

Уровень доступа: admin

Наименование

Функция: pricelist.detail.compound

Результат: список элементов

Варианты ресурса

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • price - Цены
  • orderpriority - Сортировка
  • status - Состояние
Переместить дополнение к тарифу на одну позицию вверх

Функция: pricelist.detail.compound.up

Переместить дополнение к тарифу на одну позицию вверх

Уровень доступа: admin

Выключить

Функция: pricelist.detail.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.detail.compound.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить дополнение тарифу на одну позицию вниз

Функция: pricelist.detail.compound.down

Переместить дополнение тарифу на одну позицию вниз

Уровень доступа: admin

Импорт тарифа со стороннего сервера

Функция: pricelist.import

Импорт тарифа со стороннего сервера

Уровень доступа: admin

Наименование

Функция: pricelist.reference

Результат: список элементов

Настройка зависимостей дополнений

Уровень доступа: admin

  • id - Id
  • referencedesc - Зависимость
  • reference - Соотношение

Изменение зависимости

Функция: pricelist.reference.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • elid - уникальный идентификатор (элемент id из функции pricelist.reference)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • elid - уникальный идентификатор (элемент id из функции pricelist.reference)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • pricelist_base - Основное дополнение. Дополнение тарифного плана, при изменении которого будет изменено значение зависимого дополнения
  • base_value - Значение. Значение основного дополнения, при котором будет изменено зависимое дополнение. Значения от до
  • enumerationitem_base - Значения. Значения, при выборе одного из которых будет изменено зависимое дополнений
  • pricelist_reference - Зависимое дополнение. Дополнение, которое будет изменено при изменении основного дополнения
  • reference_value - Значение. Значение, которое будет выставлено для зависимого дополнения. Значения от до
  • enumerationitem_reference - Значения. Значения, которые будут доступны при изменении основного дополнения

Копировать выбранную зависимость

Функция: pricelist.reference.clone

Копировать выбранную зависимость

Уровень доступа: admin

Удалить

Функция: pricelist.reference.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.reference.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: pricelist.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить тариф на одну позицию вверх

Функция: pricelist.up

Переместить тариф на одну позицию вверх

Уровень доступа: admin

Выключить

Функция: pricelist.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Создать

Функция: pricelist.add

Создать

Уровень доступа: admin

Редактирование тарифного плана

Функция: pricelist.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Наименование. Наименование тарифного плана
  • processingmodule - Обработчик услуг. Выберите какие обработчики услуг будут обрабатывать услуги создаваемого тарифного плана. Тарифы не подключенные к обработчикам услуг не будут доступны для заказа.
  • modulepreset - Конфигурация.
  • intname - Внутреннее наименование. Внутренее наименование служит для получения значений по умолчанию параметров создаваемых услуг из обработчика либо для идентификации базовой конфигурации при ручной обработке
  • billdaily - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенном флаге оплата за услугу будет сниматься ежедневно. Сумма будет рассчитана пропорционально стоимости одного дня в месяце расчета. Политики смены тарифа при этом не работают.
  • billhourly - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включении флага клиент получает права на запуск/остановку услуг данного тарифа. В зависимости от установки флага "Списывать средства при остановке", клиент может получить компенсацию за часы простоя остановленной услуги. При этом средства списываются в начале дня полностью, возврат компенсации осуществляется на следующий день с учетом времени простоя.
  • chargestoped - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При выключенном флаге клиент получает компенсацию за часы простоя остановленной услуги. Такой же флаг есть у каждого ресурса (по умолчанию он включен). Нет никакой зависимости между флагами в самом тарифном плане и в дополнительных ресурсах.
  • autocalcday - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если стоит флаг, то стоимость дня рассчитывается из стоимости месяца деленного на количество дней в месяц
  • billprorata - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включении опции срок действия услуги будет выровнен по календарному месяцу в зависимости от дня, указанного в поле "Переходный день". Если клиент заказывает услугу в день месяца до указанного, срок действия услуги будет рассчитан до конца текущего месяца; если же в день указанный в настройке или позже, то до конца следующего месяца. Также пропорционально изменению периода действия услуги будет изменена стоимость заказа/продления
  • prorataday - Переходный день. Переходный день для календарного списания средств
  • quickorder - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность быстрого заказа услуг, без указания при заказе параметров
  • opennotify - Шаблон уведомления об открытии услуги. Шаблон, на основе которого будет сформирована инструкция по услуге. Отправляется на почту клиенту после обработки открытия услуги, а также доступна по кнопке в списке услуг
  • license - Условия предоставления услуг. Шаблон отображения условий предоставления услуг, при наличии которого, во время заказа услуги, клиенту будет необходимо согласиться с условиями предоставления услуг. Создать или отредактировать шаблон можно в меню 'Шаблоны документов'
  • pricelist_group - Группа тарифа. Группа тарифа служит для объединения тарифов для предоставления общих скидок и действия политик триального периода, а также для объединения тарифов по группам в отчетах
  • create_addon - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При создании тарифа будут также созданы все доступные для тарифного плана дополнения
  • show_on_dashboard - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отображать тариф на главной странице в интерфейсе BILLmanager 6
  • orderpage - Страница. Страница заказа услуги, на которой будет отображен тариф в интерфейсе BILLmanager 6
  • ostemplate - Шаблоны операционных систем. Шаблоны операционных систем, которые будут включены в тариф
  • access - Доступен для заказа. Выбор группы клиентов, для которой тариф доступен для заказа и перехода
  • minperiodtype - Минимальный период заказа. Минимальный период, по истечении которого клиент сможет отказаться от услуги. При ежедневном списании также влияет на резервирование средств на оплату заказанной услуги
  • minperiodlen - Длина минимального периода. Длина минимального периода в днях или месяцах
  • trial - Триальный период. Длина триального периода в днях. Политика предоставления триального периода определяется настройками типа продукта. Оставьте пустым, если для данного тарифа нет пробного периода
  • trial_itemmax - Количество триалов доступных для заказа. Максимальное количество триальных экземпляров услуг данного тарифного плана
  • itemmax - Количество услуг доступных для заказа. Укажите максимально количество услуг доступных для заказа одним клиентом. По достижению указанного количества клиентом, заказ дополнительных услуг данного тарифа клиенту будет недоступен
  • suspendpenaltytype - Штраф за просрочку продления. Тип штрафа за просрочку продления услуги. Штраф взимается непосредственно при оплате продления услуги
  • suspendpenaltypercent - Процент стоимости. Процент стоимости услуги за просроченный период
  • allownosuitable - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если нет свободных ресурсов или нет в наличии выделенных серверов, услуга будет доступна для заказа
  • suspendperiod - Период автоудаления. Укажите, через сколько дней после остановки неоплаченную услугу необходимо удалить. Если оставить поле пустым, будет действовать политика типа продукта
  • nostopholidays - Выключение услуг по выходным. Позволяет переопределить политику остановки услуг типа продукта
  • changepolicy - Политика смены тарифа. Политика расчетов применяемая при смене тарифа услуги
  • changeprolongpolicy - Продление с. Политика продления услуги на новый тарифный план
  • orderpolicy - Политика заказа доп. ресурсов. Способ расчета стоимости дополнительных ресурсов при заказе в период действия услуги
  • returnpolicy - Политика отказа от доп. ресурсов. Способ расчета суммы возврата при отказе от дополнительных ресурсов в период действия услуги
  • note - Заметки. Служебные заметки к тарифу для сотрудников провайдера
  • orderlink - Ссылка для заказа тарифного плана. Используйте данную ссылку для перехода к заказу с Вашего сайта
  • quickorderlinkbasket - .
  • quickorderlinkpayment - .
  • orderpriority - Сортировка. Приоритет тарифа при сортировке (в прямом порядке)
  • show_addon_image - Отображать иконки ресурсов. Включает возможность настройки и отображение иконок ресурсов при заказе и редактировании услуг
  • description - Описание тарифа.
  • description_markdown - Описание тарифа (markdown).
  • siteinfo - Информация для сайта. Любая служебная информация, требующаяся для интеграции с сайтом
  • label - Метки. Метки тарифа для фильтрации при заказе. Метки указываются с новой строки

Наименование

Функция: pricelist.processing

Результат: список элементов

Подключение к обработчикам тарифного плана

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • orderpriority - Приоритет
  • status - Состояние

Выключить

Функция: pricelist.processing.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.processing.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить обработчик на одну позицию вверх

Функция: pricelist.processing.up

Переместить обработчик на одну позицию вверх

Уровень доступа: admin

Включить

Функция: pricelist.processing.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.processing.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить обработчик на одну позицию вниз

Функция: pricelist.processing.down

Переместить обработчик на одну позицию вниз

Уровень доступа: admin

Переместить тариф на одну позицию вниз

Функция: pricelist.down

Переместить тариф на одну позицию вниз

Уровень доступа: admin

Скопировать выделенный тариф

Функция: pricelist.clone

Скопировать выделенный тариф

Уровень доступа: admin

Удалить

Функция: pricelist.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

pricelist.filter

Наименование

Функция: pricelist.change

Результат: список элементов

Правила смены тарифа

Уровень доступа: admin

  • id - Id
  • name - Наименование
  • status - Состояние

Наименование

Функция: pricelist.change.rule

Результат: список элементов

Особые правила смены тарифа

Уровень доступа: admin

  • id - Id
  • fromdate - Дата заказа с
  • todate - Дата заказа до
  • period - Период заказа
  • discount - Скидка, %
Особое правило на смену тарифа

Функция: pricelist.change.rule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.change).
    • elid - уникальный идентификатор (элемент id из функции pricelist.change.rule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.change).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции pricelist.change).
    • elid - уникальный идентификатор (элемент id из функции pricelist.change.rule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • fromdate - Дата заказа с. Начальная дата периода, в которым должна попасть дата заказа услуги для применения к ней правила
  • todate - Дата заказа до. Конечная дата периода, в которым должна попасть дата заказа услуги для применения к ней правила
  • period - Период заказа. На разных периодах заказа (вечный, месяц и т.д.) можно иметь разные правила.
  • discount - Скидка на новый тариф. Укажите скидку в процентах, с которой будет предоставлен новый товар.
Удалить

Функция: pricelist.change.rule.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.change.rule.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: pricelist.change.resume

Включить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.change.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: pricelist.change.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции pricelist.change.

Результат: успешное выполнение операции или сообщение об ошибке

Почтовые уведомления

Функция: emailnotify

Уровень доступа: admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

  • servertype - Тип почтового сервера. Тип почтового сервера через который будут отправляться почтовые уведомления
  • smtpserver - Адрес SMTP-сервера. Укажите адрес SMTP-сервера, с которого будет происходит отправка оповещений
  • smtpuser - Учетная запись . Укажите имя учетной записи (имя пользователя или полный адрес электронной почты, например, example@mail.com)
  • smtppassword - Пароль. Введите пароль
  • smtpport - Порт SMTP-сервера. Укажите порт, на котором работает SMTP-сервер, по умолчанию - 25-й порт
  • sendername - Имя отправителя. Имя отправителя которое по умолчанию будет добавляться в письма
  • servername_param - Имя сервера. Укажите доменное имя сервера, которое будет использоваться в почтовом сообщении
  • type_auth - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений об успешной авторизации в панели
  • type_geoip - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений модуля отслеживания региона по IP-адресу. Если отключить данную опцию, будет остановлена работа всего модуля GeoIP
  • type_recovery - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений модуля восстановления пароля. Если отключить данную опцию, будет остановлена работа всего модуля восстановления пароля
  • type_dnssec - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений от расширения DNSSEC dns-сервера.

Входящие сообщения

Функция: gateway_message

Результат: список элементов

Входящие сообщения

Уровень доступа: admin

  • id - Id
  • name - Тема
  • sender - Отправитель
  • date_post - Дата получения
  • reason_code - Тип сообщения
  • identifier - Шлюз
  • project - Провайдер

Удалить

Функция: gateway_message.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции gateway_message.

Результат: успешное выполнение операции или сообщение об ошибке

Входящее сообщение

Функция: gateway_message.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Тема. Тема сообщения
  • error_message - Сообщение об ошибке. Ошибка, из-за которой данное сообщение было помещено в список входящих
  • message - .
  • action - Действие. Действие, которое необходимо выполнить
  • account - Клиент. Клиент, от имени которого пришло сообщение
  • project - Провайдер. Провайдер, на отдел которого будет назначен запрос. Если клиент не был подключен к провайдеру, будет произведено его подключение
  • department - Отдел. Отдел, на который будет назначен запрос

Удалить сообщения и пометить отправителя как спам

Функция: gateway_message.spam

Удалить сообщения и пометить отправителя как спам

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции gateway_message.

Результат: успешное выполнение операции или сообщение об ошибке

Все запросы

Функция: ticket_all

Результат: список элементов

Все запросы

Уровень доступа: admin

  • id - Id
  • name - Тема
  • client - Клиент
  • date_start - Дата создания
  • last_message - Последнее сообщение
  • last_activity - Последняя активность
  • responsible - Ответственный
  • project_name - Провайдер
  • tstatus - Статус
  • props - Свойства

Войти в панель с правами пользователя

Функция: ticket_all.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: ticket_all.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Наименование

Функция: ticket_all.message

Результат: список элементов

Список сообщений запроса

Уровень доступа: admin

  • id - Id
  • message - Сообщение
  • date_post - Дата написания
  • message_user - Автор

Запрос

Функция: ticket_all.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item - Услуга. Услуга, к которой относится запрос
  • ticket_project_select - Провайдер. Провайдер, к которому относится тема запроса
  • client_department - Отдел. Отдел провайдера, в который будет передан запрос
  • item - Услуга. Услуга, к которой относится запрос
  • client_priority - Приоритет. Приоритет запроса
  • priority - Приоритет. Приоритет запроса
  • message - .
  • show_optional - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут отображены дополнительные настройки запроса
  • note_message - .
  • ticket_expense - Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count - Обращения в поддержку. Количество "обращений в поддержку" списанных за запрос. При увеличении указанного количества будут списаны дополнительные "обращения", при уменьшении разница будет возвращена клиенту
  • show_abuse - . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score - Количество баллов. Количество баллов за нарушение
  • action - Действие. Укажите какое действие необходимо выполнить по достижению установленного срока устранения нарушения, в случае отсутствия реакции от клиента
  • deadline_date - Дата устранения нарушения. Срок устранения нарушения, дата
  • deadline_time - Время устранения нарушения. Срок устранения нарушения, время
  • score_note - Комментарий. Комментарий к нарушению

Добавить запрос в избранные и отслеживать историю по нему

Функция: ticket_all.favorite

Добавить запрос в избранные и отслеживать историю по нему

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции ticket_all.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить запрос из системы

Функция: ticket_all.delete

Удалить запрос из системы

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции ticket_all.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

ticket_all.filter

Модули

Функция: plugin

Уровень доступа: root admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

Изменение данных:

Список параметров или дополнительных параметров запроса (см.выше):

Страны

Функция: country

Результат: список элементов

Страны

Уровень доступа: admin

  • id - Id
  • locale_name - Наименование
  • iso2 - ISO2
  • phonecode - Телефонный код
  • status - Состояние

Страна

Функция: country.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Создание объекта:

Изменение объекта

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name - Наименование. Наименование страны
  • iso2 - ISO2. Двух или пяти-буквенный код страны или региона
  • phonecode - Телефонный код. Телефонный код страны
  • phoneformat - Формат номера телефона. Формат номера телефона задается при помощи маски, без указания телефонного кода. Символ '9' в маске обозначает цифру от 0 до 9. В квадратных скобках можно указать количество необязательных знаков. Например, при маске 99-99-9[9] телефон может состоять из пяти или из шести цифр без учета кода.
  • doctype - Типы документов. Типы документов доступные для компаний из этой страны

Наименование

Функция: country.state

Результат: список элементов

Регионы

Уровень доступа: admin

  • id - Id
  • locale_name - Наименование
  • iso - ISO код

Удалить

Функция: country.state.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции country.state.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование региона

Функция: country.state.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid - уникальный идентификатор родительского списка (элемент id из функции country).
    • elid - уникальный идентификатор (элемент id из функции country.state)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции country).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok - значение параметра должно быть не пустым, обычно "ok".
    • plid - уникальный идентификатор родительского списка (элемент id из функции country).
    • elid - уникальный идентификатор (элемент id из функции country.state)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):


  • name - Наименование. Наименование региона
  • iso - ISO код. ISO код региона

Выключить

Функция: country.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции country.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: country.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент id из функции country.

Результат: успеш