package
1.0.2
Repository: https://github.com/pingcap/tiunimanager.git
Documentation: pkg.go.dev

# Functions

Create create a change feed task @Summary create a change feed task @Description create a change feed task @Tags change feed @Accept json @Produce json @Security ApiKeyAuth @Param changeFeedTask body cluster.CreateChangeFeedTaskReq true "change feed task request" @Success 200 {object} controller.CommonResult{data=cluster.CreateChangeFeedTaskResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /changefeeds/ [post].
Delete delete a change feed task @Summary delete a change feed task @Description delete a change feed task @Tags change feed @Accept json @Produce json @Security ApiKeyAuth @Param changeFeedTaskId path string true "changeFeedTaskId" @Success 200 {object} controller.CommonResult{data=cluster.DeleteChangeFeedTaskResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /changefeeds/{changeFeedTaskId} [delete].
Detail get change feed detail @Summary get change feed detail @Description get change feed detail @Tags change feed @Accept json @Produce json @Security ApiKeyAuth @Param changeFeedTaskId path string true "changeFeedTaskId" @Success 200 {object} controller.CommonResult{data=cluster.DetailChangeFeedTaskResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /changefeeds/{changeFeedTaskId}/ [get].
Downstream @Summary unused, just display downstream config @Description show display config @Tags change feed @Accept json @Produce json @Security ApiKeyAuth @Param tidb body cluster.TiDBDownstream true "tidb" @Param mysql body cluster.MysqlDownstream true "mysql" @Param kafka body cluster.KafkaDownstream true "kafka" @Success 200 {object} controller.CommonResult @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /downstream/ [delete].
Pause pause a change feed task @Summary pause a change feed task @Description pause a change feed task @Tags change feed @Accept json @Produce json @Security ApiKeyAuth @Param changeFeedTaskId path string true "changeFeedTaskId" @Success 200 {object} controller.CommonResult{data=cluster.PauseChangeFeedTaskResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /changefeeds/{changeFeedTaskId}/pause [post].
Query @Summary query change feed tasks of a cluster @Description query change feed tasks of a cluster @Tags change feed @Accept json @Produce json @Security ApiKeyAuth @Param queryReq query cluster.QueryChangeFeedTaskReq true "change feed tasks query condition" @Success 200 {object} controller.ResultWithPage{data=[]cluster.QueryChangeFeedTaskResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /changefeeds/ [get].
Resume resume a change feed task @Summary resume a change feed task @Description resume a change feed task @Tags change feed @Accept json @Produce json @Security ApiKeyAuth @Param changeFeedTaskId path string true "changeFeedTaskId" @Success 200 {object} controller.CommonResult{data=cluster.ResumeChangeFeedTaskResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /changefeeds/{changeFeedTaskId}/resume [post].
Update update a change feed @Summary resume a change feed @Description resume a change feed @Tags change feed @Accept json @Produce json @Security ApiKeyAuth @Param changeFeedTaskId path string true "changeFeedTaskId" @Param task body cluster.UpdateChangeFeedTaskReq true "change feed task" @Success 200 {object} controller.CommonResult{data=cluster.UpdateChangeFeedTaskResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /changefeeds/{changeFeedTaskId}/update [post].