Deis项目Controller API v1.3详解

Deis项目Controller API v1.3详解

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.3版本的功能和使用方法。

API v1.3新特性

v1.3版本引入了几个重要的新功能：

1. 新增了/users端点，用于列出所有用户
2. 改进了/logs端点，现在可以限制返回的日志行数
3. 增强了/certs端点，支持设置证书的通用名称(Common Name)
4. 新增了deis ps:restart相关端点，支持按应用、进程类型或进程ID重启进程

认证管理

用户注册

要注册新用户，需要发送POST请求到/v1/auth/register/端点：

{
    "username": "test",
    "password": "opensesame",
    "email": "test@example.com"
}

可选参数包括first_name和last_name。成功注册后，系统会返回包含用户详细信息的响应。

用户登录

登录请求需要发送到/v1/auth/login/端点：

{"username": "test", "password": "opensesame"}

成功登录后，系统会返回一个认证令牌(token)，后续API请求都需要在Header中包含这个令牌。

注销账户

要注销账户，发送DELETE请求到/v1/auth/cancel/端点，并在Header中包含认证令牌。

应用管理

应用列表

获取所有应用的列表：

GET /v1/apps HTTP/1.1
Authorization: token abc123

响应中包含应用的ID、所有者、创建时间、URL等基本信息。

创建应用

创建新应用：

POST /v1/apps/ HTTP/1.1
Authorization: token abc123

可以可选地指定应用ID，如果不指定，系统会自动生成一个。

应用详情

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

GET /v1/apps/example-go/ HTTP/1.1
Authorization: token abc123

删除应用

删除应用：

DELETE /v1/apps/example-go/ HTTP/1.1
Authorization: token abc123

应用日志

获取应用日志：

GET /v1/apps/example-go/logs/ HTTP/1.1
Authorization: token abc123

可以通过log_lines参数限制返回的日志行数。

执行一次性命令

在应用容器中执行一次性命令：

POST /v1/apps/example-go/run/ HTTP/1.1
Authorization: token abc123

{"command": "echo hi"}

证书管理

证书列表

获取所有证书：

GET /v1/certs HTTP/1.1
Authorization: token abc123

创建证书

上传新证书：

POST /v1/certs/ HTTP/1.1
Authorization: token abc123

{
    "certificate": "-----BEGIN CERTIFICATE-----",
    "key": "-----BEGIN RSA PRIVATE KEY-----",
    "common_name": "test.example.com"
}

删除证书

删除证书：

DELETE /v1/certs/test.example.com HTTP/1.1
Authorization: token abc123

容器管理

容器列表

获取应用的所有容器：

GET /v1/apps/example-go/containers/ HTTP/1.1
Authorization: token abc123

可以按类型筛选容器。

容器重启

支持多种重启方式：

• 重启所有容器
• 按类型重启容器
• 按类型和编号重启特定容器

容器伸缩

调整容器数量：

POST /v1/apps/example-go/scale/ HTTP/1.1
Authorization: token abc123

{"web": 3}

配置管理

获取配置

获取应用配置：

GET /v1/apps/example-go/config/ HTTP/1.1
Authorization: token abc123

设置配置

设置环境变量：

POST /v1/apps/example-go/config/ HTTP/1.1
Authorization: token abc123

{"values": {"HELLO": "world", "PLATFORM": "deis"}}

删除配置

删除环境变量：

POST /v1/apps/example-go/config/ HTTP/1.1
Authorization: token abc123

{"values": {"HELLO": null}}

域名管理

域名列表

获取应用绑定的域名：

GET /v1/apps/example-go/domains/ HTTP/1.1
Authorization: token abc123

添加域名

绑定新域名：

POST /v1/apps/example-go/domains/ HTTP/1.1
Authorization: token abc123

{'domain': 'example.example.com'}

删除域名

解绑域名：

DELETE /v1/apps/example-go/domains/example.example.com HTTP/1.1
Authorization: token abc123

构建管理

构建列表

获取应用的构建历史：

GET /v1/apps/example-go/builds/ HTTP/1.1
Authorization: token abc123

创建构建

触发新构建：

POST /v1/apps/example-go/builds/ HTTP/1.1
Authorization: token abc123

{"image": "deis/example-go:latest"}

总结

Deis Controller API v1.3提供了全面的应用管理功能，包括用户认证、应用部署、配置管理、日志查看、容器管理等。通过RESTful API，开发者可以轻松地将Deis集成到自己的开发流程中，实现自动化部署和管理。

掌握这些API的使用方法，可以帮助开发者更高效地使用Deis平台，提升应用部署和管理的效率。

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