mcis

package
v0.6.16 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2022 License: Apache-2.0 Imports: 5 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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RestAddNLBVMs added in v0.6.3 

func RestAddNLBVMs(c echo.Context) error

RestAddNLBVMs godoc @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 @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 @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 @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 @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 @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 @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 @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 RestGetAllBenchmark 

func RestGetAllBenchmark(c echo.Context) error

RestGetAllBenchmark godoc @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 RestGetAllMcis 

func RestGetAllMcis(c echo.Context) error

RestGetAllMcis godoc @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 @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 @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 RestGetBenchmark 

func RestGetBenchmark(c echo.Context) error

RestGetBenchmark godoc @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 RestGetControlMcis added in v0.4.4 

func RestGetControlMcis(c echo.Context) error

RestGetControlMcis godoc @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) @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 @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) @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 @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 @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 @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 @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 @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 @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 @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 @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 RestPostCmdMcis 

func RestPostCmdMcis(c echo.Context) error

RestPostCmdMcis godoc @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("") @Success 200 {object} RestPostCmdMcisResponseWrapper @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cmd/mcis/{mcisId} [post]

func RestPostCmdMcisVm 

func RestPostCmdMcisVm(c echo.Context) error

RestPostCmdMcisVm godoc @Summary Send a command to specified VM @Description Send a command to specified 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 vmId path string true "VM ID" default(g1-1) @Param mcisCmdReq body mcis.McisCmdReq true "MCIS Command Request" @Success 200 {object} RestPostCmdMcisVmResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/cmd/mcis/{mcisId}/vm/{vmId} [post]

func RestPostConfigureCloudAdaptiveNetworkToMcis added in v0.5.1 

func RestPostConfigureCloudAdaptiveNetworkToMcis(c echo.Context) error

RestPostConfigureCloudAdaptiveNetworkToMcis godoc @Summary Configure Cloud Adaptive Network (cb-network agent) to MCIS @Description Configure Cloud Adaptive Network (cb-network agent) to MCIS @Tags [Infra service] MCIS Cloud Adaptive Network (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 networkReq body mcis.NetworkReq true "Details for the network request body" @Success 200 {object} mcis.AgentInstallContentWrapper @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/network/mcis/{mcisId} [post]

func RestPostInstallBenchmarkAgentToMcis added in v0.4.9 

func RestPostInstallBenchmarkAgentToMcis(c echo.Context) error

RestPostInstallBenchmarkAgentToMcis godoc @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" @Success 200 {object} mcis.RestPostCmdMcisResponseWrapper @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 @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 @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.TbMcisInfo @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 @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 @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 "Details for MCIS object" @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 @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 @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 RestPostMcisRecommend added in v0.3.8 

func RestPostMcisRecommend(c echo.Context) error

RestPostMcisRecommend godoc @Deprecated

func RestPostMcisSubGroupScaleOut added in v0.6.10 

func RestPostMcisSubGroupScaleOut(c echo.Context) error

RestPostMcisSubGroupScaleOut godoc @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 @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 @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 @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 @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 RestPostRegisterCSPNativeVM added in v0.5.1 

func RestPostRegisterCSPNativeVM(c echo.Context) error

RestPostRegisterCSPNativeVM godoc @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 @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 RestPutInjectCloudInformationForCloudAdaptiveNetwork added in v0.5.4 

func RestPutInjectCloudInformationForCloudAdaptiveNetwork(c echo.Context) error

RestPutInjectCloudInformationForCloudAdaptiveNetwork godoc @Summary Inject Cloud Information For Cloud Adaptive Network @Description Inject Cloud Information For Cloud Adaptive Network @Tags [Infra service] MCIS Cloud Adaptive Network (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 networkReq body mcis.NetworkReq true "Details for the network request body" @Success 200 {object} mcis.AgentInstallContentWrapper @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/network/mcis/{mcisId} [put]

func RestPutMcisPolicy added in v0.2.8 

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

// RestPutMcisPolicy godoc // @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 RestPutNLB added in v0.6.1 

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

// RestPutNLB godoc // @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 RestRecommendVm added in v0.3.7 

func RestRecommendVm(c echo.Context) error

RestRecommendVm godoc @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 RestRemoveNLBVMs added in v0.6.3 

func RestRemoveNLBVMs(c echo.Context) error

RestRemoveNLBVMs godoc @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]

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 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 RestPostCmdMcisResponse 

type RestPostCmdMcisResponse struct {
	McisId string `json:"mcisId"`
	VmId   string `json:"vmId"`
	VmIp   string `json:"vmIp"`
	Result string `json:"result"`
}

type RestPostCmdMcisResponseWrapper 

type RestPostCmdMcisResponseWrapper struct {
	ResultArray []RestPostCmdMcisResponse `json:"resultArray"`
}

type RestPostCmdMcisVmResponse 

type RestPostCmdMcisVmResponse struct {
	Result string `json:"result"`
}

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"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.