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

# Functions

Backup @Summary backup @Description backup @Tags cluster backup @Accept json @Produce json @Security ApiKeyAuth @Param backupReq body cluster.BackupClusterDataReq true "backup request" @Success 200 {object} controller.CommonResult{data=cluster.BackupClusterDataResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /backups/ [post].
CancelBackup @Summary cancel backup @Description cancel backup @Tags cancel cluster backup @Accept json @Produce json @Security ApiKeyAuth @Param backupReq body cluster.CancelBackupReq true "cancel backup request" @Success 200 {object} controller.CommonResult{data=cluster.CancelBackupResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /backups/cancel [post].
DeleteBackup @Summary delete backup record @Description delete backup record @Tags cluster backup @Accept json @Produce json @Security ApiKeyAuth @Param backupId path int true "backup record id" @Param backupDeleteReq body cluster.DeleteBackupDataReq true "backup delete request" @Success 200 {object} controller.CommonResult{data=cluster.DeleteBackupDataResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /backups/{backupId} [delete].
GetBackupStrategy show the backup strategy of a cluster @Summary show the backup strategy of a cluster @Description show the backup strategy of a cluster @Tags cluster backup @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "clusterId" @Success 200 {object} controller.CommonResult{data=cluster.GetBackupStrategyResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/strategy [get].
QueryBackupRecords @Summary query backup records of a cluster @Description query backup records of a cluster @Tags cluster backup @Accept json @Produce json @Security ApiKeyAuth @Param backupRecordQuery query cluster.QueryBackupRecordsReq true "backup records query condition" @Success 200 {object} controller.ResultWithPage{data=cluster.QueryBackupRecordsResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /backups/ [get].
Restore @Summary restore a new cluster by backup record @Description restore a new cluster by backup record @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param request body cluster.RestoreNewClusterReq true "restore request" @Success 200 {object} controller.CommonResult{data=cluster.RestoreNewClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/restore [post].
SaveBackupStrategy save the backup strategy of a cluster @Summary save the backup strategy of a cluster @Description save the backup strategy of a cluster @Tags cluster backup @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "clusterId" @Param updateReq body cluster.SaveBackupStrategyReq true "backup strategy request" @Success 200 {object} controller.CommonResult{data=cluster.SaveBackupStrategyResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/strategy [put].