SUSE Studio API

Перейти к: навигация, поиск

Info-orange.png Важно

Нижеследующая информация неполная! Полная документация может быть найдена в SUSE Studio.


RESTful API

SUSE Studio предоставляет RESTful API по протоколу HTTP. С использованием этого API можно клонировать программные комплексы, загружать файлы, триггеры, мониторировать сборки и даже больше.


Аутентификация

В порядке использования API вы создадите специальный ключ, который затем будет испольозваться как пароль для HTTP Basic Authentication. Это может быть сделано здесь.


Использование API с curl

Все функции API могут быть использованы с curl. Нижеследующие примеры должны подать вам идею, как использовать такую возможность.

Получение списка набора шаблонов

Все доступные шаблоны сгруппированы в наборы. Следующая команда получает список набора шаблонов из Studio:

 curl -u <user>:<api_key> "http://susestudio.com/api/v1/user/template_sets" (пример)

Обычно вы выбираете один из шаблонов стандартного набора, отражающего список стандартных шаблонов SUSE Studio, и копируете прогарммный комплекс из него.

Список ваших программных комплексов

Все программные комплексы:

 curl -u <user>:<api_key> "http://susestudio.com/api/v1/user/appliances" (пример)


Конкретный программный комплекс:

 curl -u <user>:<api_key> "http://susestudio.com/api/v1/user/appliances/<id>" (пример)


Копирование программного комплекса

Чтобы создать новый программный комплекс, выберите шаблон из нужного набора и используйте его идентификатор со следующими командами (имя и архитектура являются опциональными паарметрами):

 curl -u <user>:<api_key> -XPOST "http://susestudio.com/api/v1/user/appliances?clone_from=14774&name=My%20Server&arch=x86_64"

Управление перекрывающими файлами

Список файлов программного комплекса:

 curl -u <user>:<api_key> "http://susestudio.com/api/v1/user/files?appliance_id=<id>" (пример)


Загрузка файла:

 curl -u <user>:<api_key> -XPOST -F "file=@/path/to/your/file" "http://susestudio.com/api/v1/user/files?appliance_id=<id>" (пример)

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


Сборка программного комплекса

Начните сборку вашего программного комплекса:

 curl -u <user>:<api_key> -XPOST "http://susestudio.com/api/v1/user/running_builds?appliance_id=<id>"

Отслеживайте процесс сборки:

 curl -u <user>:<api_key> "http://susestudio.com/api/v1/user/running_builds?appliance_id=<id>" (пример)