The wikis are now using the new authentication system.
If you did not migrate your account yet, visit https://idp-portal-info.suse.com/

SUSE Studio API

Jump to: navigation, search

Suse studio logo.png    Portal 开始    FAQ 常问问题 FAQ    Tour 速览    Howto 入门帮助教程     API API 接口    反馈,Bug 和已知问题 Bug    支持信息页面 SUSE Studio 交流频道    下载应用以及其他东西 下载    Display index of "Category: SUSE Studio" 目录索引    How to edit this documentation 如何编辑此文档


Info-orange.png 重要

下面的信息是不完整的!完整文档可以在此获取: SUSE Studio


RESTful API 接口

SUSE Studio 配备了一个基于HTTP协议的 RESTful API 接口,用于克隆应用,上传文件,触发并监控构建过程甚至更多。


认证

为了使用 API接口,您必须创建 API 密钥用作HTTP基本认证密码,该步骤可以在 该页面 完成。


与 curl 一起使用 API

所有 API 功能都能够同 curl 一并使用。下面的例子将使您对使用方法有一个大体的了解。

获取模板集列表

可供使用的模板以模板集分组。下面的命令行从Studio 获取模板集列表:

 curl -u <user>:<api_key> "http://susestudio.com/api/v1/user/template_sets" (example)

通常您会随意选用 '默认' 模板集中的一个模板,这个模板集列出了默认的 SUSE 模板,并从中克隆出一个应用。

列出您的应用

所有应用:

 curl -u <user>:<api_key> "http://susestudio.com/api/v1/user/appliances" (example)


某个指定应用:

 curl -u <user>:<api_key> "http://susestudio.com/api/v1/user/appliances/<id>" (example)


克隆一个应用

下列命令(名字和构架是可选参数)通过从模板集中选取模板来创建新的应用并使用其 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>" (example)


上传文件:

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

作为可选项,您可以在此指定文件名,路径,拥有者,组或权限。


构建您的应用

触发一个应用的构建:

 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>" (example)