Методы группы cluster внешнего программного интерфейса менеджера сервиса предназначены для выполнения различных действий с кластерами серверов 1С:Предприятия, используемых облачным сервисом Фреш.
Сводка по методам
| Метод | Назначение |
|---|---|
| cluster/delete | Удаляет кластер |
| cluster/info | Информация о кластере сервера 1С:Предприятия |
| cluster/list | Получает список кластеров |
| cluster/update | Изменяет кластер |
| cluster/create | Создает кластер |
cluster/delete
Удаляет кластер
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| id | Строка переменная (9) | Код элемента | 000000007 |
| deletion_mark | Булево | Пометка удаления | false |
| Ответ | |||
| Нет параметров | |||
cluster/info
Информация о кластере сервера 1С:Предприятия
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| id | Строка переменная (9) | Код кластера | 000000001 |
| Ответ | |||
| id * | Строка переменная (9) | Код кластера | 000000001 |
| name * | Строка переменная (25) | Наименование кластера | Кластер |
| deletion_mark * | Булево | Пометка удаления | false |
| platform * | Строка переменная (18) | Версия платформы 1С:Предприятие, используемая кластером | 8.3.13.1809 |
| host_name * | Строка переменная (255) | Адрес центрального сервера кластера | ServerName |
| main_port * | Число (+5.0) | Номер основного IP-порта менеджера кластера | 1541 |
cluster/list
Получает список кластеров
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| filter * | Отбор элементов | ||
| - key | Строка (перечисление) | Поле отбора:
| name |
| - value | Строка переменная (150) | Значение отбора | 1cfresh |
| Ответ: list (0..*) | |||
| id | Строка переменная (9) | Код элемента | 000000007 |
| deletion_mark | Булево | Пометка удаления | false |
| name | Строка переменная (25) | Наименование кластера | srv.tests.ru |
| segment_id | Строка переменная (9) | Код сегмента сервиса | 000000013 |
| work_server_id | Строка переменная (9) | Код центрального сервера | 000000007 |
| main_port * | Число (+5.0) | Порт главного менеджера кластера | 1541 |
| platform | Строка переменная (18) | Версия платформы 1С:Предприятие | 8.3.27.1606 |
| connection_type * | Строка (перечисление) | Способ подключения:
| RAS |
| ras_id * | Строка переменная (9) | Код сервера администрирования | 000000017 |
| login * | Строка переменная (50) | Имя администратора кластера | admin |
| password * | Строка переменная (50) | Пароль администратора кластера | 123Qwer |
| event_log_settings * | Настройки журнала регистрации | ||
| - reduce_size * | Булево | Выполнять сокращение | true |
| - work_server_id * | Строка переменная (9) | Код сервера с сервисом ЖР | 000000007 |
| - max_size * | Число (+15.0) | Максимальный размер | 1024 |
| - size_after_reduction * | Число (+15.0) | Размер после сокращения | 100 |
| - delete_data_to_reduce * | Булево | Удалять сокращенные данные | true |
| - arch_common_dir_win * | Строка неограниченной длины | Общий каталог архивов журналов регистрации Windows | C:\event_logs |
| - arch_common_dir_lin * | Строка неограниченной длины | Общий каталог архивов журналов регистрации Linux | /event_logs |
| - detailed_settings | Список (0..*) | Детальные настройки | |
| - detailed_settings.infobase_id | Число (+9.0) | Код информационной базы | 13 |
| - detailed_settings.min_store_period * | Число (+10.0) | Код информационной базы | 30 |
| - detailed_settings.max_size * | Число (+15.0) | Максимальный размер | 1024 |
| - detailed_settings.size_after_reduction * | Число (+15.0) | Размер после сокращения | 100 |
| - detailed_settings.delete_data_to_reduce * | Булево | Удалять сокращенные данные | true |
| host_name * | Строка переменная (255) | Адрес центрального сервера | srv.tests.ru |
cluster/update
Изменяет кластер
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| id | Строка переменная (9) | Код элемента | 000000007 |
| name * | Строка переменная (25) | Наименование кластера | srv.tests.ru |
| segment_id * | Строка переменная (9) | Код сегмента сервиса | 000000013 |
| work_server_id * | Строка переменная (9) | Код центрального сервера | 000000007 |
| main_port * | Число (+5.0) | Порт главного менеджера кластера | 1541 |
| platform * | Строка переменная (18) | Версия платформы 1С:Предприятие | 8.3.27.1606 |
| connection_type * | Строка (перечисление) | Способ подключения:
| RAS |
| ras_id * | Строка переменная (9) | Код сервера администрирования | 000000017 |
| login * | Строка переменная (50) | Имя администратора кластера | admin |
| password * | Строка переменная (50) | Пароль администратора кластера | 123Qwer |
| event_log_settings * | Настройки журнала регистрации | ||
| - reduce_size * | Булево | Выполнять сокращение | true |
| - work_server_id * | Строка переменная (9) | Код сервера с сервисом ЖР | 000000007 |
| - max_size * | Число (+15.0) | Максимальный размер | 1024 |
| - size_after_reduction * | Число (+15.0) | Размер после сокращения | 100 |
| - delete_data_to_reduce * | Булево | Удалять сокращенные данные | true |
| - arch_common_dir_win * | Строка неограниченной длины | Общий каталог архивов журналов регистрации Windows | C:\event_logs |
| - arch_common_dir_lin * | Строка неограниченной длины | Общий каталог архивов журналов регистрации Linux | /event_logs |
| - detailed_settings * | Детальные настройки | ||
| - detailed_settings.infobase_id | Число (+9.0) | Код информационной базы | 13 |
| - detailed_settings.min_store_period * | Число (+10.0) | Код информационной базы | 30 |
| - detailed_settings.max_size * | Число (+15.0) | Максимальный размер | 1024 |
| - detailed_settings.size_after_reduction * | Число (+15.0) | Размер после сокращения | 100 |
| - detailed_settings.delete_data_to_reduce * | Булево | Удалять сокращенные данные | true |
| Ответ | |||
| id | Строка переменная (9) | Код элемента | 000000007 |
| updated * | Булево | Элемент изменен | true |
| created * | Булево | Создан новый элемент | false |
| change_list | Список (0..*) | Список изменений | |
| - name | Строка переменная (255) | Имя поля | name |
| - value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево, Уникальный идентификатор, Двоичные данные неограниченного размера в строке Base64, Массив, Структура | Установленное значение | Кластер 1 |
| - old_value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево, Уникальный идентификатор, Двоичные данные неограниченного размера в строке Base64, Массив, Структура | Прежнее значение | Кластер |
cluster/create
Создает кластер
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| name | Строка переменная (25) | Наименование кластера | srv.tests.ru |
| segment_id | Строка переменная (9) | Код сегмента сервиса | 000000013 |
| work_server_id | Строка переменная (9) | Код центрального сервера | 000000007 |
| main_port * | Число (+5.0) | Порт главного менеджера кластера | 1541 |
| platform | Строка переменная (18) | Версия платформы 1С:Предприятие | 8.3.27.1606 |
| connection_type * | Строка (перечисление) | Способ подключения:
| RAS |
| ras_id * | Строка переменная (9) | Код сервера администрирования | 000000017 |
| login * | Строка переменная (50) | Имя администратора кластера | admin |
| password * | Строка переменная (50) | Пароль администратора кластера | 123Qwer |
| event_log_settings * | Настройки журнала регистрации | ||
| - reduce_size * | Булево | Выполнять сокращение | true |
| - work_server_id * | Строка переменная (9) | Код сервера с сервисом ЖР | 000000007 |
| - max_size * | Число (+15.0) | Максимальный размер | 1024 |
| - size_after_reduction * | Число (+15.0) | Размер после сокращения | 100 |
| - delete_data_to_reduce * | Булево | Удалять сокращенные данные | true |
| - arch_common_dir_win * | Строка неограниченной длины | Общий каталог архивов журналов регистрации Windows | C:\event_logs |
| - arch_common_dir_lin * | Строка неограниченной длины | Общий каталог архивов журналов регистрации Linux | /event_logs |
| - detailed_settings * | Детальные настройки | ||
| - detailed_settings.infobase_id | Число (+9.0) | Код информационной базы | 13 |
| - detailed_settings.min_store_period * | Число (+10.0) | Код информационной базы | 30 |
| - detailed_settings.max_size * | Число (+15.0) | Максимальный размер | 1024 |
| - detailed_settings.size_after_reduction * | Число (+15.0) | Размер после сокращения | 100 |
| - detailed_settings.delete_data_to_reduce * | Булево | Удалять сокращенные данные | true |
| Ответ: id (1) | |||
| Нет параметров | |||