Documentation ¶
Index ¶
- func RestCheckResource(c echo.Context) error
- func RestDelAllImage(c echo.Context) error
- func RestDelAllResources(c echo.Context) error
- func RestDelAllSecurityGroup(c echo.Context) error
- func RestDelAllSpec(c echo.Context) error
- func RestDelAllSshKey(c echo.Context) error
- func RestDelAllVNet(c echo.Context) error
- func RestDelImage(c echo.Context) error
- func RestDelResource(c echo.Context) error
- func RestDelSecurityGroup(c echo.Context) error
- func RestDelSpec(c echo.Context) error
- func RestDelSshKey(c echo.Context) error
- func RestDelVNet(c echo.Context) error
- func RestFetchImages(c echo.Context) error
- func RestFetchSpecs(c echo.Context) error
- func RestFilterSpecs(c echo.Context) error
- func RestFilterSpecsByRange(c echo.Context) error
- func RestGetAllImage(c echo.Context) error
- func RestGetAllResources(c echo.Context) error
- func RestGetAllSecurityGroup(c echo.Context) error
- func RestGetAllSpec(c echo.Context) error
- func RestGetAllSshKey(c echo.Context) error
- func RestGetAllVNet(c echo.Context) error
- func RestGetImage(c echo.Context) error
- func RestGetResource(c echo.Context) error
- func RestGetSecurityGroup(c echo.Context) error
- func RestGetSpec(c echo.Context) error
- func RestGetSshKey(c echo.Context) error
- func RestGetVNet(c echo.Context) error
- func RestLookupImage(c echo.Context) error
- func RestLookupImageList(c echo.Context) error
- func RestLookupSpec(c echo.Context) error
- func RestLookupSpecList(c echo.Context) error
- func RestPostImage(c echo.Context) error
- func RestPostSecurityGroup(c echo.Context) error
- func RestPostSpec(c echo.Context) error
- func RestPostSshKey(c echo.Context) error
- func RestPostVNet(c echo.Context) error
- func RestPutImage(c echo.Context) error
- func RestPutSecurityGroup(c echo.Context) error
- func RestPutSpec(c echo.Context) error
- func RestPutSshKey(c echo.Context) error
- func RestPutVNet(c echo.Context) error
- func RestSearchImage(c echo.Context) error
- func RestTestSortSpecs(c echo.Context) error
- type RestFilterSpecsResponse
- type RestGetAllImageResponse
- type RestGetAllSecurityGroupResponse
- type RestGetAllSpecResponse
- type RestGetAllSshKeyResponse
- type RestGetAllVNetResponse
- type RestLookupImageRequest
- type RestLookupSpecRequest
- type RestSearchImageRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RestCheckResource ¶
func RestCheckResource(c echo.Context) error
func RestDelAllImage ¶
func RestDelAllImage(c echo.Context) error
RestDelAllImage godoc @Summary Delete all images @Description Delete all images @Tags Image @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/image [delete]
func RestDelAllResources ¶
func RestDelAllResources(c echo.Context) error
func RestDelAllSecurityGroup ¶
func RestDelAllSecurityGroup(c echo.Context) error
RestDelAllSecurityGroup godoc @Summary Delete all Security Groups @Description Delete all Security Groups @Tags Security Group @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/securityGroup [delete]
func RestDelAllSpec ¶
func RestDelAllSpec(c echo.Context) error
RestDelAllSpec godoc @Summary Delete all specs @Description Delete all specs @Tags Spec @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/spec [delete]
func RestDelAllSshKey ¶
func RestDelAllSshKey(c echo.Context) error
RestDelAllSshKey godoc @Summary Delete all SSH Keys @Description Delete all SSH Keys @Tags SSH Key @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/sshKey [delete]
func RestDelAllVNet ¶
func RestDelAllVNet(c echo.Context) error
RestDelAllVNet godoc @Summary Delete all VNets @Description Delete all VNets @Tags VNet @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/vNet [delete]
func RestDelImage ¶
func RestDelImage(c echo.Context) error
RestDelImage godoc @Summary Delete image @Description Delete image @Tags Image @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param imageId path string true "Image ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/image/{imageId} [delete]
func RestDelResource ¶
func RestDelResource(c echo.Context) error
func RestDelSecurityGroup ¶
func RestDelSecurityGroup(c echo.Context) error
RestDelSecurityGroup godoc @Summary Delete Security Group @Description Delete Security Group @Tags Security Group @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param securityGroupId path string true "Security Group ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/securityGroup/{securityGroupId} [delete]
func RestDelSpec ¶
func RestDelSpec(c echo.Context) error
RestDelSpec godoc @Summary Delete spec @Description Delete spec @Tags Spec @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param specId path string true "Spec ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/spec/{specId} [delete]
func RestDelSshKey ¶
func RestDelSshKey(c echo.Context) error
RestDelSshKey godoc @Summary Delete SSH Key @Description Delete SSH Key @Tags SSH Key @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param sshKeyId path string true "SSH Key ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/sshKey/{sshKeyId} [delete]
func RestDelVNet ¶
func RestDelVNet(c echo.Context) error
RestDelVNet godoc @Summary Delete VNet @Description Delete VNet @Tags VNet @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param vNetId path string true "VNet ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId}/resources/vNet/{vNetId} [delete]
func RestFetchImages ¶
func RestFetchImages(c echo.Context) error
RestFetchImages godoc @Summary Fetch images @Description Fetch images @Tags Image @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/fetchImages [post]
func RestFetchSpecs ¶
func RestFetchSpecs(c echo.Context) error
RestFetchSpecs godoc @Summary Fetch specs @Description Fetch specs @Tags Spec @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/fetchSpecs [post]
func RestFilterSpecs ¶ added in v0.2.8
func RestFilterSpecs(c echo.Context) error
RestFilterSpecs godoc @Summary Filter specs @Description Filter specs @Tags Spec @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param specFilter body mcir.TbSpecInfo false "Filter for filtering specs" @Success 200 {object} RestFilterSpecsResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/filterSpecs [post]
func RestFilterSpecsByRange ¶ added in v0.2.8
func RestFilterSpecsByRange(c echo.Context) error
RestFilterSpecsByRange godoc @Summary Filter specs by range @Description Filter specs by range @Tags Spec @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param specRangeFilter body mcir.FilterSpecsByRangeRequest false "Filter for range-filtering specs" @Success 200 {object} RestFilterSpecsResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/filterSpecsByRange [post]
func RestGetAllImage ¶
func RestGetAllImage(c echo.Context) error
RestGetAllImage godoc @Summary List all images @Description List all images @Tags Image @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} RestGetAllImageResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/image [get]
func RestGetAllResources ¶
func RestGetAllResources(c echo.Context) error
func RestGetAllSecurityGroup ¶
func RestGetAllSecurityGroup(c echo.Context) error
RestGetAllSecurityGroup godoc @Summary List all Security Groups @Description List all Security Groups @Tags Security Group @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} RestGetAllSecurityGroupResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/securityGroup [get]
func RestGetAllSpec ¶
func RestGetAllSpec(c echo.Context) error
RestGetAllSpec godoc @Summary List all specs @Description List all specs @Tags Spec @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} RestGetAllSpecResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/spec [get]
func RestGetAllSshKey ¶
func RestGetAllSshKey(c echo.Context) error
RestGetAllSshKey godoc @Summary List all SSH Keys @Description List all SSH Keys @Tags SSH Key @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} RestGetAllSshKeyResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/sshKey [get]
func RestGetAllVNet ¶
func RestGetAllVNet(c echo.Context) error
RestGetAllVNet godoc @Summary List all VNets @Description List all VNets @Tags VNet @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} RestGetAllVNetResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/vNet [get]
func RestGetImage ¶
func RestGetImage(c echo.Context) error
RestGetImage godoc @Summary Get image @Description Get image @Tags Image @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param imageId path string true "Image ID" @Success 200 {object} mcir.TbImageInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/image/{imageId} [get]
func RestGetResource ¶
func RestGetResource(c echo.Context) error
func RestGetSecurityGroup ¶
func RestGetSecurityGroup(c echo.Context) error
RestGetSecurityGroup godoc @Summary Get Security Group @Description Get Security Group @Tags Security Group @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param securityGroupId path string true "Security Group ID" @Success 200 {object} mcir.TbSecurityGroupInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/securityGroup/{securityGroupId} [get]
func RestGetSpec ¶
func RestGetSpec(c echo.Context) error
RestGetSpec godoc @Summary Get spec @Description Get spec @Tags Spec @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param specId path string true "Spec ID" @Success 200 {object} mcir.TbSpecInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/spec/{specId} [get]
func RestGetSshKey ¶
func RestGetSshKey(c echo.Context) error
RestGetSshKey godoc @Summary Get SSH Key @Description Get SSH Key @Tags SSH Key @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param sshKeyId path string true "SSH Key ID" @Success 200 {object} mcir.TbSshKeyInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/sshKey/{sshKeyId} [get]
func RestGetVNet ¶
func RestGetVNet(c echo.Context) error
RestGetVNet godoc @Summary Get VNet @Description Get VNet @Tags VNet @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param vNetId path string true "VNet ID" @Success 200 {object} mcir.TbVNetInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/vNet/{vNetId} [get]
func RestLookupImage ¶
func RestLookupImage(c echo.Context) error
RestLookupImage godoc @Summary Lookup image @Description Lookup image @Tags Image @Accept json @Produce json @Param connectionName body RestLookupImageRequest true "Specify connectionName" @Param imageId path string true "Image ID" @Success 200 {object} mcir.SpiderImageInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /lookupImage/{imageId} [get]
func RestLookupImageList ¶
func RestLookupImageList(c echo.Context) error
RestLookupImageList godoc @Summary Lookup image list @Description Lookup image list @Tags Image @Accept json @Produce json @Param connectionName body RestLookupImageRequest true "Specify connectionName" @Success 200 {object} mcir.SpiderImageList @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /lookupImage [get]
func RestLookupSpec ¶
func RestLookupSpec(c echo.Context) error
RestLookupSpec godoc @Summary Lookup spec @Description Lookup spec @Tags Spec @Accept json @Produce json @Param connectionName body RestLookupSpecRequest true "Specify connectionName" @Param specName path string true "Spec name" @Success 200 {object} mcir.SpiderSpecInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /lookupSpec/{specName} [get]
func RestLookupSpecList ¶
func RestLookupSpecList(c echo.Context) error
RestLookupSpecList godoc @Summary Lookup spec list @Description Lookup spec list @Tags Spec @Accept json @Produce json @Param connectionName body RestLookupSpecRequest true "Specify connectionName" @Success 200 {object} mcir.SpiderSpecList @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /lookupSpec [get]
func RestPostImage ¶
func RestPostImage(c echo.Context) error
RestPostImage godoc @Summary Register image @Description Register image @Tags Image @Accept json @Produce json @Param registeringMethod query string true "registerWithInfo or registerWithId" @Param nsId path string true "Namespace ID" @Param imageInfo body mcir.TbImageInfo false "Details for an image object" @Param imageId body mcir.TbImageReq false "name, connectionName and cspImageId" @Success 200 {object} mcir.TbImageInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/image [post]
func RestPostSecurityGroup ¶
func RestPostSecurityGroup(c echo.Context) error
RestPostSecurityGroup godoc @Summary Create Security Group @Description Create Security Group @Tags Security Group @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param securityGroupReq body mcir.TbSecurityGroupReq true "Details for an securityGroup object" @Success 200 {object} mcir.TbSecurityGroupInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/securityGroup [post]
func RestPostSpec ¶
func RestPostSpec(c echo.Context) error
RestPostSpec godoc @Summary Register spec @Description Register spec @Tags Spec @Accept json @Produce json @Param registeringMethod query string true "registerWithInfo or else" @Param nsId path string true "Namespace ID" @Param specInfo body mcir.TbSpecInfo false "Details for an spec object" @Param specName body mcir.TbSpecReq false "name, connectionName and cspSpecName" @Success 200 {object} mcir.TbSpecInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/spec [post]
func RestPostSshKey ¶
func RestPostSshKey(c echo.Context) error
RestPostSshKey godoc @Summary Create SSH Key @Description Create SSH Key @Tags SSH Key @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param sshKeyInfo body mcir.TbSshKeyReq true "Details for an SSH Key object" @Success 200 {object} mcir.TbSshKeyInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/sshKey [post]
func RestPostVNet ¶
func RestPostVNet(c echo.Context) error
RestPostVNet godoc @Summary Create VNet @Description Create VNet @Tags VNet @Accept json @Produce json @Param nsId path string true "Namespace ID" @Param vNetReq body mcir.TbVNetReq true "Details for an VNet object" @Success 200 {object} mcir.TbVNetInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/vNet [post]
func RestPutImage ¶
func RestPutImage(c echo.Context) error
function RestPutImage not yet implemented
// RestPutImage godoc // @Summary Update image // @Description Update image // @Tags Image // @Accept json // @Produce json // @Param imageInfo body mcir.TbImageInfo true "Details for an image object" // @Success 200 {object} mcir.TbImageInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId}/resources/image/{imageId} [put]
func RestPutSecurityGroup ¶
func RestPutSecurityGroup(c echo.Context) error
function RestPutSecurityGroup not yet implemented
// RestPutSecurityGroup godoc // @Summary Update Security Group // @Description Update Security Group // @Tags Security Group // @Accept json // @Produce json // @Param securityGroupInfo body mcir.TbSecurityGroupInfo true "Details for an securityGroup object" // @Success 200 {object} mcir.TbSecurityGroupInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId}/resources/securityGroup/{securityGroupId} [put]
func RestPutSpec ¶
func RestPutSpec(c echo.Context) error
RestPutSpec godoc @Summary Update spec @Description Update spec @Tags Spec @Accept json @Produce json @Param specInfo body mcir.TbSpecInfo true "Details for an spec object" @Success 200 {object} mcir.TbSpecInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/spec/{specId} [put]
func RestPutSshKey ¶
func RestPutSshKey(c echo.Context) error
function RestPutSshKey not yet implemented
// RestPutSshKey godoc // @Summary Update SSH Key // @Description Update SSH Key // @Tags SSH Key // @Accept json // @Produce json // @Param sshKeyInfo body mcir.TbSshKeyInfo true "Details for an SSH Key object" // @Success 200 {object} mcir.TbSshKeyInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId}/resources/sshKey/{sshKeyId} [put]
func RestPutVNet ¶
func RestPutVNet(c echo.Context) error
function RestPutVNet not yet implemented
// RestPutVNet godoc // @Summary Update VNet // @Description Update VNet // @Tags VNet // @Accept json // @Produce json // @Param vNetInfo body mcir.TbVNetInfo true "Details for an VNet object" // @Success 200 {object} mcir.TbVNetInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId}/resources/vNet/{vNetId} [put]
func RestSearchImage ¶ added in v0.2.8
func RestSearchImage(c echo.Context) error
RestSearchImage godoc @Summary Search image @Description Search image @Tags Image @Accept json @Produce json @Param keywords body RestSearchImageRequest true "Keywords" @Success 200 {object} RestGetAllImageResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId}/resources/searchImage [get]
func RestTestSortSpecs ¶ added in v0.2.8
func RestTestSortSpecs(c echo.Context) error
Types ¶
type RestFilterSpecsResponse ¶ added in v0.2.8
type RestFilterSpecsResponse struct {
Spec []mcir.TbSpecInfo `json:"spec"`
}
Response structure for RestFilterSpecs
type RestGetAllImageResponse ¶
type RestGetAllImageResponse struct {
Image []mcir.TbImageInfo `json:"image"`
}
Response structure for RestGetAllImage
type RestGetAllSecurityGroupResponse ¶
type RestGetAllSecurityGroupResponse struct {
SecurityGroup []mcir.TbSecurityGroupInfo `json:"securityGroup"`
}
Response structure for RestGetAllSecurityGroup
type RestGetAllSpecResponse ¶
type RestGetAllSpecResponse struct {
Spec []mcir.TbSpecInfo `json:"spec"`
}
Response structure for RestGetAllSpec
type RestGetAllSshKeyResponse ¶
type RestGetAllSshKeyResponse struct {
SshKey []mcir.TbSshKeyInfo `json:"sshKey"`
}
Response struct for RestGetAllSshKey
type RestGetAllVNetResponse ¶
type RestGetAllVNetResponse struct {
VNet []mcir.TbVNetInfo `json:"vNet"`
}
Response structure for RestGetAllVNet
type RestLookupImageRequest ¶
type RestLookupImageRequest struct {
ConnectionName string `json:"connectionName"`
}
Request structure for RestLookupImage
type RestLookupSpecRequest ¶
type RestLookupSpecRequest struct {
ConnectionName string `json:"connectionName"`
}
Request structure for RestLookupSpec
type RestSearchImageRequest ¶ added in v0.2.8
type RestSearchImageRequest struct {
Keywords []string `json:"keywords"`
}
Response structure for RestSearchImage