Deis项目Controller API v1.2详解指南

Deis项目Controller API v1.2详解指南

deis Deis v1, the CoreOS and Docker PaaS: Your PaaS. Your Rules. 项目地址: https://gitcode.com/gh_mirrors/de/deis

概述

Deis是一个开源的PaaS平台，它简化了应用程序的部署和管理过程。Controller是Deis的核心组件之一，负责处理API请求并协调其他组件的工作。本文将详细介绍Deis Controller API v1.2版本的功能和使用方法。

API新特性

v1.2版本引入了/certs端点，用于管理自定义域名的SSL证书。这一功能使得用户可以更方便地为应用配置HTTPS安全连接。

认证机制

用户注册

要使用Deis API，首先需要注册一个用户账号。注册时需要提供以下必填信息：

• 用户名
• 密码
• 电子邮箱

可选信息包括：

• 名字
• 姓氏

注册请求示例：

POST /v1/auth/register/
{
    "username": "test",
    "password": "opensesame",
    "email": "test@example.com"
}

成功注册后，系统会返回用户详细信息，包括创建时间、最后登录时间等。

用户登录

登录API用于获取访问令牌，后续所有API请求都需要在Header中包含此令牌。

登录请求示例：

POST /v1/auth/login/
{"username": "test", "password": "opensesame"}

成功登录后，系统会返回一个token，格式如下：

{"token": "abc123"}

注销账号

用户可以通过API删除自己的账号，此操作不可逆。

请求示例：

DELETE /v1/auth/cancel/

应用管理

应用列表

获取当前用户的所有应用列表：

GET /v1/apps

返回结果包含应用ID、所有者、创建时间、访问URL等信息。

创建应用

创建新应用时可以指定应用ID，如果不指定，系统会自动生成一个。

请求示例：

POST /v1/apps/
{"id": "example-go"}

删除应用

删除指定ID的应用：

DELETE /v1/apps/example-go/

应用详情

获取指定应用的详细信息：

GET /v1/apps/example-go/

应用日志

查看应用的运行日志：

GET /v1/apps/example-go/logs/

执行一次性命令

在应用容器中执行一次性命令并获取结果：

POST /v1/apps/example-go/run/
{"command": "echo hi"}

证书管理

证书列表

获取所有已配置的SSL证书：

GET /v1/certs

证书详情

查看特定域名的证书详情：

GET /v1/certs/test.example.com

添加证书

上传新的SSL证书：

POST /v1/certs/
{
    "certificate": "-----BEGIN CERTIFICATE-----",
    "key": "-----BEGIN RSA PRIVATE KEY-----"
}

删除证书

移除指定域名的证书：

DELETE /v1/certs/test.example.com

容器管理

容器列表

查看应用的所有容器：

GET /v1/apps/example-go/containers/

按类型查看容器

查看特定类型（如web）的容器：

GET /v1/apps/example-go/containers/web/

容器扩缩容

调整容器数量：

POST /v1/apps/example-go/scale/
{"web": 3}

配置管理

查看配置

获取应用的当前配置：

GET /v1/apps/example-go/config/

更新配置

添加或修改配置变量：

POST /v1/apps/example-go/config/
{"values": {"HELLO": "world", "PLATFORM": "deis"}}

删除配置

移除配置变量：

POST /v1/apps/example-go/config/
{"values": {"HELLO": null}}

域名管理

域名列表

查看应用绑定的所有域名：

GET /v1/apps/example-go/domains/

添加域名

为应用绑定新域名：

POST /v1/apps/example-go/domains/
{'domain': 'example.example.com'}

移除域名

解绑指定域名：

DELETE /v1/apps/example-go/domains/example.example.com

构建管理

构建列表

查看应用的所有构建记录：

GET /v1/apps/example-go/builds/

创建构建

基于Docker镜像创建新构建：

POST /v1/apps/example-go/builds/
{"image": "deis/example-go:latest"}

发布管理

发布列表

查看应用的所有发布版本：

GET /v1/apps/example-go/releases/

发布详情

查看特定版本的发布详情：

GET /v1/apps/example-go/releases/v1/

总结

Deis Controller API v1.2提供了完整的应用生命周期管理功能，从用户认证到应用部署、配置管理、域名绑定等各个环节。通过RESTful风格的API，开发者可以轻松地将Deis集成到自己的开发流程中，实现自动化部署和管理。

deis Deis v1, the CoreOS and Docker PaaS: Your PaaS. Your Rules. 项目地址: https://gitcode.com/gh_mirrors/de/deis