api

Documentation

Index

• func Router(r *gin.Engine)
• type Api
  • func NewApi() *Api
  • func (api *Api) DeleteService(c *gin.Context)
  • func (api *Api) DeployOrUpdateService(c *gin.Context)
  • func (api *Api) GetProxyStats(c *gin.Context)
  • func (api *Api) GetService(c *gin.Context)
  • func (api *Api) GetServiceStatus(c *gin.Context)
  • func (api *Api) ListServices(c *gin.Context)
  • func (s *Api) Ping(c *gin.Context)
  • func (api *Api) ScaleService(c *gin.Context)

Functions

func Router

func Router(r *gin.Engine)

Types

type Api

type Api struct {
	// contains filtered or unexported fields
}

Api

func NewApi

func NewApi() *Api

NewApi

func (*Api) DeleteService

func (api *Api) DeleteService(c *gin.Context)

DeleteService 删除服务 @Summary 删除指定服务 @Description 删除指定的服务及其所有相关容器和资源，操作不可逆 @Tags 服务管理 @Accept json @Produce json @Param name path string true "服务名称" example:"nginx-web" @Success 200 {object} object{code=int,data=object,msg=string} "删除成功" @Failure 400 {object} object{code=int,msg=string,data=object} "请求参数错误" @Failure 401 {object} object{code=int,msg=string,data=object} "权限验证失败" @Failure 500 {object} object{code=int,msg=string,data=object} "服务器内部错误" @Security BearerAuth || TokenAuth || QueryAuth @Router /onedock/{name} [delete]

func (*Api) DeployOrUpdateService

func (api *Api) DeployOrUpdateService(c *gin.Context)

DeployOrUpdateService 部署或更新服务 @Summary 部署或更新服务 @Description 部署新的服务或更新现有服务配置，支持容器镜像、端口映射、环境变量、卷挂载等完整配置 @Tags 服务管理 @Accept json @Produce json @Param service body models.ServiceRequest true "服务配置信息" @Success 200 {object} object{code=int,data=models.Service,msg=string} "部署成功" @Failure 400 {object} object{code=int,msg=string,data=object} "请求参数错误" @Failure 401 {object} object{code=int,msg=string,data=object} "权限验证失败" @Failure 500 {object} object{code=int,msg=string,data=object} "服务器内部错误" @Security BearerAuth || TokenAuth || QueryAuth @Router /onedock [post]

func (*Api) GetProxyStats

func (api *Api) GetProxyStats(c *gin.Context)

GetProxyStats 获取代理统计信息 @Summary 获取端口代理统计信息 @Description 获取所有端口代理的统计信息，包括单副本代理和负载均衡器的详细状态 @Tags 服务管理 @Accept json @Produce json @Success 200 {object} object{code=int,data=object,msg=string} "获取成功" @Failure 401 {object} object{code=int,msg=string,data=object} "权限验证失败" @Security BearerAuth || TokenAuth || QueryAuth @Router /onedock/proxy/stats [get]

func (*Api) GetService

func (api *Api) GetService(c *gin.Context)

GetService 获取服务详情 @Summary 获取指定服务详情 @Description 根据服务名称获取服务的详细信息，包括配置、状态等 @Tags 服务管理 @Accept json @Produce json @Param name path string true "服务名称" example:"nginx-web" @Success 200 {object} object{code=int,data=models.Service,msg=string} "获取成功" @Failure 400 {object} object{code=int,msg=string,data=object} "请求参数错误" @Failure 401 {object} object{code=int,msg=string,data=object} "权限验证失败" @Failure 404 {object} object{code=int,msg=string,data=object} "服务未找到" @Security BearerAuth || TokenAuth || QueryAuth @Router /onedock/{name} [get]

func (*Api) GetServiceStatus

func (api *Api) GetServiceStatus(c *gin.Context)

GetServiceStatus 获取服务状态 @Summary 获取服务运行状态 @Description 获取指定服务的详细运行状态，包括副本信息、健康状态、实例详情等 @Tags 服务管理 @Accept json @Produce json @Param name path string true "服务名称" example:"nginx-web" @Success 200 {object} object{code=int,data=models.ServiceStatusResponse,msg=string} "获取成功" @Failure 400 {object} object{code=int,msg=string,data=object} "请求参数错误" @Failure 401 {object} object{code=int,msg=string,data=object} "权限验证失败" @Failure 404 {object} object{code=int,msg=string,data=object} "服务未找到" @Security BearerAuth || TokenAuth || QueryAuth @Router /onedock/{name}/status [get]

func (*Api) ListServices

func (api *Api) ListServices(c *gin.Context)

ListServices 列出所有服务 @Summary 列出所有服务 @Description 获取系统中所有部署的服务列表，包括服务基本信息、状态和副本数量 @Tags 服务管理 @Accept json @Produce json @Success 200 {object} object{code=int,data=object{Services=[]models.Service,Total=int},msg=string} "获取成功" @Failure 401 {object} object{code=int,msg=string,data=object} "权限验证失败" @Security BearerAuth || TokenAuth || QueryAuth @Router /onedock [get]

func (*Api) Ping

func (s *Api) Ping(c *gin.Context)

@Summary 健康检查 @Description 用于检查 OneDock 服务的健康状态和连通性，返回服务状态信息 @Tags 系统监控 @Accept json @Produce json @Router /onedock/ping [get] @Success 200 {object} object{code=int,data=object,msg=string} "服务正常运行"

func (*Api) ScaleService

func (api *Api) ScaleService(c *gin.Context)

ScaleService 服务扩缩容 @Summary 服务扩缩容 @Description 调整指定服务的副本数量，支持扩容和缩容操作，实际创建或删除容器实例 @Tags 服务管理 @Accept json @Produce json @Param name path string true "服务名称" example:"nginx-web" @Param scale body models.ScaleRequest true "扩缩容配置" @Success 200 {object} object{code=int,data=object,msg=string} "扩缩容成功" @Failure 400 {object} object{code=int,msg=string,data=object} "请求参数错误" @Failure 401 {object} object{code=int,msg=string,data=object} "权限验证失败" @Failure 500 {object} object{code=int,msg=string,data=object} "服务器内部错误" @Security BearerAuth || TokenAuth || QueryAuth @Router /onedock/{name}/scale [post]