---
canonical: https://docs.ideco.ru/v22/ru/ngfw/api/vce-api
---



# VCE

::: page-constructor
blocks:
  - type: content-layout-block
    textContent:
      buttons:
        - text: Классический VCE
          theme: action
          width: 'auto'
        - text: Документация
          theme: outlined
          url: https://docs.ideco.ru/v22/ru/ngfw/settings/server-management/vce
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::

{% cut "Получение списка VCE" %}

```
GET /vce/vces
```

**Ответ на успешный запрос:**

```json5
[
    {
    "id": "string",
    "name": "string",
    "enabled": true | false,
    "comment": "string",
    "type": "string",
    "cpu_cores": "integer" | null,
    "ram": "integer" | null,
    "virt_mgmt_addr": "string"
    }
]
```

* `id` - идентификатор VCE;
* `name` - название VCE, максимальная длина - 42 символов;
* `enabled` - статус VCE:
  * `true` - включен;
  * `false` - выключен.
* `comment` - комментарий, максимальная длина - 255 символов, может быть пустым;
* `type` - тип VCE, может быть `ngfw` или `vpp`. Нельзя изменить после создания VCE;
* `cpu_cores` - количество выделенных CPU для VCE в штуках, минимум `4`;
* `ram` - количество выделенной памяти для VCE в байтах, минимум `8589934592`;
* `virt_mgmt_addr` - IPv6-адрес для доступа к веб-интерфейсу VCE.

{% endcut %}


{% cut "Получение списка состояния VCE" %}

```
GET /vce/states
```

**Ответ на успешный запрос:**

```json5
[
    {
    "id": "string",
    "status": "string",
    "errors": ["string"],
    "cpu_consumption": "integer" | null,  
    "ram_consumption": "integer" | null
    }
]
```

* `id` - идентификатор VCE;
* `status` - состояние VCE:
  * `activating` - запускается;
  * `active` - работает;
  * `deactivating` - останавливается;
  * `inactive` - остановлен;
  * `failed` - произошла ошибка при запуске.
* `errors` - список ошибок, возникших у VCE. Может быть пустым;
* `cpu_consumption` - процент использования ресурсов CPU от общего числа логических ядер. Диапазон значений: от 0 до 100;
* `ram_consumption` - объем используемой оперативной памяти в байтах.

{% endcut %}

{% cut "Получение информации об объеме оперативной памяти и количестве логических ядер в системе" %}

```
GET /vce/system_info
```

**Ответ на успешный запрос:**

```json5
{
  "total": {
    "cpu": "integer",
    "ram": "integer"
  },
  "free": {
    "cpu": "integer",
    "ram": "integer"
  }
}
```

* `total` - общее количество ресурсов в системе:
  * `cpu` - число логических ядер процессора;
  * `ram` - объем оперативной памяти в байтах.
* `free` - количество свободных ресурсов:
  * `cpu` - число логических ядер процессора;
  * `ram` - объем оперативной памяти в байтах.

{% endcut %}

## Настройки VCE

{% cut "Создание VCE" %}

```
POST /vce/vces
```

**Json-тело запроса:**

```json5
{
    "name": "string",
    "enabled": true | false,
    "comment": "string",
    "type": "string",
    "cpu_cores": "integer" | null,
    "ram": "integer" | null
}
```

* `name` - название VCE, максимальная длина - 42 символов;
* `enabled` - статус VCE:
  * `true` - включен;
  * `false` - выключен.
* `comment` - комментарий, максимальная длина - 255 символов, может быть пустым;
* `type` - тип VCE, может быть `ngfw` или `vpp`. Нельзя изменить после создания VCE;
* `cpu_cores` - количество выделенных CPU для VCE в штуках, минимум `4`;
* `ram` - количество выделенной памяти для VCE в байтах, минимум `8589934592`.

**Ответ на успешный запрос:**

```json5
{
    "id": "string"
}
```

{% endcut %}

{% cut "Редактирование VCE" %}

```
POST /vce/vces/<id VCE>
```

**Json-тело запроса:**

```json5
{
    "name": "string",
    "enabled": true | false,
    "comment": "string",
    "type": "string",
    "cpu_cores": "integer" | null,
    "ram": "integer" | null
}
```

* `name` - название VCE, максимальная длина - 42 символов;
* `enabled` - статус VCE:
  * `true` - включен;
  * `false` - выключен.
* `comment` - комментарий, максимальная длина - 255 символов, может быть пустым;
* `type` - тип VCE, может быть `ngfw` или `vpp`. Нельзя изменить после создания VCE;
* `cpu_cores` - количество выделенных CPU для VCE в штуках, минимум `4`;
* `ram` - количество выделенной памяти для VCE в байтах, минимум `8589934592`.

**Ответ на успешный запрос:** 200 OK

{% endcut %}

{% cut "Удаление VCE" %}

```
DELETE /vce/vces/<id VCE>
```

**Ответ на успешный запрос:** 200 OK

{% endcut %}


<!-- https://stash.ideco.dev/projects/UTM/repos/vce-backend/browse/docs/api.md?at=refs%2Fheads%2F20_release --!>