API概览

API 分组

No 分组 说明
1 用户管理 用户的注册，登录，token获取
2 容器管理 可以对集群所有k8s资源进行增删改查的操作
3 镜像管理 可以连接镜像仓库，对镜像进行上传删除等操作

1. 用户管理

认证

API名称 描述
登录 登录后，获取令牌
登出 登出后，销毁令牌

2. 容器管理

集群

API名称 描述
查询集群 查询用户拥有的集群列表

命名空间

API名称 描述
查询命名空间列表 查询集群下所有命名空间列表
创建命名空间 创建命名空间及其资源配额
扩容命名空间 扩展指定命名空间资源配额
查询命名空间详情 查询集群下指定命名空间详情
删除命名空间 删除命名空间及其中所有资源

资源配额

API名称 描述
查询资源配额 查询资源配额
删除资源配额 删除资源配额

容器组

API名称 描述
查询容器组列表 查询指定命名空间下的Pod列表
创建容器组 创建容器组
查询容器组详情 查询指定命名空间下的容器组详情
删除容器组 删除容器组

无状态工作负载

API名称 描述
查询Deployment详情 查询指定命名空间下指定Deployment详情
修改Deployment 全量修改Deployment，用户提供改变后的完整数据
删除Deployment 删除Deployment
查询Deployment列表 查询指定命名空间下的Deployment列表
创建Deployment 创建Deployment
滚动更新 通过滚动更新策略发布新版本镜像
伸缩 调整Deployment副本数量

有状态工作负载

API名称 描述
查询StatefulSet详情 查询指定命名空间下的StatefulSet详情
修改StatefulSet 全量修改StatefulSet，用户提供改变后的完整数据
删除StatefulSet 删除StatefulSet
查询StatefulSet列表 查询指定命名空间下的StatefulSet列表
创建StatefulSet 创建StatefulSet
伸缩 调整StatefulSet副本数量

守护进程集

API名称 描述
查询DaemonSet详情 查询指定命名空间下的DaemonSet详情
修改DaemonSet 全量修改DaemonSet，用户提供改变后的完整数据
删除DaemonSet 删除DaemonSet
查询DaemonSet列表 查询指定命名空间下的DaemonSet列表
创建DaemonSet 创建DaemonSet

服务

API名称 描述
查询服务详情 查询服务(Service)详情
修改服务 全量修改服务(Service)，用户提供改变后的完整数据
删除服务 删除服务(Service)
查询服务列表 查询指定命名空间下的服务列表
创建服务 创建服务(Service)，Kubernetes 为 Pods 提供自己的 IP 地址，并为一组 Pod 提供相同的 DNS 名， 并且可以在它们之间进行负载均衡。

配置

API名称 描述
查询ConfigMap详情 查询指定命名空间下的ConfigMap详情
修改ConfigMap 全量修改ConfigMap，用户提供改变后的完整数据
删除ConfigMap 删除ConfigMap
查询ConfigMap列表 查询指定命名空间下的ConfigMap列表
创建ConfigMap 创建ConfigMap

密钥

API名称 描述
查询Secret详情 查询指定命名空间下的Secret详情
修改Secret 全量修改Secret
删除Secret 删除Secret
查询Secret列表 查询指定命名空间下的Secret列表
创建Secret 创建Secret

3. 镜像管理

镜像仓库

API名称 描述
查看镜像仓库详情 查看镜像仓库详情
修改镜像仓库 修改镜像仓库
删除镜像仓库 删除镜像仓库
查询镜像仓库 查询镜像仓库，按更新时间降序排列
创建镜像仓库 创建镜像仓库
连接镜像仓库 连接镜像仓库

组织

API名称 描述
查询组织 查询组织
创建组织 创建组织
查询组织详情 查询组织详情
删除组织 删除组织

镜像

API名称 描述
创建镜像(文件上传) 通过上传镜像文件，创建镜像，异步返回
创建镜像(文件URL) 通过指定镜像文件url地址(如:http://xxx.xxx/xxx/nginx.tar)创建镜像，异步返回
查询镜像上传记录 查询镜像上传记录
查询镜像同步记录 查询镜像同步记录
查询镜像 查询镜像
查询镜像详情 查询镜像详情
删除镜像 删除镜像
查询镜像版本 查询镜像版本
作者：魏巍  创建时间：2020-05-06 09:50
最后编辑：叶奕珺  更新时间：2025-04-29 18:46