Documentation
¶
Index ¶
- Variables
- func AppUsageList(ctx echo.Context) error
- func ArchiveContainer(ctx echo.Context) error
- func ChangAppState(ctx echo.Context) error
- func CheckDockerLocation(ctx echo.Context) error
- func ContainerLog(ctx echo.Context) error
- func ContainerUpdateInfo(ctx echo.Context) error
- func DeleteDockerLocationOldCopy(ctx echo.Context) error
- func DockerTerminal(ctx echo.Context) error
- func GetContainerState(ctx echo.Context) error
- func GetDockerDaemonConfiguration(ctx echo.Context) error
- func GetDockerLocation(ctx echo.Context) error
- func GetDockerNetworks(ctx echo.Context) error
- func InstallApp(ctx echo.Context) error
- func MoveDockerLocation(ctx echo.Context) error
- func MyAppList(ctx echo.Context) error
- func PutDockerDaemonConfiguration(ctx echo.Context) error
- func RecoverDockerLocation()
- func ToComposeYAML(ctx echo.Context) error
- func UninstallApp(ctx echo.Context) error
- func UpdateSetting(ctx echo.Context) error
- func YAML(ctx echo.Context, code int, i interface{}) error
Constants ¶
This section is empty.
Variables ¶
var DockerRootDirFilePath = "/var/lib/casaos/docker_root"
Functions ¶
func AppUsageList ¶
@Summary my app hardware usage list @Produce application/json @Accept application/json @Tags app @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /app/usage [get]
func ArchiveContainer ¶
NOTE: the API is a temporary and internal API. It will be deleted in the future. the API is for archive v1 app for rebuilt v2 app.
func ChangAppState ¶
@Summary 修改app状态 @Produce application/json @Accept multipart/form-data @Tags app @Param id path string true "appid" @Param state query string false "是否停止 start stop restart" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /app/state/{id} [put]
func CheckDockerLocation ¶ added in v0.4.86
CheckDockerLocation says whether a folder, or the default place with ?default=true, can take Docker's data.
func ContainerLog ¶
@Summary 查看容器日志 @Produce application/json @Accept application/json @Tags app @Param id path string true "appid" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /app/logs/{id} [get]
func ContainerUpdateInfo ¶
@Produce application/json @Accept application/json @Tags app @Param id path string true "appid" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /app/update/{id}/info [get]
func DeleteDockerLocationOldCopy ¶ added in v0.4.86
DeleteDockerLocationOldCopy deletes what the last move left behind.
func GetContainerState ¶
@Summary 获取容器状态 @Produce application/json @Accept application/json @Tags app @Param id path string true "容器id" @Param type query string false "type=1" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /app/state/{id} [get]
func GetDockerLocation ¶ added in v0.4.86
GetDockerLocation says where Docker's data is, and how the last move went.
func GetDockerNetworks ¶
func InstallApp ¶
@Summary 安装app(该接口需要post json数据) @Produce application/json @Accept application/json @Tags app @Param id path int true "id" @Param port formData int true "主端口" @Param tcp formData string false "tcp端口" @Param udp formData string false "udp端口" @Param env formData string false "环境变量" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /app/install [post]
func MoveDockerLocation ¶ added in v0.4.86
MoveDockerLocation starts moving Docker's data to a folder; GET follows it.
func MyAppList ¶
@Summary 我的应用列表 @Produce application/json @Accept application/json @Tags app @Security ApiKeyAuth @Param index query int false "index" @Param size query int false "size" @Param position query bool false "是否是首页应用" @Success 200 {string} string "ok" @Router /app/my/list [get]
func RecoverDockerLocation ¶ added in v0.4.86
func RecoverDockerLocation()
RecoverDockerLocation finishes or undoes, in the background, a move of Docker's data that a stop of this service cut short: Docker is never left stopped by it.
func ToComposeYAML ¶
func UninstallApp ¶
@Summary 卸载app @Produce application/json @Accept multipart/form-data @Tags app @Param id path string true "容器id" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /app/uninstall/{id} [delete]
func UpdateSetting ¶
@Summary 更新设置 @Produce application/json @Accept multipart/form-data @Tags app @Param id path string true "容器id" @Param shares formData string false "cpu权重" @Param mem formData string false "内存大小MB" @Param restart formData string false "重启策略" @Param label formData string false "应用名称" @Param position formData bool true "是否放到首页" @Security ApiKeyAuth @Success 200 {string} string "ok" @Router /app/update/{id}/setting [put]
Types ¶
This section is empty.
Source Files