Cluster — действия с кластерами серверов 1С:Предприятия

Методы группы cluster внешнего программного интерфейса менеджера сервиса предназначены для выполнения различных действий с кластерами серверов 1С:Предприятия, используемых облачным сервисом Фреш.

Сводка по методам

МетодНазначение
cluster/deleteУдаляет кластер
cluster/infoИнформация о кластере сервера 1С:Предприятия
cluster/listПолучает список кластеров
cluster/updateИзменяет кластер
cluster/createСоздает кластер

cluster/delete

Удаляет кластер

ПараметрТипОписаниеПример
Запрос
idСтрока переменная (9)Код элемента000000007
deletion_markБулевоПометка удаленияfalse
Ответ
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/cluster/delete
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000007",
  "deletion_mark": false
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/cluster/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000001"
}
Пример ответа  Развернуть
{
  "id": "000000001",
  "name": "Кластер",
  "deletion_mark": false,
  "platform": "8.3.13.1809",
  "host_name": "ServerName",
  "main_port": 1541,
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

cluster/list

Получает список кластеров

ПараметрТипОписаниеПример
Запрос
filter *
Отбор элементов
  - keyСтрока (перечисление)Поле отбора:
  • host_name
  • main_port
  • name
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 *Строка (перечисление)Способ подключения:
  • COM
  • RAS
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 *Строка неограниченной длиныОбщий каталог архивов журналов регистрации WindowsC:\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
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/cluster/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

Пример ответа  Развернуть
{
  "list": [
    {
      "id": "000000007",
      "deletion_mark": false,
      "name": "srv.tests.ru",
      "segment_id": "000000013",
      "work_server_id": "000000007",
      "main_port": 1541,
      "platform": "8.3.27.1606",
      "connection_type": "RAS",
      "ras_id": "000000017",
      "login": "admin",
      "password": "123Qwer",
      "event_log_settings": {
        "reduce_size": true,
        "work_server_id": "000000007",
        "max_size": 1024,
        "size_after_reduction": 100,
        "delete_data_to_reduce": true,
        "arch_common_dir_win": "C:\\event_logs",
        "arch_common_dir_lin": "/event_logs",
        "detailed_settings": [
          {
            "infobase_id": 13,
            "min_store_period": 30,
            "max_size": 1024,
            "size_after_reduction": 100,
            "delete_data_to_reduce": true
          }
        ]
      },
      "host_name": "srv.tests.ru"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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 *Строка (перечисление)Способ подключения:
  • COM
  • RAS
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 *Строка неограниченной длиныОбщий каталог архивов журналов регистрации WindowsC:\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, Массив, СтруктураПрежнее значениеКластер
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/cluster/update
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000007",
  "name": "srv.tests.ru",
  "segment_id": "000000013",
  "work_server_id": "000000007",
  "main_port": 1541,
  "platform": "8.3.27.1606",
  "connection_type": "RAS",
  "ras_id": "000000017",
  "login": "admin",
  "password": "123Qwer",
  "event_log_settings": {
    "reduce_size": true,
    "work_server_id": "000000007",
    "max_size": 1024,
    "size_after_reduction": 100,
    "delete_data_to_reduce": true,
    "arch_common_dir_win": "C:\\event_logs",
    "arch_common_dir_lin": "/event_logs",
    "detailed_settings": [
      {
        "infobase_id": 13,
        "min_store_period": 30,
        "max_size": 1024,
        "size_after_reduction": 100,
        "delete_data_to_reduce": true
      }
    ]
  }
}
Пример ответа  Развернуть
{
  "id": "000000007",
  "updated": true,
  "created": false,
  "change_list": [
    {
      "name": "name",
      "value": "Кластер 1",
      "old_value": "Кластер"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

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 *Строка (перечисление)Способ подключения:
  • COM
  • RAS
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 *Строка неограниченной длиныОбщий каталог архивов журналов регистрации WindowsC:\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)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/cluster/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "name": "srv.tests.ru",
  "segment_id": "000000013",
  "work_server_id": "000000007",
  "main_port": 1541,
  "platform": "8.3.27.1606",
  "connection_type": "RAS",
  "ras_id": "000000017",
  "login": "admin",
  "password": "123Qwer",
  "event_log_settings": {
    "reduce_size": true,
    "work_server_id": "000000007",
    "max_size": 1024,
    "size_after_reduction": 100,
    "delete_data_to_reduce": true,
    "arch_common_dir_win": "C:\\event_logs",
    "arch_common_dir_lin": "/event_logs",
    "detailed_settings": [
      {
        "infobase_id": 13,
        "min_store_period": 30,
        "max_size": 1024,
        "size_after_reduction": 100,
        "delete_data_to_reduce": true
      }
    ]
  }
}
Пример ответа  Развернуть
{
  "id": "000000007",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх