Начало работы
Быстрый старт
Используйте эту страницу, если нужен кратчайший и надёжный путь от API key до созданной виртуальной машины. Ниже описан workflow-уровень, а для точных схем запросов и ответов используйте generated reference.
Предварительные условия
- API key, выданный в личном кабинете.
Клиент, который умеет отправлять HTTPS-запросы с заголовком
X-API-Key.- Известные идентификаторы образа и тарифа, либо возможность сначала запросить их через API.
Проверка подключения
Перед провижинингом убедитесь, что base URL и API key принимаются API.
curl --request GET \
--url 'https://client-api.dc.dev.k8s.zenno.services/projects' \
--header 'X-API-Key: <api-key>' \
--header 'Accept: application/json'
- 1
Получите список доступных вариантов провижининга
Сначала запросите configurations, images и tariffs. Эти ответы дадут идентификаторы, которые будут нужны в payload создания VM.
- 2
Создайте проект
Проекты задают scope для VM, SSH-ключей, сетей и публичных IP-ресурсов. Создайте проект заранее и используйте его идентификатор в дальнейших вызовах.
- 3
Подготовьте входные данные доступа
Решите, будет ли VM получать raw
sshPublicKeysпрямо в запросе создания или существующие project-levelsshKeyIds. - 4
Создайте VM
Отправьте запрос с образом, тарифом, именем и данными доступа. При необходимости в том же payload можно указать поведение публичного IP и подключения к приватным сетям.
- 5
Проверьте VM-ресурс
Создание VM возвращает command identifier. После этого получите сам VM-ресурс, чтобы проверить текущее состояние, сетевые интерфейсы и дальнейшие действия.
Ожидаемый результат
После прохождения последовательности у вас должны быть идентификатор проекта, идентификатор VM и понятный набор параметров доступа, таких как SSH-ключи и сетевые привязки.
Типичные проблемы
Используйте идентификаторы из реальных ответов API, а не значения из примеров. Большинство первых ошибок интеграции
связаны с устаревшими projectId, imageId или tariffId, либо с отсутствующим
заголовком API key.
Связанные endpoint
/configurationsСписок доступных конфигурационных профилей VM.
/imagesСписок доступных базовых образов для провижининга.
/tariffsСписок тарифов, которые можно применить к VM.
/projectsСоздание проекта, которому будет принадлежать VM.
/projects/{projectId}/vmsСоздание самой виртуальной машины.
/projects/{projectId}/vms/{vmId}Получение VM-ресурса и проверка текущего состояния.