Bio-OS服务提供以下 API 接口。
| API Action | 说明 |
|---|---|
| CreateWorkspace | 创建工作空间 |
| ListWorkspaces | 查询符合条件的工作空间列表 |
| UpdateWorkspace | 更新工作空间 |
| DeleteWorkspace | 删除工作空间 |
| BindClusterToWorkspace | 如果工作空间内运行工作流，则需要绑定已纳管的集群，已被纳管的集群可通过ListClusters接口查询 |
| UnbindClusterAndWorkspace | 对已绑定的工作空间和集群进行解绑操作 |
| ListClustersOfWorkspace | 查看workspace所绑定的集群列表 |
| ListWorkspaceLabel | 获取工作空间的标签列表 |
API Action | 说明 |
|---|---|
| CreateCluster | 此接口为异步接口，当此接口返回成功时，会返回导入的clusterID信息，此时并不表示集群纳管，需要调用接口查看ListClusters集群纳管情况。 |
| ListClusters | 查询可用集群 |
| DeleteCluster | 删除集群 |
| UpdateAPIAccessKey | 创建或更新集群的API aksk |
| GetAPIAccessKey | 获取集群访问密钥 |
API Action | 说明 |
|---|---|
| CreateWorkflow | 此接口为异步接口，当此接口返回成功时，会返回导入的workflowID信息，此时并不代表工作流导入成功，需要调用ListWorkflows接口查看工作流导入情况，其返回的参数WorkflowImportStatus = Succeeded为导入成功 |
| UpdateWorkflow | 更新工作流，该接口的使用方式与CreateWorkflow类型，同样需要ListWorkflows接口查看状态 |
| ListWorkflows | 查询特定工作空间下的工作流列表 |
| DeleteWorkflow | 删除工作流 |
| GetTRSWorkflowInfo | 查询trs工作流信息 |
API Action | 说明 |
|---|---|
| CreateDataModel | 创建实体数据模型 |
| ListDataModels | 查询实体数据模型列表 |
| ListDataModelRows | 分页查询实体数据模型的详细信息（行和列） |
| DeleteDataModelRowsAndHeaders | 删除实体数据模型的具体行和列 |
| API Action | 说明 |
|---|---|
| CreateSubmission | 提交工作流投递记录 |
| ListSubmissions | 查询工作流投递记录列表 |
| DeleteSubmission | 删除工作流投递记录 |
| CancelSubmission | 终止工作流投递记录 |
| API Action | 说明 |
|---|---|
| ListRuns | 查询工作流运行列表 |
| CancelRun | 终止工作流运行记录 |
| API Action | 说明 |
|---|---|
| GetNotebookEditInfo | 启动Notebook Server并获取访问链接 |
| GetNotebookServerSettings | 获取当前Notebook Server配置信息 |
| GetNotebookServerStat | 获取当前Notebook Server状态 |
| ListNotebookServerResourceOpts | 列举Notebook Server可用资源配置 |
| ListNotebookServerImages | 列举Notebook Server镜像信息 |
| StopNotebookServer | 即时暂停当前Notebook Server |
| UpdateNotebookServerSettings | 更新Notebook Server配置并异步暂停当前Notebook Server |
| CreateNotebookRun | 一键运行notebook |
| GetNotebookRunStatus | 获取一键运行notebook任务状态 |
| API Action | 说明 |
|---|---|
| ListTasks | 查询工作流的task任务列表 |