mcis

package
v0.8.14 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 14, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Package mcis is to handle REST API for mcis

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExtractSitesInfoFromMcisInfo added in v0.8.12

func ExtractSitesInfoFromMcisInfo(nsId, mcisId string) (*model.SitesInfo, error)

func RestAddNLBVMs added in v0.6.3

func RestAddNLBVMs(c echo.Context) error

RestAddNLBVMs godoc @ID AddNLBVMs @Summary Add VMs to NLB @Description Add VMs to NLB @Tags [Infra resource] NLB management (for developer) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param nlbId path string true "NLB ID" default(g1) @Param nlbAddRemoveVMReq body mcis.TbNLBAddRemoveVMReq true "VMs to add to NLB" @Success 200 {object} mcis.TbNLBInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/nlb/{nlbId}/vm [post]

func RestCheckMcis

func RestCheckMcis(c echo.Context) error

func RestCheckVm

func RestCheckVm(c echo.Context) error

func RestDelAllMcis

func RestDelAllMcis(c echo.Context) error

RestDelAllMcis godoc @ID DelAllMcis @Summary Delete all MCISs @Description Delete all MCISs @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param option query string false "Option for delete MCIS (support force delete)" Enums(force) @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/mcis [delete]

func RestDelAllMcisPolicy added in v0.2.8

func RestDelAllMcisPolicy(c echo.Context) error

RestDelAllMcisPolicy godoc @ID DelAllMcisPolicy @Summary Delete all MCIS policies @Description Delete all MCIS policies @Tags [Infra service] MCIS Auto control policy management (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/policy/mcis [delete]

func RestDelAllNLB added in v0.6.1

func RestDelAllNLB(c echo.Context) error

RestDelAllNLB godoc @ID DelAllNLB @Summary Delete all NLBs @Description Delete all NLBs @Tags [Infra resource] NLB management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param match query string false "Delete resources containing matched ID-substring only" default() @Success 200 {object} common.IdList @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/nlb [delete]

func RestDelMcis

func RestDelMcis(c echo.Context) error

RestDelMcis godoc @ID DelMcis @Summary Delete MCIS @Description Delete MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param option query string false "Option for delete MCIS (support force delete)" Enums(terminate,force) @Success 200 {object} common.IdList @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId} [delete]

func RestDelMcisPolicy added in v0.2.8

func RestDelMcisPolicy(c echo.Context) error

DelMcisPolicy godoc @ID DelMcisPolicy @Summary Delete MCIS Policy @Description Delete MCIS Policy @Tags [Infra service] MCIS Auto control policy management (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/policy/mcis/{mcisId} [delete]

func RestDelMcisVm

func RestDelMcisVm(c echo.Context) error

RestDelMcisVm godoc @ID DelMcisVm @Summary Delete VM in specified MCIS @Description Delete VM in specified MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vmId path string true "VM ID" default(g1-1) @Param option query string false "Option for delete VM (support force delete)" Enums(force) @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/vm/{vmId} [delete]

func RestDelNLB added in v0.6.1

func RestDelNLB(c echo.Context) error

RestDelNLB godoc @ID DelNLB @Summary Delete NLB @Description Delete NLB @Tags [Infra resource] NLB management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param nlbId path string true "NLB ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/nlb/{nlbId} [delete]

func RestDeleteAllCluster added in v0.8.1

func RestDeleteAllCluster(c echo.Context) error

RestDeleteAllCluster godoc @ID DeleteAllCluster @Summary Delete all Clusters @Description Delete all Clusters @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param match query string false "Delete resources containing matched ID-substring only" default() @Success 200 {object} common.IdList @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/cluster [delete]

func RestDeleteCluster added in v0.8.1

func RestDeleteCluster(c echo.Context) error

RestDeleteCluster godoc @ID DeleteCluster @Summary Delete Cluster @Description Delete Cluster @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param clusterId path string true "Cluster ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/cluster/{clusterId} [delete]

func RestDeleteNodeGroup added in v0.8.1

func RestDeleteNodeGroup(c echo.Context) error

RestDeleteNodeGroup godoc @ID DeleteNodeGroup @Summary Remove a NodeGroup @Description Remove a NodeGroup @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param clusterId path string true "Cluster ID" @Param nodeGroupName path string true "NodeGroup Name" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/cluster/{clusterId}/nodegroup/{nodeGroupName} [delete]

func RestDeleteVpnGcpToAws added in v0.8.12

func RestDeleteVpnGcpToAws(c echo.Context) error

RestDeleteVpnGcpToAws godoc @ID DeleteVpnGcpToAws @Summary Delete a site-to-site VPN (Currently, GCP-AWS is supported) @Description Delete a site-to-site VPN (Currently, GCP-AWS is supported) @Tags [VPN] Site-to-site VPN (under development) @Accept json @Produce json-stream @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vpnId path string true "VPN ID" default(vpn01) @Success 200 {object} common.SimpleMsg "OK" @Failure 400 {object} common.SimpleMsg "Bad Request" @Failure 500 {object} common.SimpleMsg "Internal Server Error" @Failure 503 {object} common.SimpleMsg "Service Unavailable" @Router /stream-response/ns/{nsId}/mcis/{mcisId}/vpn/{vpnId} [delete]

func RestGetAllBenchmark

func RestGetAllBenchmark(c echo.Context) error

RestGetAllBenchmark godoc @ID GetAllBenchmark @Summary Run MCIS benchmark for all performance metrics and return results @Description Run MCIS benchmark for all performance metrics and return results @Tags [Infra service] MCIS Performance benchmarking (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param hostIP body RestGetAllBenchmarkRequest true "Host IP address to benchmark" @Success 200 {object} mcis.BenchmarkInfoArray @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/benchmarkAll/mcis/{mcisId} [post]

func RestGetAllCluster added in v0.8.1

func RestGetAllCluster(c echo.Context) error

RestGetAllCluster godoc @ID GetAllCluster @Summary List all Clusters or Clusters' ID @Description List all Clusters or Clusters' ID @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param option query string false "Option" Enums(id) @Param filterKey query string false "Field key for filtering (ex: cspClusterName)" @Param filterVal query string false "Field value for filtering (ex: ns01-alibaba-ap-northeast-1-vpc)" @Success 200 {object} JSONResult{[DEFAULT]=RestGetAllClusterResponse,[ID]=common.IdList} "Different return structures by the given option param" @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cluster [get]

func RestGetAllMcis

func RestGetAllMcis(c echo.Context) error

RestGetAllMcis godoc @ID GetAllMcis @Summary List all MCISs or MCISs' ID @Description List all MCISs or MCISs' ID @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param option query string false "Option" Enums(id, simple, status) @Success 200 {object} JSONResult{[DEFAULT]=RestGetAllMcisResponse,[SIMPLE]=RestGetAllMcisResponse,[ID]=common.IdList,[STATUS]=RestGetAllMcisStatusResponse} "Different return structures by the given option param" @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis [get]

func RestGetAllMcisPolicy added in v0.2.8

func RestGetAllMcisPolicy(c echo.Context) error

RestGetAllMcisPolicy godoc @ID GetAllMcisPolicy @Summary List all MCIS policies @Description List all MCIS policies @Tags [Infra service] MCIS Auto control policy management (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Success 200 {object} RestGetAllMcisPolicyResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/policy/mcis [get]

func RestGetAllNLB added in v0.6.1

func RestGetAllNLB(c echo.Context) error

RestGetAllNLB godoc @ID GetAllNLB @Summary List all NLBs or NLBs' ID @Description List all NLBs or NLBs' ID @Tags [Infra resource] NLB management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param option query string false "Option" Enums(id) @Param filterKey query string false "Field key for filtering (ex: cspNLBName)" @Param filterVal query string false "Field value for filtering (ex: ns01-alibaba-ap-northeast-1-vpc)" @Success 200 {object} JSONResult{[DEFAULT]=RestGetAllNLBResponse,[ID]=common.IdList} "Different return structures by the given option param" @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/nlb [get]

func RestGetAvailableK8sClusterNodeImage added in v0.8.14

func RestGetAvailableK8sClusterNodeImage(c echo.Context) error

RestGetAvailableK8sClusterNodeImage func is a rest api wrapper for GetAvailableK8sClusterNodeImage. RestGetAvailableK8sClusterNodeImage godoc @ID GetAvailableK8sClusterNodeImage @Summary Get available kubernetes cluster node image @Description Get available kubernetes cluster node image @Tags [Infra resource] Cluster management @Accept json @Produce json @Param providerName query string true "Name of the CSP to retrieve" @Param regionName query string true "Name of region to retrieve" @Success 200 {object} common.K8sClusterNodeImageDetailAvailable @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /availableK8sClusterNodeImage [get]

func RestGetAvailableK8sClusterVersion added in v0.8.14

func RestGetAvailableK8sClusterVersion(c echo.Context) error

RestGetAvailableK8sClusterVersion func is a rest api wrapper for GetAvailableK8sClusterVersion. RestGetAvailableK8sClusterVersion godoc @ID GetAvailableK8sClusterVersion @Summary Get available kubernetes cluster version @Description Get available kubernetes cluster version @Tags [Infra resource] Cluster management @Accept json @Produce json @Param providerName query string true "Name of the CSP to retrieve" @Param regionName query string true "Name of region to retrieve" @Success 200 {object} common.K8sClusterVersionDetailAvailable @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /availableK8sClusterVersion [get]

func RestGetBastionNodes added in v0.7.8

func RestGetBastionNodes(c echo.Context) error

RestGetBastionNodes godoc @ID GetBastionNodes @Summary Get bastion nodes for a VM @Description Get bastion nodes for a VM @Tags [Infra service] MCIS Remote command @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param targetVmId path string true "Target VM ID" default(g1-1) @Success 200 {object} []mcir.BastionNode @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/vm/{targetVmId}/bastion [get]

func RestGetBenchmark

func RestGetBenchmark(c echo.Context) error

RestGetBenchmark godoc @ID GetBenchmark @Summary Run MCIS benchmark for a single performance metric and return results @Description Run MCIS benchmark for a single performance metric and return results @Tags [Infra service] MCIS Performance benchmarking (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param hostIP body RestGetBenchmarkRequest true "Host IP address to benchmark" @Param action query string true "Benchmark Action to MCIS" Enums(install, init, cpus, cpum, memR, memW, fioR, fioW, dbR, dbW, rtt, mrtt, clean) @Success 200 {object} mcis.BenchmarkInfoArray @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/benchmark/mcis/{mcisId} [post]

func RestGetBenchmarkLatency added in v0.6.17

func RestGetBenchmarkLatency(c echo.Context) error

RestGetLatencyBenchmark godoc @ID GetLatencyBenchmark @Summary Run MCIS benchmark for network latency @Description Run MCIS benchmark for network latency @Tags [Infra service] MCIS Performance benchmarking (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(system-purpose-common-ns) @Param mcisId path string true "MCIS ID" default(probe) @Success 200 {object} mcis.BenchmarkInfoArray @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/benchmarkLatency/mcis/{mcisId} [get]

func RestGetCluster added in v0.8.1

func RestGetCluster(c echo.Context) error

RestGetCluster godoc @ID GetCluster @Summary Get Cluster @Description Get Cluster @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param clusterId path string true "Cluster ID" default(c1) @Success 200 {object} mcis.TbClusterInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cluster/{clusterId} [get]

func RestGetControlMcis added in v0.4.4

func RestGetControlMcis(c echo.Context) error

RestGetControlMcis godoc @ID GetControlMcis @Summary Control the lifecycle of MCIS (refine, suspend, resume, reboot, terminate) @Description Control the lifecycle of MCIS (refine, suspend, resume, reboot, terminate) @Tags [Infra service] MCIS Control lifecycle @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param action query string true "Action to MCIS" Enums(suspend, resume, reboot, terminate, refine, continue, withdraw) @Param force query string false "Force control to skip checking controllable status" Enums(false, true) @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/control/mcis/{mcisId} [get]

func RestGetControlMcisVm added in v0.4.4

func RestGetControlMcisVm(c echo.Context) error

RestGetControlMcisVm godoc @ID GetControlMcisVm @Summary Control the lifecycle of VM (suspend, resume, reboot, terminate) @Description Control the lifecycle of VM (suspend, resume, reboot, terminate) @Tags [Infra service] MCIS Control lifecycle @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vmId path string true "VM ID" default(g1-1) @Param action query string true "Action to MCIS" Enums(suspend, resume, reboot, terminate) @Param force query string false "Force control to skip checking controllable status" Enums(false, true) @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/control/mcis/{mcisId}/vm/{vmId} [get]

func RestGetMcis

func RestGetMcis(c echo.Context) error

RestGetMcis godoc @ID GetMcis @Summary Get MCIS object (option: status, accessInfo, vmId) @Description Get MCIS object (option: status, accessInfo, vmId) @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param option query string false "Option" Enums(default, id, status, accessinfo) @Param filterKey query string false "(For option=id) Field key for filtering (ex: connectionName)" @Param filterVal query string false "(For option=id) Field value for filtering (ex: aws-ap-northeast-2)" @Param accessInfoOption query string false "(For option=accessinfo) accessInfoOption (showSshKey)" @success 200 {object} JSONResult{[DEFAULT]=mcis.TbMcisInfo,[ID]=common.IdList,[STATUS]=mcis.McisStatusInfo,[AccessInfo]=mcis.McisAccessInfo} "Different return structures by the given action param" @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId} [get]

func RestGetMcisGroupIds added in v0.6.3

func RestGetMcisGroupIds(c echo.Context) error

RestGetMcisGroupIds godoc @ID GetMcisGroupIds @Summary List SubGroup IDs in a specified MCIS @Description List SubGroup IDs in a specified MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Success 200 {object} common.IdList @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/subgroup [get]

func RestGetMcisGroupVms added in v0.6.3

func RestGetMcisGroupVms(c echo.Context) error

RestGetMcisGroupVms godoc @ID GetMcisGroupVms @Summary List VMs with a SubGroup label in a specified MCIS @Description List VMs with a SubGroup label in a specified MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param subgroupId path string true "subGroup ID" default(g1) @Param option query string false "Option" Enums(id) @Success 200 {object} common.IdList @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/subgroup/{subgroupId} [get]

func RestGetMcisPolicy added in v0.2.8

func RestGetMcisPolicy(c echo.Context) error

RestGetMcisPolicy godoc @ID GetMcisPolicy @Summary Get MCIS Policy @Description Get MCIS Policy @Tags [Infra service] MCIS Auto control policy management (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Success 200 {object} mcis.McisPolicyInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/policy/mcis/{mcisId} [get]

func RestGetMcisVm

func RestGetMcisVm(c echo.Context) error

RestGetMcisVm godoc @ID GetMcisVm @Summary Get VM in specified MCIS @Description Get VM in specified MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vmId path string true "VM ID" default(g1-1) @Param option query string false "Option for MCIS" Enums(default, status, idsInDetail) @success 200 {object} JSONResult{[DEFAULT]=mcis.TbVmInfo,[STATUS]=mcis.TbVmStatusInfo,[IDNAME]=mcis.TbIdNameInDetailInfo} "Different return structures by the given option param" @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/vm/{vmId} [get]

func RestGetMonitorData

func RestGetMonitorData(c echo.Context) error

RestGetMonitorData godoc @ID GetMonitorData @Summary Get monitoring data of specified MCIS for specified monitoring metric (cpu, memory, disk, network) @Description Get monitoring data of specified MCIS for specified monitoring metric (cpu, memory, disk, network) @Tags [Infra service] MCIS Resource monitor (for developer) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param metric path string true "Metric type: cpu, memory, disk, network" @Success 200 {object} mcis.MonResultSimpleResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/monitoring/mcis/{mcisId}/metric/{metric} [get]

func RestGetNLB added in v0.6.1

func RestGetNLB(c echo.Context) error

RestGetNLB godoc @ID GetNLB @Summary Get NLB @Description Get NLB @Tags [Infra resource] NLB management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param nlbId path string true "NLB ID" default(g1) @Success 200 {object} mcis.TbNLBInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/nlb/{nlbId} [get]

func RestGetNLBHealth added in v0.6.3

func RestGetNLBHealth(c echo.Context) error

RestGetNLBHealth godoc @ID GetNLBHealth @Summary Get NLB Health @Description Get NLB Health @Tags [Infra resource] NLB management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param nlbId path string true "NLB ID" default(g1) @Success 200 {object} mcis.TbNLBInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/nlb/{nlbId}/healthz [get]

func RestGetRequestStatusOfGcpAwsVpn added in v0.8.12

func RestGetRequestStatusOfGcpAwsVpn(c echo.Context) error

RestGetRequestStatusOfGcpAwsVpn godoc @ID GetRequestStatusOfGcpAwsVpn @Summary Check the status of a specific request by its ID @Description Check the status of a specific request by its ID @Tags [VPN] Site-to-site VPN (under development) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vpnId path string true "VPN ID" default(vpn01) @Param requestId path string true "Request ID" @Success 200 {object} model.Response "OK" @Failure 400 {object} model.Response "Bad Request" @Failure 500 {object} model.Response "Internal Server Error" @Failure 503 {object} model.Response "Service Unavailable" @Router /ns/{nsId}/mcis/{mcisId}/vpn/{vpnId}/request/{requestId} [get]

func RestGetSitesInMcis added in v0.8.12

func RestGetSitesInMcis(c echo.Context) error

RestGetSitesInMcis godoc @ID GetSitesInMcis @Summary Get sites in MCIS @Description Get sites in MCIS @Tags [VPN] Sites in MCIS (under development) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Success 200 {object} model.SitesInfo "OK" @Failure 400 {object} common.SimpleMsg "Bad Request" @Failure 500 {object} common.SimpleMsg "Internal Server Error" @Failure 503 {object} common.SimpleMsg "Service Unavailable" @Router /ns/{nsId}/mcis/{mcisId}/site [get]

func RestGetVpnGcpToAws added in v0.8.12

func RestGetVpnGcpToAws(c echo.Context) error

RestGetVpnGcpToAws godoc @ID GetVpnGcpToAws @Summary Get resource info of a site-to-site VPN (Currently, GCP-AWS is supported) @Description Get resource info of a site-to-site VPN (Currently, GCP-AWS is supported) @Tags [VPN] Site-to-site VPN (under development) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vpnId path string true "VPN ID" default(vpn01) @Param detail query string false "Resource info by detail (refined, raw)" default(refined) @Success 200 {object} model.Response "OK" @Failure 400 {object} model.Response "Bad Request" @Failure 500 {object} model.Response "Internal Server Error" @Failure 503 {object} model.Response "Service Unavailable" @Router /ns/{nsId}/mcis/{mcisId}/vpn/{vpnId} [get]

func RestPostCluster added in v0.8.1

func RestPostCluster(c echo.Context) error

RestPostCluster godoc @ID PostCluster @Summary Create Cluster @Description Create Cluster @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param option query string false "Option: [required params for register] connectionName, name, cspClusterId" Enums(register) @Param clusterReq body mcis.TbClusterReq true "Details of the Cluster object" @Success 200 {object} mcis.TbClusterInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cluster [post]

func RestPostCmdMcis

func RestPostCmdMcis(c echo.Context) error

RestPostCmdMcis godoc @ID PostCmdMcis @Summary Send a command to specified MCIS @Description Send a command to specified MCIS @Tags [Infra service] MCIS Remote command @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param mcisCmdReq body mcis.McisCmdReq true "MCIS Command Request" @Param subGroupId query string false "subGroupId to apply the command only for VMs in subGroup of MCIS" default(g1) @Param vmId query string false "vmId to apply the command only for a VM in MCIS" default(g1-1) @Param x-request-id header string false "Custom request ID" @Success 200 {object} mcis.McisSshCmdResult @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cmd/mcis/{mcisId} [post]

func RestPostInstallBenchmarkAgentToMcis added in v0.4.9

func RestPostInstallBenchmarkAgentToMcis(c echo.Context) error

RestPostInstallBenchmarkAgentToMcis godoc @ID PostInstallBenchmarkAgentToMcis @Summary Install the benchmark agent to specified MCIS @Description Install the benchmark agent to specified MCIS @Tags [Infra service] MCIS Performance benchmarking (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param mcisCmdReq body mcis.McisCmdReq true "MCIS Command Request" @Param option query string false "Option for checking update" Enums(update) @Success 200 {object} mcis.McisSshCmdResult @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/installBenchmarkAgent/mcis/{mcisId} [post]

func RestPostInstallMonitorAgentToMcis

func RestPostInstallMonitorAgentToMcis(c echo.Context) error

RestPostInstallMonitorAgentToMcis godoc @ID PostInstallMonitorAgentToMcis @Summary Install monitoring agent (CB-Dragonfly agent) to MCIS @Description Install monitoring agent (CB-Dragonfly agent) to MCIS @Tags [Infra service] MCIS Resource monitor (for developer) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param mcisInfo body mcis.McisCmdReq true "Details for an MCIS object" @Success 200 {object} mcis.AgentInstallContentWrapper @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/monitoring/install/mcis/{mcisId} [post]

func RestPostMcNLB added in v0.6.16

func RestPostMcNLB(c echo.Context) error

RestPostMcNLB godoc @ID PostMcNLB @Summary Create a special purpose MCIS for NLB and depoly and setting SW NLB @Description Create a special purpose MCIS for NLB and depoly and setting SW NLB @Tags [Infra resource] NLB management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param nlbReq body mcis.TbNLBReq true "Details of the NLB object" @Success 200 {object} mcis.McNlbInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/mcSwNlb [post]

func RestPostMcis

func RestPostMcis(c echo.Context) error

RestPostMcis godoc @ID PostMcis @Summary Create MCIS @Description Create MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisReq body TbMcisReq true "Details for an MCIS object" @Success 200 {object} TbMcisInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis [post]

func RestPostMcisDynamic added in v0.4.10

func RestPostMcisDynamic(c echo.Context) error

RestPostMcisDynamic godoc @ID PostMcisDynamic @Summary Create MCIS Dynamically @Description Create MCIS Dynamically from common spec and image @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisReq body TbMcisDynamicReq true "Request body to provision MCIS dynamically. Must include commonSpec and commonImage info of each VM request.(ex: {name: mcis01,vm: [{commonImage: aws+ap-northeast-2+ubuntu22.04,commonSpec: aws+ap-northeast-2+t2.small}]} ) You can use /mcisRecommendVm and /mcisDynamicCheckRequest to get it) Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1570" @Param option query string false "Option for MCIS creation" Enums(hold) @Param x-request-id header string false "Custom request ID" @Success 200 {object} TbMcisInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcisDynamic [post]

func RestPostMcisDynamicCheckRequest added in v0.5.3

func RestPostMcisDynamicCheckRequest(c echo.Context) error

RestPostMcisDynamicCheckRequest godoc @ID PostMcisDynamicCheckRequest @Summary Check available ConnectionConfig list for creating MCIS Dynamically @Description Check available ConnectionConfig list before create MCIS Dynamically from common spec and image @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param mcisReq body McisConnectionConfigCandidatesReq true "Details for MCIS dynamic request information" @Success 200 {object} CheckMcisDynamicReqInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /mcisDynamicCheckRequest [post]

func RestPostMcisPolicy added in v0.2.8

func RestPostMcisPolicy(c echo.Context) error

RestPostMcisPolicy godoc @ID PostMcisPolicy @Summary Create MCIS Automation policy @Description Create MCIS Automation policy @Tags [Infra service] MCIS Auto control policy management (WIP) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param mcisPolicyReq body mcis.McisPolicyReq true "Details for an MCIS automation policy request" @Success 200 {object} mcis.McisPolicyInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/policy/mcis/{mcisId} [post]

func RestPostMcisSubGroupScaleOut added in v0.6.10

func RestPostMcisSubGroupScaleOut(c echo.Context) error

RestPostMcisSubGroupScaleOut godoc @ID PostMcisSubGroupScaleOut @Summary ScaleOut subGroup in specified MCIS @Description ScaleOut subGroup in specified MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param subgroupId path string true "subGroup ID" default(g1) @Param vmReq body mcis.TbScaleOutSubGroupReq true "subGroup scaleOut request" @Success 200 {object} mcis.TbMcisInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/subgroup/{subgroupId} [post]

func RestPostMcisVm

func RestPostMcisVm(c echo.Context) error

RestPostMcisVm godoc @ID PostMcisVm @Summary Create and add homogeneous VMs(subGroup) to a specified MCIS (Set subGroupSize for multiple VMs) @Description Create and add homogeneous VMs(subGroup) to a specified MCIS (Set subGroupSize for multiple VMs) @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vmReq body mcis.TbVmReq true "Details for VMs(subGroup)" @Success 200 {object} mcis.TbMcisInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/vm [post]

func RestPostMcisVmDynamic added in v0.6.13

func RestPostMcisVmDynamic(c echo.Context) error

RestPostMcisVmDynamic godoc @ID PostMcisVmDynamic @Summary Create VM Dynamically and add it to MCIS @Description Create VM Dynamically and add it to MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vmReq body TbVmDynamicReq true "Details for Vm dynamic request" @Success 200 {object} TbMcisInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/vmDynamic [post]

func RestPostMcisVmSnapshot added in v0.6.10

func RestPostMcisVmSnapshot(c echo.Context) error

RestPostMcisVmSnapshot godoc @ID PostMcisVmSnapshot @Summary Snapshot VM and create a Custom Image Object using the Snapshot @Description Snapshot VM and create a Custom Image Object using the Snapshot @Tags [Infra resource] Snapshot and Custom Image Management @Accept json @Produce json @Param vmSnapshotReq body mcis.TbVmSnapshotReq true "Request body to create VM snapshot" @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vmId path string true "VM ID" default(g1-1) @Success 200 {object} mcir.TbCustomImageInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/vm/{vmId}/snapshot [post]

func RestPostNLB added in v0.6.1

func RestPostNLB(c echo.Context) error

RestPostNLB godoc @ID PostNLB @Summary Create NLB @Description Create NLB @Tags [Infra resource] NLB management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param option query string false "Option: [required params for register] connectionName, name, cspNLBId" Enums(register) @Param nlbReq body mcis.TbNLBReq true "Details of the NLB object" @Success 200 {object} mcis.TbNLBInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/nlb [post]

func RestPostNodeGroup added in v0.8.1

func RestPostNodeGroup(c echo.Context) error

RestPostNodeGroup godoc @ID PostNodeGroup @Summary Add a NodeGroup @Description Add a NodeGroup @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param clusterId path string true "Cluster ID" @Param nodeGroupReq body mcis.TbNodeGroupReq true "Details of the NodeGroup object" @Success 200 {object} mcis.TbClusterInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cluster/{clusterId}/nodegroup [post]

func RestPostRegisterCSPNativeVM added in v0.5.1

func RestPostRegisterCSPNativeVM(c echo.Context) error

RestPostRegisterCSPNativeVM godoc @ID PostRegisterCSPNativeVM @Summary Register existing VM in a CSP to Cloud-Barista MCIS @Description Register existing VM in a CSP to Cloud-Barista MCIS @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisReq body TbMcisReq true "Details for an MCIS object with existing CSP VM ID" @Success 200 {object} TbMcisInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/registerCspVm [post]

func RestPostSystemMcis added in v0.6.16

func RestPostSystemMcis(c echo.Context) error

RestPostSystemMcis godoc @ID PostSystemMcis @Summary Create System MCIS Dynamically for Special Purpose in NS:system-purpose-common-ns @Description Create System MCIS Dynamically for Special Purpose @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param option query string false "Option for the purpose of system MCIS" Enums(probe) @Success 200 {object} TbMcisInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /systemMcis [post]

func RestPostVpnGcpToAws added in v0.8.12

func RestPostVpnGcpToAws(c echo.Context) error

RestPostVpnGcpToAws godoc @ID PostVpnGcpToAws @Summary Create a site-to-site VPN (Currently, GCP-AWS is supported) @Description Create a site-to-site VPN (Currently, GCP-AWS is supported) @Tags [VPN] Site-to-site VPN (under development) @Accept json @Produce json-stream @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vpnId path string true "VPN ID" default(vpn01) @Param vpnReq body model.RestPostVpnRequest true "Sites info for VPN configuration" @Success 200 {object} common.SimpleMsg "OK" @Failure 400 {object} common.SimpleMsg "Bad Request" @Failure 500 {object} common.SimpleMsg "Internal Server Error" @Failure 503 {object} common.SimpleMsg "Service Unavailable" @Router /stream-response/ns/{nsId}/mcis/{mcisId}/vpn/{vpnId} [post]

func RestPutChangeAutoscaleSize added in v0.8.1

func RestPutChangeAutoscaleSize(c echo.Context) error

RestPutChangeAutoscaleSize godoc @ID PutChangeAutoscaleSize @Summary Change a NodeGroup's Autoscale Size @Description Change a NodeGroup's Autoscale Size @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param clusterId path string true "Cluster ID" @Param nodeGroupName path string true "NodeGroup Name" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cluster/{clusterId}/nodegroup/{nodeGroupName}/autoscalesize [put]

func RestPutCluster added in v0.8.1

func RestPutCluster(c echo.Context) error
function RestPutCluster not yet implemented

// RestPutCluster godoc // @ID PutCluster // @Summary Update Cluster // @Description Update Cluster // @Tags [Infra resource] Cluster management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(ns01) // @Param clusterId path string true "Cluster ID" default(c1) // @Param nlbInfo body mcis.TbClusterInfo true "Details of the Cluster object" // @Success 200 {object} mcis.TbClusterInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId}/cluster/{clusterId} [put]

func RestPutMcisPolicy added in v0.2.8

func RestPutMcisPolicy(c echo.Context) error
function RestPutMcisPolicy not yet implemented

// RestPutMcisPolicy godoc // @ID PutMcisPolicy // @Summary Update MCIS Policy // @Description Update MCIS Policy // @Tags [Infra service] MCIS Auto control policy management (WIP) // @Accept json // @Produce json // @Param mcisInfo body McisPolicyInfo true "Details for an MCIS Policy object" // @Success 200 {object} McisPolicyInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId}/policy/mcis/{mcisId} [put]

func RestPutMonitorAgentStatusInstalled added in v0.7.2

func RestPutMonitorAgentStatusInstalled(c echo.Context) error

RestPutMonitorAgentStatusInstalled godoc @ID PutMonitorAgentStatusInstalled @Summary Set monitoring agent (CB-Dragonfly agent) installation status installed (for Windows VM only) @Description Set monitoring agent (CB-Dragonfly agent) installation status installed (for Windows VM only) @Tags [Infra service] MCIS Resource monitor (for developer) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vmId path string true "VM ID" default(vm01) @Success 200 {object} mcis.TbVmInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/monitoring/status/mcis/{mcisId}/vm/{vmId} [put]

func RestPutNLB added in v0.6.1

func RestPutNLB(c echo.Context) error
function RestPutNLB not yet implemented

// RestPutNLB godoc // @ID PutNLB // @Summary Update NLB // @Description Update NLB // @Tags [Infra resource] NLB management // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(ns01) // @Param mcisId path string true "MCIS ID" default(mcis01) // @Param nlbId path string true "NLB ID" default(g1) // @Param nlbInfo body mcis.TbNLBInfo true "Details of the NLB object" // @Success 200 {object} mcis.TbNLBInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId}/mcis/{mcisId}/nlb/{nlbId} [put]

func RestPutSetAutoscaling added in v0.8.1

func RestPutSetAutoscaling(c echo.Context) error

RestPutSetAutoscaling godoc @ID PutSetAutoscaling @Summary Set a NodeGroup's Autoscaling On/Off @Description Set a NodeGroup's Autoscaling On/Off @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param clusterId path string true "Cluster ID" @Param nodeGroupName path string true "NodeGroup Name" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cluster/{clusterId}/nodegroup/{nodeGroupName}/onautoscaling [put]

func RestPutUpgradeCluster added in v0.8.5

func RestPutUpgradeCluster(c echo.Context) error

RestPutClusterUpgrade godoc @ID PutClusterUpgrade @Summary Upgrade a Cluster's version @Description Upgrade a Cluster's version @Tags [Infra resource] Cluster management @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param clusterId path string true "Cluster ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cluster/{clusterId}/upgrade [put]

func RestPutVpnGcpToAws added in v0.8.12

func RestPutVpnGcpToAws(c echo.Context) error

RestPutVpnGcpToAws godoc @ID PutVpnGcpToAws @Summary (To be provided) Update a site-to-site VPN @Description (To be provided) Update a site-to-site VPN @Tags [VPN] Site-to-site VPN (under development) @Accept json @Produce json-stream @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param vpnId path string true "VPN ID" default(vpn01) @Param vpnReq body model.RestPostVpnGcpToAwsRequest true "Resources info for VPN tunnel configuration between GCP and AWS" @Success 200 {object} common.SimpleMsg "OK" @Failure 400 {object} common.SimpleMsg "Bad Request" @Failure 500 {object} common.SimpleMsg "Internal Server Error" @Failure 503 {object} common.SimpleMsg "Service Unavailable" @Router /stream-response/ns/{nsId}/mcis/{mcisId}/vpn/{vpnId} [put]

func RestRecommendVm added in v0.3.7

func RestRecommendVm(c echo.Context) error

RestRecommendVm godoc @ID RecommendVm @Summary Recommend MCIS plan (filter and priority) @Description Recommend MCIS plan (filter and priority) Find details from https://github.com/cloud-barista/cb-tumblebug/discussions/1234 @Tags [Infra service] MCIS Provisioning management @Accept json @Produce json @Param deploymentPlan body mcis.DeploymentPlan false "Recommend MCIS plan (filter and priority)" @Success 200 {object} []mcir.TbSpecInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /mcisRecommendVm [post]

func RestRemoveBastionNodes added in v0.7.9

func RestRemoveBastionNodes(c echo.Context) error

RestRemoveBastionNodes godoc @ID RemoveBastionNodes @Summary Remove a bastion VM from all vNets @Description Remove a bastion VM from all vNets @Tags [Infra service] MCIS Remote command @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param bastionVmId path string true "Bastion VM ID" default(g1-1) @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/bastion/{bastionVmId} [delete]

func RestRemoveNLBVMs added in v0.6.3

func RestRemoveNLBVMs(c echo.Context) error

RestRemoveNLBVMs godoc @ID RemoveNLBVMs @Summary Delete VMs from NLB @Description Delete VMs from NLB @Tags [Infra resource] NLB management (for developer) @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param nlbId path string true "NLB ID" default(g1) @Param nlbAddRemoveVMReq body mcis.TbNLBAddRemoveVMReq true "VMs to add to NLB" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/nlb/{nlbId}/vm [delete]

func RestSetBastionNodes added in v0.7.8

func RestSetBastionNodes(c echo.Context) error

RestSetBastionNodes godoc @ID SetBastionNodes @Summary Set bastion nodes for a VM @Description Set bastion nodes for a VM @Tags [Infra service] MCIS Remote command @Accept json @Produce json @Param nsId path string true "Namespace ID" default(ns01) @Param mcisId path string true "MCIS ID" default(mcis01) @Param targetVmId path string true "Target VM ID" default(g1-1) @Param bastionVmId path string true "Bastion VM ID" default(g1-1) @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/mcis/{mcisId}/vm/{targetVmId}/bastion/{bastionVmId} [put]

Types

type JSONResult added in v0.3.4

type JSONResult struct {
}

JSONResult is a dummy struct for Swagger annotations.

type RestGetAllBenchmarkRequest

type RestGetAllBenchmarkRequest struct {
	Host string `json:"host"`
}

Request struct for RestGetAllBenchmark

type RestGetAllClusterResponse added in v0.8.1

type RestGetAllClusterResponse struct {
	Cluster []mcis.TbClusterInfo `json:"cluster"`
}

Response structure for RestGetAllCluster

type RestGetAllMcisPolicyResponse added in v0.2.8

type RestGetAllMcisPolicyResponse struct {
	McisPolicy []mcis.McisPolicyInfo `json:"mcisPolicy"`
}

Response structure for RestGetAllMcisPolicy

type RestGetAllMcisResponse

type RestGetAllMcisResponse struct {
	Mcis []mcis.TbMcisInfo `json:"mcis"`
}

RestGetAllMcisResponse is a response structure for RestGetAllMcis

type RestGetAllMcisStatusResponse added in v0.2.8

type RestGetAllMcisStatusResponse struct {
	Mcis []mcis.McisStatusInfo `json:"mcis"`
}

RestGetAllMcisStatusResponse is a response structure for RestGetAllMcisStatus

type RestGetAllNLBResponse added in v0.6.1

type RestGetAllNLBResponse struct {
	NLB []mcis.TbNLBInfo `json:"nlb"`
}

Response structure for RestGetAllNLB

type RestGetBenchmarkRequest

type RestGetBenchmarkRequest struct {
	Host string `json:"host"`
}

type RestPostMcisRecommendResponse added in v0.3.8

type RestPostMcisRecommendResponse struct {
	//VmReq          []TbVmRecommendReq    `json:"vmReq"`
	VmRecommend    []mcis.TbVmRecommendInfo `json:"vmRecommend"`
	PlacementAlgo  string                   `json:"placementAlgo"`
	PlacementParam []common.KeyValue        `json:"placementParam"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL