task

Documentation

Index

• func Delete(c *gin.Context)
• func Detail(c *gin.Context)
• func Dump(c *gin.Context)
• func List(c *gin.Context)
• func Manager(c *gin.Context)
• func Post(c *gin.Context)

Functions

func Delete

func Delete(c *gin.Context)

Delete @Summary 删除 @Description 删除指定任务 @Tags 任务 @Accept application/json @Produce application/json @Param task path string true "任务名称" @Success 200 {object} types.SBase[any] @Failure 500 {object} types.SBase[any] @Router /api/v1/task/{task} [delete]

func Detail

func Detail(c *gin.Context)

Detail @Summary 详情 @Description 获取任务详情, 支持SSE订阅 @Tags 任务 @Accept application/json @Produce application/json @Param task path string true "任务名称" @Success 200 {object} types.SBase[types.STaskRes] @Failure 500 {object} types.SBase[any] @Router /api/v1/task/{task} [get]

func Dump

func Dump(c *gin.Context)

func List

func List(c *gin.Context)

List @Summary 列表 @Description 获取任务列表, 支持WS长连接 @Tags 任务 @Accept application/json @Produce application/json @Param page query int false "页码" default(1) @Param size query int false "分页大小" default(100) @Success 200 {object} types.SBase[types.STaskListDetailRes] @Failure 500 {object} types.SBase[any] @Router /api/v1/task [get]

func Manager

func Manager(c *gin.Context)

Manager @Summary 管理 @Description 管理任务, 支持暂停、恢复、终止、超时暂停自动恢复 @Tags 任务 @Accept application/json @Produce application/json @Param task path string true "任务名称" @Param action query string false "操作项" Enums(paused,kill,pause,resume) default(paused) @Param duration query string false "暂停多久, 如果没设置则需要手工恢复" default(1m) @Success 200 {object} types.SBase[any] @Failure 500 {object} types.SBase[any] @Router /api/v1/task/{task} [put]

func Post

func Post(c *gin.Context)

Post @Summary 创建 @Description 创建任务 @Tags 任务 @Accept application/json @Produce application/json @Param task body types.STaskReq true "任务内容" @Success 200 {object} types.SBase[types.STaskCreateRes] @Failure 500 {object} types.SBase[any] @Router /api/v1/task [post]