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

# Functions

Clone clone a cluster @Summary clone a cluster @Description clone a cluster @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param cloneClusterReq body cluster.CloneClusterReq true "clone cluster request" @Success 200 {object} controller.CommonResult{data=cluster.CloneClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/clone [post].
Create create a cluster @Summary create a cluster @Description create a cluster @Tags cluster @Accept application/json @Produce application/json @Security ApiKeyAuth @Param createReq body cluster.CreateClusterReq true "create request" @Success 200 {object} controller.CommonResult{data=cluster.CreateClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/ [post].
Delete delete cluster @Summary delete cluster @Description delete cluster @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Param deleteReq body cluster.DeleteClusterReq false "delete request" @Success 200 {object} controller.CommonResult{data=cluster.DeleteClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId} [delete].
DeleteMetaDataPhysically delete cluster metadata in this system physically, but keep the real cluster alive @Summary delete cluster metadata in this system physically, but keep the real cluster alive @Description for handling exceptions only @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Param deleteReq body cluster.DeleteMetadataPhysicallyReq false "delete request" @Success 200 {object} controller.CommonResult{data=cluster.DeleteMetadataPhysicallyResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /metadata/{clusterId}/ [delete].
Detail show details of a cluster @Summary show details of a cluster @Description show details of a cluster @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Success 200 {object} controller.CommonResult{data=cluster.QueryClusterDetailResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId} [get].
GetDashboardInfo dashboard @Summary dashboard @Description dashboard @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Success 200 {object} controller.CommonResult{data=cluster.GetDashboardInfoResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/dashboard [get].
GetMonitorInfo describe monitoring link @Summary describe monitoring link @Description describe monitoring link @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Success 200 {object} controller.CommonResult{data=cluster.QueryMonitorInfoResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/monitor [get].
Preview preview cluster topology and capability @Summary preview cluster topology and capability @Description preview cluster topology and capability @Tags cluster @Accept application/json @Produce application/json @Security ApiKeyAuth @Param createReq body cluster.CreateClusterReq true "preview request" @Success 200 {object} controller.CommonResult{data=cluster.PreviewClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/preview [post].
Query query clusters @Summary query clusters @Description query clusters @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param queryReq query cluster.QueryClustersReq false "query request" @Success 200 {object} controller.ResultWithPage{data=cluster.QueryClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/ [get].
Restart restart a cluster @Summary restart a cluster @Description restart a cluster @Tags cluster @Accept application/json @Produce application/json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Success 200 {object} controller.CommonResult{data=cluster.RestartClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/restart [post].
ScaleIn scale in a cluster @Summary scale in a cluster @Description scale in a cluster @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Param scaleInReq body cluster.ScaleInClusterReq true "scale in request" @Success 200 {object} controller.CommonResult{data=cluster.ScaleInClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/scale-in [post].
ScaleOut scale out a cluster @Summary scale out a cluster @Description scale out a cluster @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Param scaleOutReq body cluster.ScaleOutClusterReq true "scale out request" @Success 200 {object} controller.CommonResult{data=cluster.ScaleOutClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/scale-out [post].
ScaleOutPreview preview cluster topology and capability @Summary preview cluster topology and capability @Description preview cluster topology and capability @Tags cluster @Accept json @Produce json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Param scaleOutReq body cluster.ScaleOutClusterReq true "scale out request" @Success 200 {object} controller.CommonResult{data=cluster.PreviewClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/preview-scale-out [post].
Stop stop a cluster @Summary stop a cluster @Description stop a cluster @Tags cluster @Accept application/json @Produce application/json @Security ApiKeyAuth @Param clusterId path string true "cluster id" @Success 200 {object} controller.CommonResult{data=cluster.StopClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/{clusterId}/stop [post].
Takeover takeover a cluster @Summary takeover a cluster @Description takeover a cluster @Tags cluster @Accept application/json @Produce application/json @Security ApiKeyAuth @Param takeoverReq body cluster.TakeoverClusterReq true "takeover request" @Success 200 {object} controller.CommonResult{data=cluster.TakeoverClusterResp} @Failure 401 {object} controller.CommonResult @Failure 403 {object} controller.CommonResult @Failure 500 {object} controller.CommonResult @Router /clusters/takeover [post].

# Constants

No description provided by the author