You need to enable JavaScript to run this app.
导航

API列表

最近更新时间2024.01.10 20:36:45

首次发布时间2023.02.10 20:00:52

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

工作流

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终止工作流运行记录

Notebooks

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

工作流运行任务

API Action说明
ListTasks查询工作流的task任务列表