Документация Clouden
Документация
/
Документация Clouden
/
Разработчику
/
Работа с API
/
Clouden API
/
Обработчики услуг (processing)
Добавить в избранное
Режим фокусировки
Документация
/
Документация Clouden
/
Разработчику
/
Работа с API
/
Clouden API
/
Обработчики услуг (processing)

Обработчики услуг (processing)

Обработчики услуг (processing)

Функция: processing

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

Обработчики услуг

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг.

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

Показать список обработчиков услуг

Функция: processing.show

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг.

Поддерживает фильтрацию, сортировку и пагинацию.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоНетid модуля для фильтрации списка.
nameСтрокаНетПоиск по наименованию. Поддерживается подстановочный знак *.
moduleСтрока (перечисление)НетФильтр по типу обработчика. Допустимые значения:
  • pmmanual — ручная обработка;
  • pmauto — без обработки;
  • pmispmgr6 — ISPmanager 6;
  • pmvmmgr6 — VMmanager 6;
  • pmdcimgr6 — DCImanager 6;
  • и другие.
statusФлагНетФильтр по состоянию: on — включён, off — выключен.
datacenterПоложительное целое числоНетФильтр по идентификатору дата-центра.
sortСтрокаНетИмя колонки для сортировки: name, module, status, orderpriority.
pagesizeПоложительное целое числоНетКоличество записей на странице результата.
startidxНеотрицательное целое числоНетСмещение первой записи для пагинации.

Создать модуль обработки

Функция: processing.add

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Создать.

Запускает мастер создания нового обработчика. Первый шаг — выбор типа продукта.

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

ПараметрТипОбязательныйЗначение
typeСтрока (перечисление)ДаТип продукта для привязки обработчика. Например:
  • colocation — размещение серверов;
  • vdc — виртуальный дата-центр;
  • dnshost — DNS хостинг;
  • certificate — SSL сертификат;
  • addition — модули ISPsystem;
  • soft — лицензии;
  • vhost — виртуальный хостинг;
  • vds — VPS;
  • paas — услуги платформы PaaS;
  • backupservice — резервное копирование;
  • game_server — игровой сервер;
  • s3storage — внешнее S3 хранилище;
  • и другие.
moduleСтрока (перечисление)ДаМодуль обработки. Допустимые значения:
  • pmmanual — ручная обработка;
  • pmauto — без обработки;
  • pmispmgr4 — ISPmanager 4;
  • pmispmgr5 — ISPmanager 5;
  • pmispmgr6 — ISPmanager 6;
  • pmvmmgr — VMmanager;
  • pmvmmgr6 — VMmanager 6;
  • pmdcimgr — DCImanager;
  • pmdcimgr6 — DCImanager 6;
  • pmvdsmgr — VDSmanager;
  • pmbillmgr — Clouden;
  • pmnic — RU-CENTER;
  • pmregru — REG.RU;
  • pmwebnames — WebNames;
  • pmthesslstore — The SSL Store;
  • pmopenstack — OpenStack;
  • pmvmware — VMware;
  • pmshellscripts — Shell-скрипты;
  • pmipmgr — IPmanager;
  • pmcephradosgw — Ceph S3;
  • pmpterodactyl — Pterodactyl;
  • pmddosguard — DDoS-GUARD;
  • и другие.

Просмотреть параметры модуля

Функция: processing.preview

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Просмотр.

Возвращает детальные данные модуля обработки, включая общие сведения, настройки, зависимости (тарифы, задачи, параметры, уведомления, узлы кластера).

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки.

Редактировать модуль обработки

Функция: processing.edit

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Просмотр → кнопка Изменить.

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

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоНетid модуля обработки для редактирования. Если не указан, будет создан новый.
datacenterПоложительное целое числоНетИдентификатор дата-центра.
nameСтрокаДаПроизвольное наименование обработчика для отображения в интерфейсе.
departmentПоложительное целое числоНетОтветственный отдел, на который будут назначаться задачи в случае необходимости.
orderpriorityПоложительное целое числоНетПриоритет обработчика.
no_postprolong_taskФлагНет

Не создавать задачу на продление. Если опция активна, продление услуги будет проходить без участия администратора платформы:

  • текущая операция не будет переводиться в ручную обработку;
  • задача не будет создаваться.
userecipeФлагНетИспользовать рецепты. Если опция активна, при заказе услуги можно указать рецепт.
openmodeСтрока (перечисление)НетСпособ ожидания окончания установки сервера. Допустимые значения:
  • openmode_wait_ostempl — по завершении установки шаблона;
  • openmode_wait_recipe — по завершении установки рецепта.
licserverproviderФлагНетИспользовать сервер провайдера.
licserverПоложительное целое числоНетИдентификатор сервера лицензий.
sokСтрокаДаЗначение ok подтверждает сохранение изменений.

Удалить модуль обработки

Функция: processing.delete

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Удалить.

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

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

ПараметрТипОбязательныйЗначение
elidСтрока (список)ДаОдин или несколько id модулей через запятую. Например, 123,456.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Включить модуль обработки

Функция: processing.resume

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Включить.

Активирует выбранные модули обработки. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidСтрока (список)ДаОдин или несколько id модулей через запятую.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Выключить модуль обработки

Функция: processing.suspend

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Выключить.

Деактивирует выбранные модули обработки. Новые услуги не будут назначаться на выключенные модули.

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

ПараметрТипОбязательныйЗначение
elidСтрока (список)ДаОдин или несколько id модулей через запятую.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

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

Функция: processing.up

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Вверх.

Изменяет приоритет модуля обработки в списке. Модуль будет отображаться раньше в цепочке обработчиков.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля для перемещения.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

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

Функция: processing.down

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Вниз.

Изменяет приоритет модуля обработки. Модуль будет отображаться позже в цепочке обработчиков.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля для перемещения.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Обновить конфигурацию модуля

Функция: processing.updateconfig

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Конфиг.

Перезагружает конфигурацию модуля обработки. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля для обновления конфигурации.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

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

Функция: processing.filter

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → меню Фильт.

Условия фильтра сохраняются и применяются ко всем последующим вызовам processing.show до изменения или сброса фильтра.

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

ПараметрТипОбязательныйЗначение
nameСтрокаНетЗначение фильтра по наименованию. Поддерживается подстановочный знак *.
moduleСтрока (перечисление)НетФильтр по типу обработчика.
statusФлагНетФильтр по состоянию: on / off.
resetФлагНетЗначение on сбрасывает все установленные фильтры.

Перейти в панель управления модуля

Функция: processing.gotomoduleserver

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Перейти.

Возвращает ссылку для перехода в контекст панели управления или внешнего сервиса, связанного с модулем обработки.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки, для которого необходимо получить ссылку перехода.

Тарифы модулей обработки

Показать тарифы, обрабатываемые модулем

Функция: processing.pricelist

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Тарифы.

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

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки.
nameСтрокаНетПоиск по наименованию тарифа. Поддерживается подстановочный знак *.
statusФлагНет

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

  • on — используется для обработки новых услуг;
  • off — выключен.
sortСтрокаНетИмя колонки для сортировки: name, status.
pagesizeПоложительное целое числоНетКоличество записей на странице результата.
startidxНеотрицательное целое числоНетСмещение первой записи для пагинации.

Включить обработку для тарифа

Функция: processing.pricelist.resume

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Тарифы → кнопка Вкл.

Активирует обработку новых услуг для выбранных тарифов. 

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

ПараметрТипОбязательныйЗначение
elidСтрока (список)ДаОдин или несколько id тарифов через запятую.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Выключить обработку для тарифа

Функция: processing.pricelist.suspend

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

В веб-интерфейсе платформы: Интеграция → Обработчики услуг → кнопка Тарифы → кнопка Выкл.

Деактивирует обработку новых услуг для выбранных тарифов. Существующие услуги продолжают обслуживаться. 

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

ПараметрТипОбязательныйЗначение
elidСтрока (список)ДаОдин или несколько id тарифов через запятую.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Импорт услуг для обработчика

Показать список услуг для импорта

Функция: processing.import

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Импорт.

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

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки.
item_nameСтрокаНетПоиск по наименованию услуги. Поддерживается подстановочный знак *.
accountПоложительное целое числоНетФильтр по идентификатору клиента.
statusСтрока (перечисление)НетФильтр по статусу услуги. Допустимые значения:
  • 0 — неизвестен;
  • 1 — заказан;
  • 2 — активен;
  • 3 — остановлен;
  • 4 — удален;
  • 5 — обрабатывается.
sortСтрокаНетИмя колонки для сортировки: item_name, expiredate, account, status.
pagesizeПоложительное целое числоНетКоличество записей на странице результата.
startidxНеотрицательное целое числоНетСмещение первой записи для пагинации.

Загрузить список услуг для импорта

Функция: processing.import.load

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Импорт → кнопка Загрузить.

Получает список услуг из панели управления или от провайдера услуг для последующего импорта в Clouden.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки.
itemtypeСтрока (перечисление)НетТип услуг для импорта.
searchСтрокаНетУсловие поиска услуг. Для импорта конкретной услуги введите часть её наименования или доменное имя. Оставьте поле пустым для загрузки всех услуг.

Назначить услугу клиенту

Функция: processing.import.assign

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Импорт → кнопка Назначить.

Привязывает импортированную услугу к клиенту в Clouden. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid услуги для назначения.
accountПоложительное целое числоДаИдентификатор клиента, к которому привязывается услуга.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Удалить услуги из списка импорта

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

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Импорт → кнопка Удалить.

Удаляет выбранные услуги из списка импорта. Не удаляет услуги в панели управления или у провайдера. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidСтрока (список)ДаОдин или несколько id услуг через запятую.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Очистить список импорта услуг

Функция: processing.import.clear

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Импорт → кнопка Очистить.

Удаляет все услуги из списка импорта. Не удаляет услуги в панели управления или у провайдера. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Показать профили услуг для импорта

Функция: processing.import.service_profile

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

Возвращает список профилей контактов, связанных с импортируемыми услугами (для доменных услуг).

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid услуги для просмотра профилей.

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

Функция: service_profile.edit

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

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

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоНетid профиля для редактирования. Если не указан — создание нового.
plidПоложительное целое числоДаid родительской услуги из функции processing.import.
nameСтрокаНетНазвание профиля для упрощения идентификации в списке.
profiletypeСтрока (перечисление)НетЮридический статус контакта.
sokСтрокаДаЗначение ok подтверждает сохранение изменений.

Показать параметры модуля обработки

Функция: processing.customparam

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

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

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки.

Редактировать параметр модуля

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

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

Функция используется для просмотра и изменения пользовательских параметров модуля обработки.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоНетid параметра для редактирования. Если не указан — создание нового.
plidПоложительное целое числоДаid родительского модуля из функции processing.
paramСтрокаНетТип параметра.
valueСтрокаНетЗначение параметра.
sokСтрокаДаЗначение ok подтверждает сохранение изменений.

Удалить параметры модуля

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

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

Удаляет выбранные пользовательские параметры модуля обработки. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidСтрока (список)ДаОдин или несколько id параметров через запятую.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Установить фильтр по параметрам модуля

Функция: processing.customparam.filter

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

Фильтр параметров обработчика. Условия фильтра сохраняются и применяются ко всем последующим вызовам processing.customparam до изменения или сброса фильтра.

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

ПараметрТипОбязательныйЗначение
paramСтрокаНетФильтр по имени параметра.
valueСтрокаНетФильтр по значению параметра.
resetФлагНетЗначение on сбрасывает все установленные фильтры.

Обнаружение виртуальных машин

Показать результаты обнаружения ВМ

Функция: processing.autodiscovering.entry

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Обнаружение.

Отображает список виртуальных машин, обнаруженных во внешней системе (например, VMmanager 6), но ещё не привязанных к услугам в Clouden.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки. Например, VMmanager 6.
external_nameСтрокаНетПоиск по наименованию ВМ во внешней системе.
ownerСтрокаНетФильтр по владельцу ВМ. Для отбора используется email пользователя.
account_foundФлагНет

Фильтр по наличию привязки к клиенту:

  • on — пользователь найден;
  • off — не найден.
lost_itemФлагНетФильтр по отсутствию услуги в Clouden: on — ВМ отсутствует в системе.
sortСтрокаНетИмя колонки для сортировки: external_name, owner, ip, state.
pagesizeПоложительное целое числоНетКоличество записей на странице результата.
startidxНеотрицательное целое числоНетСмещение первой записи для пагинации.

Запустить обнаружение ВМ

Функция: processing.autodiscovering.start

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Обнаружение → кнопка Запустить.

Инициирует процесс сканирования внешней системы (например, VMmanager 6) для поиска виртуальных машин, которые могут быть импортированы в Clouden. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid модуля обработки.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Назначить обнаруженную ВМ клиенту

Функция: processing.autodiscovering.entry.assign

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Обнаружение → кнопка Назначить.

Привязывает обнаруженную виртуальную машину к клиенту в Clouden и создаёт соответствующую услугу. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid записи обнаружения.
accountПоложительное целое числоДаИдентификатор клиента для привязки.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Показать метаданные обнаруженной ВМ

Функция: processing.autodiscovering.entry.metadata

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Обнаружение → кнопка Информация. 

Возвращает детальные технические параметры виртуальной машины, полученные от внешней системы.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid записи обнаружения.

Удалить запись обнаружения

Функция: processing.autodiscovering.entry.delete.confirm

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Обнаружение → кнопка Удалить.

Удаляет запись обнаруженной ВМ из списка. Не удаляет саму виртуальную машину во внешней системе. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid записи обнаружения.
sokСтрокаДаЗначение ok подтверждает выполнение операции.

Восстановить запись обнаружения

Функция: processing.autodiscovering.entry.restore

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

В веб-интерфейсе платформы: раздел Интеграция → Обработчики услуг → кнопка Обнаружение → кнопка Восстановить.

Запускает процесс пересоздания виртуальной машины во внешней системе на основе данных услуги Clouden. Требуется подтверждение через параметр sok.

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

ПараметрТипОбязательныйЗначение
elidПоложительное целое числоДаid записи обнаружения.
sokСтрокаДаЗначение ok подтверждает выполнение операции.