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

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

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

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

cluster/list

Список используемых в сервисе кластеров сервера 1С:Предприятия

Параметр	Тип	Описание	Пример
Запрос
host_name *	Строка переменная (255)	Адрес центрального сервера кластера	ServerName
main_port *	Число (+5.0)	Номер основного IP-порта менеджера кластера	1541
Ответ: list (1..*)
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/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

Пример ответа Развернуть

{
  "list": [
    {
      "id": "000000001",
      "name": "Кластер",
      "deletion_mark": false,
      "platform": "8.3.13.1809",
      "host_name": "ServerName",
      "main_port": 1541
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

cluster/update

Изменить информацию о кластере сервера 1С:Предприятия

Параметр	Тип	Описание	Пример
Запрос
id	Строка переменная (9)	Код кластера	000000001
name *	Строка переменная (25)	Наименование кластера	Кластер 1
platform *	Строка переменная (18)	Версия платформы 1С:Предприятие, используемая кластером	8.3.13.1809
Ответ
id	Строка переменная (9)	Код кластера	000000001
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": "000000001",
  "name": "Кластер 1",
  "platform": "8.3.13.1809"
}

Пример ответа Развернуть

{
  "id": "000000001",
  "updated": true,
  "created": false,
  "change_list": [
    {
      "name": "name",
      "value": "Кластер 1",
      "old_value": "Кластер"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "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": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх