Documentation
¶
Index ¶
- func CreateCloudModel(c echo.Context) error
- func CreateOnPremModel(c echo.Context) error
- func CreateSoftwareModel(c echo.Context) error
- func DeleteCloudModel(c echo.Context) error
- func DeleteOnPremModel(c echo.Context) error
- func DeleteSoftwareModel(c echo.Context) error
- func GetCloudModel(c echo.Context) error
- func GetCloudModels(c echo.Context) error
- func GetModels(c echo.Context) error
- func GetModelsVersion(c echo.Context) error
- func GetOnPremModel(c echo.Context) error
- func GetOnPremModels(c echo.Context) error
- func GetSoftwareModel(c echo.Context) error
- func GetSoftwareModels(c echo.Context) error
- func RestCheckHTTPVersion(c echo.Context) error
- func RestGetReadyz(c echo.Context) error
- func UpdateCloudModel(c echo.Context) error
- func UpdateOnPremModel(c echo.Context) error
- func UpdateSoftwareModel(c echo.Context) error
- type CloudModelReqInfo
- type CloudModelRespInfo
- type CreateCloudModelReq
- type CreateCloudModelResp
- type CreateOnPremModelReq
- type CreateOnPremModelResp
- type CreateSoftwareModelReq
- type CreateSoftwareModelResp
- type GetCloudModelResp
- type GetCloudModelsResp
- type GetModelsResp
- type GetModelsVersionResp
- type GetOnPremModelResp
- type GetOnPremModelsResp
- type GetSoftwareModelResp
- type GetSoftwareModelsResp
- type ModelRespInfo
- type ModelsVersionRespInfo
- type OnPremModelReqInfo
- type OnPremModelRespInfo
- type ResHTTPVersion
- type ResReadyz
- type SoftwareModelReqInfo
- type SoftwareModelRespInfo
- type UpdateCloudModelReq
- type UpdateCloudModelResp
- type UpdateOnPremModelReq
- type UpdateOnPremModelResp
- type UpdateSoftwareModelReq
- type UpdateSoftwareModelResp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateCloudModel ¶
CreateCloudModel godoc @Summary Create a new cloud user model @Description Create a new cloud user model with the given information. @Tags [API] Cloud Migration User Models @Accept json @Produce json @Param Model body CreateCloudModelReq true "model information" @Success 201 {object} CreateCloudModelResp "Successfully Created the Cloud Migration User Model" @Failure 400 {object} object "Invalid Request" @Router /cloudmodel [post]
func CreateOnPremModel ¶
CreateOnPremModel godoc @Summary Create a new on-premise model @Description Create a new on-premise model with the given information. @Tags [API] On-Premise Migration User Models @Accept json @Produce json @Param Model body CreateOnPremModelReq true "model information" @Success 201 {object} CreateOnPremModelResp "Successfully Created the On-Premise Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} model.Response @Failure 500 {object} model.Response @Router /onpremmodel [post]
func CreateSoftwareModel ¶ added in v0.3.2
CreateSoftwareModel godoc @Summary Create a new software user model @Description Create a new software user model with the given information. @Tags [API] Software Migration User Models @Accept json @Produce json @Param Model body CreateSoftwareModelReq true "model information" @Success 201 {object} CreateSoftwareModelResp "Successfully Created the Software Migration User Model" @Failure 400 {object} object "Invalid Request" @Router /softwaremodel [post]
func DeleteCloudModel ¶
DeleteCloudModel godoc @Summary Delete a cloud user model @Description Delete a cloud user model with the given information. @Tags [API] Cloud Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Success 200 {string} string "Successfully Deleted the Cloud Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "Model Not Found" @Failure 500 {object} model.Response @Router /cloudmodel/{id} [delete]
func DeleteOnPremModel ¶
DeleteOnPremModel godoc @Summary Delete a on-premise model @Description Delete a on-premise model with the given information. @Tags [API] On-Premise Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Success 200 {string} string "Successfully Deleted the On-Premise Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "Model Not Found" @Failure 500 {object} model.Response @Router /onpremmodel/{id} [delete]
func DeleteSoftwareModel ¶ added in v0.3.2
DeleteSoftwareModel godoc @Summary Delete a software user model @Description Delete a software user model with the given information. @Tags [API] Software Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Success 200 {string} string "Successfully Deleted the Software Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "Model Not Found" @Failure 500 {object} model.Response @Router /softwaremodel/{id} [delete]
func GetCloudModel ¶
GetCloudModel godoc @Summary Get a specific cloud user model @Description Get a specific cloud user model. @Tags [API] Cloud Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Success 200 {object} GetCloudModelResp "Successfully Obtained the Cloud Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "Model Not Found" @Router /cloudmodel/{id} [get]
func GetCloudModels ¶
GetCloudModels godoc @Summary Get a list of cloud user models @Description Get a list of cloud user models. @Tags [API] Cloud Migration User Models @Accept json @Produce json @Success 200 {object} GetCloudModelsResp "Successfully Obtained Cloud Migration User Models" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} model.Response @Router /cloudmodel [get]
func GetModels ¶
GetModels godoc @Summary Get a list of all user models @Description Get a list of all user models. @Tags [API] Migration User Models @Accept json @Produce json @Param isTargetModel path bool true "Is TargetModel ?" @Success 200 {object} GetModelsResp "Successfully Obtained Migration User Models." @Failure 404 {object} model.Response @Failure 500 {object} model.Response @Router /model/{isTargetModel} [get]
func GetModelsVersion ¶
GetModelsVersion godoc @Summary Get the versions of all models(schemata of on-premise/cloud migration models) @Description Get the versions of all models(schemata of on-premise/cloud migration models) @Tags [API] Migration Models @Accept json @Produce json @Success 200 {object} GetModelsVersionResp "This is the versions of all models(schemata)" @Failure 404 {object} model.Response @Failure 500 {object} model.Response @Router /model/version [get]
func GetOnPremModel ¶
GetOnPremModel godoc @Summary Get a specific on-premise model @Description Get a specific on-premise model. @Tags [API] On-Premise Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Success 200 {object} GetOnPremModelResp "Successfully Obtained the On-Premise Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "Model Not Found" @Failure 500 {object} model.Response @Router /onpremmodel/{id} [get]
func GetOnPremModels ¶
GetOnPremModels godoc @Summary Get a list of on-premise models @Description Get a list of on-premise models. @Tags [API] On-Premise Migration User Models @Accept json @Produce json @Success 200 {object} GetOnPremModelsResp "Successfully Obtained On-Premise Migration User Models" @Failure 404 {object} model.Response @Failure 500 {object} model.Response @Router /onpremmodel [get]
func GetSoftwareModel ¶ added in v0.3.2
GetSoftwareModel godoc @Summary Get a specific software user model @Description Get a specific software user model. @Tags [API] Software Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Success 200 {object} GetSoftwareModelResp "Successfully Obtained the Software Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "Model Not Found" @Router /softwaremodel/{id} [get]
func GetSoftwareModels ¶ added in v0.3.2
GetSoftwareModels godoc @Summary Get a list of software user models @Description Get a list of software user models. @Tags [API] Software Migration User Models @Accept json @Produce json @Success 200 {object} GetSoftwareModelsResp "Successfully Obtained Software Migration User Models" @Failure 404 {object} model.Response @Router /softwaremodel [get]
func RestCheckHTTPVersion ¶
RestCheckHTTPVersion godoc @Summary Check HTTP version of incoming request @Description Checks and logs the HTTP version of the incoming request to the server console. @Tags [Admin] System management @Accept json @Produce json @Success 200 {object} ResHTTPVersion @Failure 404 {object} ResHTTPVersion @Failure 500 {object} ResHTTPVersion @Router /httpVersion [get]
func RestGetReadyz ¶
RestGetReadyz func check if CM-Damselfly server is ready or not. RestGetReadyz godoc @Summary Check Damselfly is ready @Description Check Damselfly is ready @Tags [Admin] System management @Accept json @Produce json @Success 200 {object} ResReadyz @Failure 503 {object} ResReadyz @Router /readyz [get]
func UpdateCloudModel ¶
UpdateCloudModel godoc @Summary Update a cloud user model @Description Update a cloud user model with the given information. @Tags [API] Cloud Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Param Model body UpdateCloudModelReq true "Model information to update" @Success 201 {object} UpdateCloudModelResp "Successfully Updated the Cloud Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "Model Not Found" @Failure 500 {object} model.Response @Router /cloudmodel/{id} [put]
func UpdateOnPremModel ¶
UpdateOnPremModel godoc @Summary Update a on-premise model @Description Update a on-premise model with the given information. @Tags [API] On-Premise Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Param Model body UpdateOnPremModelReq true "Model information to update" @Success 201 {object} UpdateOnPremModelResp "Successfully Updated the On-Premise Migration User Model" @Failure 404 {object} object "Model Not Found" @Failure 500 {object} model.Response @Router /onpremmodel/{id} [put]
func UpdateSoftwareModel ¶ added in v0.3.2
UpdateSoftwareModel godoc @Summary Update a software user model @Description Update a software user model with the given information. @Tags [API] Software Migration User Models @Accept json @Produce json @Param id path string true "Model ID" @Param Model body UpdateSoftwareModelReq true "Model information to update" @Success 201 {object} UpdateSoftwareModelResp "Successfully Updated the Software Migration User Model" @Failure 400 {object} object "Invalid Request" @Failure 404 {object} object "Model Not Found" @Failure 500 {object} model.Response @Router /softwaremodel/{id} [put]
Types ¶
type CloudModelReqInfo ¶
type CloudModelReqInfo struct {
UserId string `json:"userId"`
IsTargetModel bool `json:"isTargetModel"`
IsInitUserModel bool `json:"isInitUserModel"`
UserModelName string `json:"userModelName"`
Description string `json:"description"`
UserModelVer string `json:"userModelVersion"`
CSP string `json:"csp"`
Region string `json:"region"`
Zone string `json:"zone"`
CloudInfraModel cloudmodel.RecommendedVmInfra `json:"cloudInfraModel" validate:"required"`
}
type CloudModelRespInfo ¶
type CloudModelRespInfo struct {
Id string `json:"id"`
UserId string `json:"userId"`
IsTargetModel bool `json:"isTargetModel"`
IsInitUserModel bool `json:"isInitUserModel"`
UserModelName string `json:"userModelName"`
Description string `json:"description"`
UserModelVer string `json:"userModelVersion"`
CreateTime string `json:"createTime"`
UpdateTime string `json:"updateTime"`
CSP string `json:"csp"`
Region string `json:"region"`
Zone string `json:"zone"`
IsCloudModel bool `json:"isCloudModel"`
CloudModelVer string `json:"cloudModelVersion"`
CloudInfraModel cloudmodel.RecommendedVmInfra `json:"cloudInfraModel" validate:"required"`
}
type CreateCloudModelReq ¶
type CreateCloudModelReq struct {
CloudModelReqInfo
}
[Note] Struct Embedding is used to inherit the fields of CloudModel
type CreateCloudModelResp ¶
type CreateCloudModelResp struct {
CloudModelRespInfo
}
[Note] Struct Embedding is used to inherit the fields of CloudModel
type CreateOnPremModelReq ¶
type CreateOnPremModelReq struct {
OnPremModelReqInfo
}
[Note] Struct Embedding is used to inherit the fields of OnPremModel
type CreateOnPremModelResp ¶
type CreateOnPremModelResp struct {
OnPremModelRespInfo
}
[Note] Struct Embedding is used to inherit the fields of OnPremModel
type CreateSoftwareModelReq ¶ added in v0.3.2
type CreateSoftwareModelReq struct {
SoftwareModelReqInfo
}
[Note] Struct Embedding is used to inherit the fields of SoftwareModel
type CreateSoftwareModelResp ¶ added in v0.3.2
type CreateSoftwareModelResp struct {
SoftwareModelRespInfo
}
[Note] Struct Embedding is used to inherit the fields of SoftwareModel
type GetCloudModelResp ¶
type GetCloudModelResp struct {
CloudModelRespInfo
}
type GetCloudModelsResp ¶
type GetCloudModelsResp struct {
Models []CloudModelRespInfo `json:"models"`
}
type GetModelsResp ¶
type GetModelsResp struct {
Models []ModelRespInfo `json:"models"`
}
type GetModelsVersionResp ¶
type GetModelsVersionResp struct {
ModelsVersion ModelsVersionRespInfo `json:"modelsVersion"`
}
type GetOnPremModelResp ¶
type GetOnPremModelResp struct {
OnPremModelRespInfo
}
type GetOnPremModelsResp ¶
type GetOnPremModelsResp struct {
Models []OnPremModelRespInfo `json:"models"`
}
type GetSoftwareModelResp ¶ added in v0.3.2
type GetSoftwareModelResp struct {
SoftwareModelRespInfo
}
type GetSoftwareModelsResp ¶ added in v0.3.2
type GetSoftwareModelsResp struct {
Models []SoftwareModelRespInfo `json:"models"`
}
type ModelRespInfo ¶
type ModelRespInfo struct {
Id string `json:"id"`
UserId string `json:"userId"`
IsInitUserModel bool `json:"isInitUserModel"`
UserModelName string `json:"userModelName"`
Description string `json:"description"`
UserModelVer string `json:"userModelVersion"`
CreateTime string `json:"createTime"`
UpdateTime string `json:"updateTime"`
IsTargetModel bool `json:"isTargetModel"`
IsCloudModel bool `json:"isCloudModel"`
OnPremModelVer string `json:"onpremModelVersion"`
CloudModelVer string `json:"cloudModelVersion"`
CSP string `json:"csp"`
Region string `json:"region"`
Zone string `json:"zone"`
OnpremInfraModel onpremisemodel.OnpremInfra `json:"onpremiseInfraModel" validate:"required"`
CloudInfraModel cloudmodel.RecommendedVmInfra `json:"cloudInfraModel" validate:"required"`
}
type ModelsVersionRespInfo ¶
type OnPremModelReqInfo ¶
type OnPremModelReqInfo struct {
UserId string `json:"userId"`
IsInitUserModel bool `json:"isInitUserModel"`
UserModelName string `json:"userModelName"`
UserModelVer string `json:"userModelVersion"`
Description string `json:"description"`
OnpremInfraModel onpremisemodel.OnpremInfra `json:"onpremiseInfraModel" validate:"required"`
}
type OnPremModelRespInfo ¶
type OnPremModelRespInfo struct {
Id string `json:"id"`
UserId string `json:"userId"`
IsInitUserModel bool `json:"isInitUserModel"`
UserModelName string `json:"userModelName"`
UserModelVer string `json:"userModelVersion"`
Description string `json:"description"`
OnPremModelVer string `json:"onpremModelVersion"`
CreateTime string `json:"createTime"`
UpdateTime string `json:"updateTime"`
IsTargetModel bool `json:"isTargetModel"`
IsCloudModel bool `json:"isCloudModel"`
OnpremInfraModel onpremisemodel.OnpremInfra `json:"onpremiseInfraModel" validate:"required"`
}
type ResHTTPVersion ¶
type ResHTTPVersion struct {
model.SimpleMessage
}
type ResReadyz ¶
type ResReadyz struct {
model.SimpleMessage
}
type SoftwareModelReqInfo ¶ added in v0.3.2
type SoftwareModelReqInfo struct {
UserId string `json:"userId"`
IsTargetModel bool `json:"isTargetModel"`
IsInitUserModel bool `json:"isInitUserModel"`
UserModelName string `json:"userModelName"`
UserModelVer string `json:"userModelVersion"`
Description string `json:"description"`
SoftwareModel softwaremodel.SourceGroupSoftwareProperty `json:"softwareModel" validate:"required"`
}
type SoftwareModelRespInfo ¶ added in v0.3.2
type SoftwareModelRespInfo struct {
Id string `json:"id"`
UserId string `json:"userId"`
IsTargetModel bool `json:"isTargetModel"`
IsInitUserModel bool `json:"isInitUserModel"`
UserModelName string `json:"userModelName"`
UserModelVer string `json:"userModelVersion"`
Description string `json:"description"`
SoftwareModelVer string `json:"softwareModelVersion"`
CreateTime string `json:"createTime"`
UpdateTime string `json:"updateTime"`
IsSoftwareModel bool `json:"isSoftwareModel"`
SoftwareModel softwaremodel.SourceGroupSoftwareProperty `json:"softwareModel" validate:"required"`
}
type UpdateCloudModelReq ¶
type UpdateCloudModelReq struct {
CloudModelReqInfo
}
[Note] Struct Embedding is used to inherit the fields of CloudModel
type UpdateCloudModelResp ¶
type UpdateCloudModelResp struct {
CloudModelRespInfo
}
[Note] Struct Embedding is used to inherit the fields of CloudModel
type UpdateOnPremModelReq ¶
type UpdateOnPremModelReq struct {
OnPremModelReqInfo
}
[Note] Struct Embedding is used to inherit the fields of OnPremModel
type UpdateOnPremModelResp ¶
type UpdateOnPremModelResp struct {
OnPremModelRespInfo
}
[Note] Struct Embedding is used to inherit the fields of OnPremModel
type UpdateSoftwareModelReq ¶ added in v0.3.2
type UpdateSoftwareModelReq struct {
SoftwareModelReqInfo
}
[Note] Struct Embedding is used to inherit the fields of SoftwareModel
type UpdateSoftwareModelResp ¶ added in v0.3.2
type UpdateSoftwareModelResp struct {
SoftwareModelRespInfo
}
[Note] Struct Embedding is used to inherit the fields of SoftwareModel