Введение в REST API

Менеджер управления включает Representational State Transfer (REST) API. API предоставляет разработчикам программного обеспечения и системным администраторам контроль над своей средой ПО «zVirt Max» за пределами стандартного веб-интерфейса. API полезен для интеграции функций среды ПО «zVirt Max» с пользовательскими сценариями или внешними приложениями, которые обращаются к API через стандартный протокол передачи гипертекста (HTTP).

Преимущества API

Широкая клиентская поддержка. Любой язык программирования, платформа или система с поддержкой протокола HTTP могут использовать API.
Самоописательный — клиентские приложения требуют минимальных знаний об инфраструктуре виртуализации, так как многие детали обнаруживаются во время выполнения.
Модель на основе ресурсов. Модель REST на основе ресурсов обеспечивает естественный способ управления платформой виртуализации.

Это дает разработчикам и администраторам возможность

Интеграции с корпоративными ИТ-системами.
Интеграции со сторонним программным обеспечением для виртуализации.
Выполнения автоматизированного обслуживания или проверки ошибок.
Автоматизации повторяющихся задач в среде ПО «zVirt Max» с помощью сценариев.

Эта документация служит справочником по API zVirt. Он предназначен для предоставления разработчикам и администраторам инструкций и примеров, которые помогут использовать функциональные возможности их среды ПО «zVirt Max» через API либо напрямую, либо с использованием предоставленных SDK.

1. REST

Representational State Transfer (REST) — это архитектура проектирования, ориентированная на ресурсы для конкретной службы и их представления. Представление ресурсов — это ключевая абстракция информации, которая соответствует одному конкретному управляемому элементу на сервере. Клиент отправляет запрос элементу сервера, расположенному по универсальному идентификатору ресурса (URI), и выполняет операции, используя стандартные методы HTTP, такие как GET, POST, PUT и DELETE. Это обеспечивает связь между клиентом и сервером без сохранения состояния, при которой каждый запрос действует независимо от любого другого запроса и содержит всю информацию, необходимую для выполнения запроса.

2. Предварительные требования к API

Предварительные требования для использования zVirt API:

Установка ПО «zVirt Max», включающая API.
Клиент или программная библиотека, которая инициирует и получает HTTP-запросы от сервера API. Например:
- SDK oVirt для Python
- SDK oVirt для Ruby
- SDK oVirt для Java
- Инструмент командной строки cURL
- RESTClient — отладчик для веб-служб RESTful
Знание протокола передачи гипертекста (HTTP), протокола, используемого для взаимодействия с REST API. Инженерная рабочая группа Интернета публикует запрос комментариев (RFC) с объяснением протокола передачи гипертекста.
Знание расширяемого языка разметки (XML) или нотации объектов JavaScript (JSON), которые API использует для создания представлений ресурсов. W3C предоставляет полную спецификацию XML. ECMA International предоставляет бесплатную публикацию по JSON.

Ссылки на инструменты, SDK и спецификации можно получить по заявке на портале технической поддержки.