Product SiteDocumentation Site

⁠Глава 44. PVE API

44.1. URL API
44.2. Аутентификация
44.2.1. Аутентификация с использованием билета
44.2.2. API-токены
44.3. Пример создания контейнера с использованием API
44.4. Утилита pvesh
PVE предоставляет REST API, использующий протокол HTTP поверх TLS (HTTPS). Основным форматом обмена данными является JSON. Структура параметров и ответов API описывается с помощью JSON Schema.
Утилита pvesh (см. ниже) предоставляет интерфейс командной строки для выполнения операций через API PVE.
HTTP-запрос включает следующие компоненты:
  • URL — адрес конечной точки API, к которой направляется запрос;
  • метод HTTP (GET, POST, PUT, PATCH или DELETE), определяющий тип операции;
  • заголовки HTTP, содержащие сведения об аутентификации, формате данных и другие служебные параметры;
  • тело запроса — данные, передаваемые серверу, если они необходимы для выполнения операции.

Примечание

При передаче параметров, содержащих специальные символы, может потребоваться URL-кодирование. Для этого можно использовать опцию --data-urlencode.
Методы HTTP определяют тип операции, выполняемой над ресурсом API:
  • GET — получение данных;
  • POST — выполнение операции, в том числе создание ресурса;
  • PUT — изменение ресурса или выполнение операции в соответствии с контрактом конечной точки;
  • DELETE — удаление ресурса;
  • PATCH — частичное изменение ресурса, если оно поддерживается конечной точкой.
Для передачи команд через REST API можно использовать утилиту curl.

Примечание

По мере роста числа пользователей и ВМ, API PVE может начать реагировать на изменения с задержкой.
Для решения этой проблемы нужно очистить /var/lib/rrdcached/, например, выполнив команду:
# find /var/lib/rrdcached -type f -mtime +5 -delete
Или, добавив соответствующее задание в crontab.

⁠44.1. URL API

API PVE использует протокол HTTPS. По умолчанию сервер API прослушивает порт 8006. Базовый URL API имеет следующий вид:
https://server:8006/api2/json/
Параметры запроса можно передавать следующими способами:
  • в URL — для конечных точек, поддерживающих параметры в пути или строке запроса;
  • в теле запроса с типом содержимого application/x-www-form-urlencoded — для методов POST и PUT.
В URL можно указать формат возвращаемых данных:
  • json — JSON;
  • extjs — JSON в структуре, совместимой с ExtJS;
  • html — HTML (иногда полезно для отладки);
  • text — обычный текст (иногда полезно для отладки);