Web_server — действия с веб-серверами сервиса Фреш

Методы группы web_server внешнего программного интерфейса менеджера сервиса предназначены для выполнения различных действий с веб-серверами, на которых выполняются публикации информационных баз сервиса Фреш.

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

МетодНазначение
web_server/createСоздает веб-сервер
web_server/deleteУдаляет веб-сервер
web_server/listПолучает список веб-серверов
web_server/updateИзменяет веб-сервер

web_server/create

Создает веб-сервер

ПараметрТипОписаниеПример
Запрос
nameСтрока переменная (64)Наименование веб-сервераweb main
addressСтрока переменная (255)Адресweb.domain.main
portЧисло (+5.0)Порт8080
type *Строка (перечисление)Вид веб-сервера:
  • apache2
  • apache22
  • apache24
  • iis
apache24
executor_server_id *Число (+9.0)Код сервера исполнителя скриптов1
publication_path *Строка переменная (1024)Расположение публикаций/var/www/fresh
config_path *Строка переменная (1024)Расположение подключаемых конфигурационных файлов публикаций/etc/apache2/paas-base
platform_exec_path *Строка переменная (1024)Расположение исполняемых файлов платформы 1С:Предприятия/opt/1c
Ответ: id (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/web_server/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "name": "web main",
  "address": "web.domain.main",
  "port": 8080,
  "type": "apache24",
  "executor_server_id": 1,
  "publication_path": "/var/www/fresh",
  "config_path": "/etc/apache2/paas-base",
  "platform_exec_path": "/opt/1c"
}
Пример ответа  Развернуть
{
  "id": 7,
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

web_server/delete

Удаляет веб-сервер

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

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

Вверх

web_server/list

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

ПараметрТипОписаниеПример
Запрос
filter *
Отбор элементов
  - keyСтрока (перечисление)Поле отбора:
  • address
  • name
  • type
name
  - valueСтрока переменная (150)Значение отбора1cfresh
Ответ: list (0..*)
idЧисло (+9.0)Код элемента7
deletion_markБулевоПометка удаленияfalse
nameСтрока переменная (64)Наименование веб-сервераweb main
addressСтрока переменная (255)Адресweb.domain.main
portЧисло (+5.0)Порт8080
type *Строка (перечисление)Вид веб-сервера:
  • apache2
  • apache22
  • apache24
  • iis
apache24
executor_server_id *Число (+9.0)Код сервера исполнителя скриптов1
publication_path *Строка переменная (1024)Расположение публикаций/var/www/fresh
config_path *Строка переменная (1024)Расположение подключаемых конфигурационных файлов публикаций/etc/apache2/paas-base
platform_exec_path *Строка переменная (1024)Расположение исполняемых файлов платформы 1С:Предприятия/opt/1c
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/web_server/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

Пример ответа  Развернуть
{
  "list": [
    {
      "id": 7,
      "deletion_mark": false,
      "name": "web main",
      "address": "web.domain.main",
      "port": 8080,
      "type": "apache24",
      "executor_server_id": 1,
      "publication_path": "/var/www/fresh",
      "config_path": "/etc/apache2/paas-base",
      "platform_exec_path": "/opt/1c"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

web_server/update

Изменяет веб-сервер

ПараметрТипОписаниеПример
Запрос
idЧисло (+9.0)Код элемента7
name *Строка переменная (64)Наименование веб-сервераweb main
address *Строка переменная (255)Адресweb.domain.main
port *Число (+5.0)Порт8080
type *Строка (перечисление)Вид веб-сервера:
  • apache2
  • apache22
  • apache24
  • iis
apache24
executor_server_id *Число (+9.0)Код сервера исполнителя скриптов1
publication_path *Строка переменная (1024)Расположение публикаций/var/www/fresh
config_path *Строка переменная (1024)Расположение подключаемых конфигурационных файлов публикаций/etc/apache2/paas-base
platform_exec_path *Строка переменная (1024)Расположение исполняемых файлов платформы 1С:Предприятия/opt/1c
Ответ: list (0..*)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/web_server/update
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 7,
  "name": "web main",
  "address": "web.domain.main",
  "port": 8080,
  "type": "apache24",
  "executor_server_id": 1,
  "publication_path": "/var/www/fresh",
  "config_path": "/etc/apache2/paas-base",
  "platform_exec_path": "/opt/1c"
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх