pcm-coordinator/api/desc/pcm.api

359 lines
13 KiB
Plaintext

syntax = "v1"
import (
"core/pcm-core.api"
"hpc/pcm-hpc.api"
"ai/pcm-ai.api"
"storage/pcm-storage.api"
"vm/pcm-vm.api"
"cloud/pcm-cloud.api"
"storelink/pcm-storelink.api"
)
info(
title: "type title here"
desc: "type desc here"
author: "type author here"
email: "type email here"
version: "type version here"
)
//core端接口
@server(
prefix: pcm/v1
group : core
)
service pcm {
@handler participantListHandler
get /core/participantList returns (participantListResp)
@handler scheduleTaskByYamlHandler
post /core/scheduleTaskByYaml (scheduleTaskByYamlReq)
@handler deleteTaskHandler
delete /core/deleteTask/:id (deleteTaskReq)
@handler scheduleTaskHandler
post /core/scheduleTask (scheduleTaskReq)
@handler TaskListHandler
get /core/taskList returns (taskListResp)
@handler JobTotalHandler
get /core/jobTotal returns (jobTotalResp)
@handler listCenterHandler
get /core/listCenter returns (listCenterResp)
@handler listClusterHandler
get /core/listCluster/:centerId (listClusterReq) returns (listClusterResp)
@handler submitJobHandler
post /core/submitJob (submitJobReq) returns (submitJobResp)
@handler getRegionHandler
get /core/getRegion returns (getRegionResp)
@handler listRegionHandler
get /core/listRegion returns (listRegionResp)
@handler getComputingPowerHandler
get /core/getComputingPower returns (cpResp)
@handler getGeneralInfoHandler
get /core/getGeneralInfo returns (GiResp)
@handler listDomainResourceHandler
get /core/listDomainResource returns (DomainResourceResp)
@handler getResourcePanelConfigHandler
get /core/getResourcePanelConfigHandler returns (ResourcePanelConfigResp)
@handler putResourcePanelConfigHandler
put /core/resourcePanelConfigHandler (ResourcePanelConfigReq)
@handler getComputilityStatisticsHandler
get /core/getComputilityStatistics returns (ComputilityStatisticsResp)
@handler nodeAssetsHandler
get /core/assets returns (NodeAssetsResp)
@handler saveHashcatHandler
post /core/saveHashcat (SaveHashcatReq)
@handler getHashcatHandler
get /core/getHashcat/:crackTaskId (getHashcatHandlerReq) returns (getHashcatHandlerResp)
}
//hpc二级接口
@server(
prefix: pcm/v1
group : hpc
)
service pcm {
@handler listJobHandler
get /hpc/listJob (listJobReq) returns (listJobResp)
@handler listHistoryJobHandler
get /hpc/listHistoryJob (listHistoryJobReq) returns (listHistoryJobResp)
@handler queueAssetsHandler
get /queue/assets returns (QueueAssetsResp)
}
//cloud二级接口
@server(
prefix: pcm/v1
group : cloud
)
service pcm {
@handler cloudListHandler
get /task/list returns (cloudListResp)
@handler deleteYamlHandler
get /cloud/DeleteYaml (ApplyReq) returns (DeleteResp)
}
//智算二级接口
@server(
prefix: pcm/v1
group : ai
)
service pcm {
@handler listDataSetHandler
get /ai/listDataSet/:projectId (DataSetReq) returns (DataSetResp)
@handler CreateDataSetHandler
post /ai/createDataSet/:projectId (CreateDataSetReq) returns (CreateDataSetResp)
@handler DeleteDataSetHandler
delete /ai/deleteDataSet/:projectId/:datasetId (DeleteDataSetReq) returns (DeleteDataSetResp)
// creat task 创建导入任务
@handler CreateTaskHandler
post /ai/CreateTask/:projectId/:datasetId (ImportTaskDataReq) returns (ImportTaskDataResp)
// get taskList 查询数据集导入任务列表
@handler ListImportHandler
get /ai/ListImport/:projectId/:datasetId (ListImportTasksReq) returns (ListImportTasksResp)
// ListTrainingJobs 查询训练作业列表
@handler GetListTrainingJobsHandler
get /ai/GetListTrainingJobs/:projectId (ListTrainingJobsreq) returns (ListTrainingJobsresp)
// DeleteTrainingJob 删除训练作业
@handler DeleteTrainingJobHandler
delete /ai/DeleteTrainingJob/:projectId/:trainingJobId (DeleteTrainingJobReq) returns (DeleteTrainingJobResp)
// CreateAlgorithm 创建算法
@handler CreateAlgorithmHandler
post /ai/CreateAlgorithm/:projectId (CreateAlgorithmReq) returns (CreateAlgorithmResp)
// ListAlgorithms 查询创建算法列表
@handler ListAlgorithms
//get /ai/ListAlgorithms (ListAlgorithmsReq) returns (ListAlgorithmsResp)
get /ai/ListAlgorithms/:projectId (ListAlgorithmsReq) returns (ListAlgorithmsResp)
// DeleteAlgorithm 删除算法
@handler DeleteAlgorithm
delete /ai/DeleteAlgorithm/:projectId/:algorithmId (DeleteAlgorithmReq) returns (DeleteAlgorithmResp)
// CreateTrainingJob 创建训练作业
@handler CreateTrainingJobHandler
post /ai/CreateTrainingJob/:projectId (CreateTrainingJobReq) returns (CreateTrainingJobResp)
// ShowAlgorithmByUuid 展示算法详情
@handler ShowAlgorithmByUuid
get /ai/ShowAlgorithmByUuid/:projectId/:algorithmId (ShowAlgorithmByUuidReq) returns (ShowAlgorithmByUuidResp)
// creat export task 创建导出任务
@handler CreateExportTaskHandler
post /ai/CreateExportTask/:projectId/:datasetId (CreateExportTaskReq) returns (ExportTaskDataResp)
@handler GetExportTasksOfDatasetHandler
get /ai/GetExportTasksOfDataset/:projectId/:datasetId (GetExportTasksOfDatasetReq) returns (GetExportTasksOfDatasetResp)
@handler GetExportTaskStatusOfDatasetHandler
get /ai/GetExportTaskStatusOfDataset/:projectId/:resourceId/:taskId (GetExportTaskStatusOfDatasetReq) returns (GetExportTaskStatusOfDatasetResp)
// create processor task 创建处理任务
@handler CreateProcessorTaskHandler
post /ai/CreateProcessorTask (CreateProcessorTaskReq) returns (CreateProcessorTaskResp)
// create service 创建服务
@handler CreateServiceHandler
post /ai/CreateService/:projectId (CreateServiceReq) returns (CreateServiceResp)
// list services 展示服务
@handler ListServicesHandler
get /ai/ListServices/:projectId (ListServicesReq) returns (ListServicesResp)
// Show service 展示服务详情
@handler ShowServiceHandler
get /ai/ShowService/:projectId/:serviceId (ShowServiceReq) returns (ShowServiceResp)
// Delete service 删除服务
@handler DeleteServiceHandler
delete /ai/DeleteService/:projectId/:serviceId (DeleteServiceReq) returns (DeleteServiceResp)
// ListClusters查询专属资源池列表
@handler ListClustersHandler
get /ai/ListClusters (ListClustersReq) returns (ListClustersResp)
/******************Notebook Method start*************************/
@handler listNotebookHandler
get /ai/listNotebook (ListNotebookReq) returns (ListNotebookResp)
@handler createNotebookHandler
post /ai/createNotebook (CreateNotebookReq) returns (CreateNotebookResp)
@handler startNotebookHandler
post /ai/startNotebook (StartNotebookReq) returns (StartNotebookResp)
@handler stopNotebookHandler
post /ai/stopNotebook (StopNotebookReq) returns (StopNotebookResp)
@handler getNotebookStorageHandler
get /ai/getNotebookStorage (GetNotebookStorageReq) returns (GetNotebookStorageResp)
@handler mountNotebookStorageHandler
post /ai/mountNotebookStorage (MountNotebookStorageReq) returns (MountNotebookStorageResp)
/******************Notebook Method end*************************/
/******************Visualization Job Method start*************************/
@handler getVisualizationJobHandler
get /ai/getVisualizationJob (GetVisualizationJobReq) returns (GetVisualizationJobResp)
@handler createVisualizationJobHandler
post /ai/CreateVisualizationJob (CreateVisualizationJobReq) returns (CreateVisualizationJobResp)
/******************Visualization Job Method start*************************/
}
//screen接口
@server(
prefix: pcm/v1
group : storage
)
service pcm {
@handler screenStorageHandler
get /storage/screenStorage (StorageScreenReq) returns (StorageScreenResp)
@handler dailyPowerScreenHandler
get /storage/dailyPowerScreen (DailyPowerScreenReq) returns (DailyPowerScreenResp)
@handler perCenterComputerPowersHandler
get /storage/perCenterComputerPowers (PerCenterComputerPowersReq) returns (PerCenterComputerPowersResp)
}
//镜像接口
@server(
prefix: pcm/v1
group : image
)
service pcm {
@handler uploadHandler
post /upload
@handler chunkHandler
post /chunk
@handler imageListHandler
get /image/list returns (imageListResp)
@handler dataSetCheckHandler
get /dataSet/check/:fileMd5 (checkReq) returns (checkResp)
@handler uploadDataSetHandler
post /dataSet/upload
}
//openstack 接口
@server(
prefix: pcm/v1
group : vm
)
service pcm {
@handler GetComputeLimitsHandler
get /vm/getComputeLimits (GetComputeLimitsReq) returns (GetComputeLimitsResp)
@handler GetVolumeLimitsHandler
get /vm/getVolumeLimits (GetVolumeLimitsReq) returns (GetVolumeLimitsResp)
@handler ListServerHandler
get /vm/listServer (ListServersReq) returns (ListServersResp)
@handler ListServersDetailedHandler
get /vm/listServersDetailed (ListServersDetailedReq) returns (ListServersDetailedResp)
@handler DeleteServerHandler
delete /vm/deleteServer (DeleteServerReq) returns (DeleteServerResp)
@handler ListImagesHandler
get /vm/listImages (ListImagesReq) returns (ListImagesResp)
@handler DeleteImageHandler
delete /vm/deleteImage (DeleteImageReq) returns (DeleteImageResp)
@handler ListNetworksHandler
get /vm/listNetworks (ListNetworksReq) returns (ListNetworksResp)
@handler DeleteNetworkHandler
delete /vm/deleteNetwork (DeleteNetworkReq) returns (DeleteNetworkResp)
@handler CreateNetworkHandler
post /vm/createNetwork (CreateNetworkReq) returns (CreateNetworkResp)
@handler CreateSubnetHandler
post /vm/createSubnet (CreateSubnetReq) returns (CreateSubnetResp)
@handler ListVolumesDetailHandler
get /vm/listVolumesDetail (ListVolumesDetailReq) returns (ListVolumesDetailResp)
@handler DeleteVolumeHandler
delete /vm/deleteVolume (DeleteVolumeReq) returns (DeleteVolumeResp)
@handler CreateVolumeHandler
post /vm/createVolume (CreateVolumeReq) returns (CreateVolumeResp)
@handler ListFlavorsDetailHandler
get /vm/listFlavorsDetail (ListFlavorsDetailReq) returns (ListFlavorsDetailResp)
@handler CreateServerHandler
post /vm/createServer (CreateServerReq) returns (CreateServerResp)
@handler ListVolumeTypesHandler
get /vm/listVolumeTypes (ListVolumeTypesReq) returns (ListVolumeTypesResp)
@handler CreateImageHandler
post /vm/createImage (CreateImageReq) returns (CreateImageResp)
@handler UploadImageHandler
put /vm/uploadImage (UploadOsImageReq) returns (UploadOsImageResp)
@handler GetServersDetailedByIdHandler
get /vm/getServersDetailedById (GetServersDetailedByIdReq) returns (GetServersDetailedByIdResp)
@handler UpdateServerHandler
put /vm/updateServer (UpdateServerReq) returns (UpdateServerResp)
@handler StartServerHandler
post /vm/startServer (StartServerReq) returns (StartServerResp)
@handler StopServerHandler
post /vm/stopServer (StopServerReq) returns (StopServerResp)
@handler RebootServerHandler
post /vm/rebootServer (RebootServerReq) returns (RebootServerResp)
@handler PauseServerHandler
post /vm/pauseServer (PauseServerReq) returns (PauseServerResp)
@handler ShowNetworkDetailsHandler
get /vm/showNetworkDetails (ShowNetworkDetailsReq) returns (ShowNetworkDetailsResp)
@handler UpdateNetworkHandler
put /vm/updateNetwork (UpdateNetworkReq) returns (UpdateNetworkResp)
@handler BulkCreateNetworksHandler
post /vm/bulkCreateNetworks (BulkCreateNetworksReq) returns (BulkCreateNetworksResp)
@handler UpdateVolumeHandler
put /vm/updateVolume (UpdateVolumeReq) returns (UpdateVolumeResp)
@handler CreateVolumeTypesHandler
post /vm/createVolumeTypes (CreateVolumeTypeReq) returns (CreateVolumeTypeResp)
@handler DeleteVolumeTypeHandler
delete /vm/deleteVolumeType (DeleteVolumeTypeReq) returns (DeleteVolumeTypeResp)
@handler ListVolumesHandler
get /vm/listVolumes (ListVolumesReq) returns (ListVolumesResp)
// Bare Metal
@handler ListNodesHandler
get /vm/listNodes (ListNodesReq) returns (ListNodesResp)
@handler CreateNodeHandler
post /vm/createNode (CreateNodeReq) returns (CreateNodeResp)
@handler DeleteNodeHandler
delete /vm/deleteNode (DeleteNodeReq) returns (DeleteNodeResp)
@handler ShowNodeDetailsHandler
delete /vm/showNodeDetails (ShowNodeDetailsReq) returns (ShowNodeDetailsResp)
}
//存算联动 接口
@server(
prefix: pcm/v1
group : storelink
)
service pcm {
@handler UploadLinkImageHandler
post /storelink/uploadImage (UploadLinkImageReq) returns (UploadLinkImageResp)
@handler GetLinkImageListHandler
get /storelink/getImageList (GetLinkImageListReq) returns (GetLinkImageListResp)
@handler DeleteLinkImageHandler
delete /storelink/deleteImage (DeleteLinkImageReq) returns (DeleteLinkImageResp)
@handler SubmitLinkTaskHandler
post /storelink/submitTask (SubmitLinkTaskReq) returns (SubmitLinkTaskResp)
@handler GetLinkTaskHandler
get /storelink/getTask (GetLinkTaskReq) returns (GetLinkTaskResp)
@handler DeleteLinkTaskHandler
delete /storelink/deleteTask (DeleteLinkTaskReq) returns (DeleteLinkTaskResp)
@handler GetParticipantsHandler
get /storelink/getParticipants (GetParticipantsReq) returns (GetParticipantsResp)
@handler GetAISpecsHandler
get /storelink/getResourceSpecs (GetResourceSpecsReq) returns (GetResourceSpecsResp)
}