文档

API概览

更新时间:
本产品(基因分析平台/2021-03-15)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

工作空间

API标题API概述
空间空间
CreateWorkspace创建工作空间创建用户工作空间。
DeleteWorkspace删除工作空间删除用户工作空间。
UpdateWorkspace更新工作空间更新工作空间的部分信息。
ListWorkspaces列出工作空间列出符合条件的工作空间。
GetWorkspace查询工作空间详情查询工作空间的详细信息,包括状态,描述,作业生命周期等。
应用应用
CreateApp创建应用工作空间中创建应用。
TagApp应用版本打标对应用的版本进行打标。
ImportApp导入应用安装平台公共应用到用户工作空间中使用。
DeleteApp删除应用删除不需要的应用。
GetApp查询应用详情查询工作空间下特定应用详情。
ListApps获取应用列表获取工作空间下的应用列表。
运行运行
CreateRun创建运行任务工作空间中创建运行任务。
GetRunGetRun查询工作空间下特定运行任务详情。
DeleteRunDeleteRun删除工作空间下特定运行任务记录。
ListRuns获取运行任务列表获取工作空间下运行任务列表。
ListUserActiveRuns获取用户所有运行任务最近任务列表。
AbortRun终止运行任务终止工作空间下特定的非结束状态的运行任务。
实体实体
CreateEntity创建实体表格工作空间中创建实体表格。
GetEntity查询实体类型定义查询工作空间下特定实体类型定义。
DeleteEntity删除实体表格删除工作空间中特定实体表格。
DeleteEntityItems删除实体表格数据删除工作空间中特定实体表格数据内容。
UpdateEntity更新实体数据表格内容更新工作空间中特定实体数据表格内容。
UpdateEntityItems更新实体元素更新工作空间中特定实体数据表格内容。
ListEntities获取实体类型列表获取工作空间下实体类型列表。
ListEntityItems获取实体数据表格获取工作空间下特定实体的数据表格内容。
CopyPublicEntity拷贝公共数据集表格拷贝公共数据集表格到工作空间中。
DownloadEntity下载实体表格数据从工作空间中下载实体表格数据到本地文件。
UploadEntity上传实体数据上传实体数据表格到工作空间中。
模板模板
CreateTemplate创建应用模板工作空间中创建应用模板。
GetTemplate查询应用模板详情查询工作空间下特定应用模板详情。
DeleteTemplate删除应用模板删除工作空间下特定应用模板。
UpdateTemplate更新应用模板更新工作空间下特定应用模板详情。
ListTemplates获取应用模板列表获取工作空间下应用模板列表。
投递投递
CreateSubmission创建投递创建投递,通过创建投递可以批量创建任务。
GetSubmission查询投递任务详情查询工作空间下特定的投递任务详情。
DeleteSubmissionDeleteSubmission删除工作空间下特定的投递任务记录。
ListSubmissions获取投递任务列表获取工作空间下投递任务列表。
AbortSubmissionAbortSubmission终止工作空间下特定的投递任务。
ResumeSubmissionResumeSubmission恢复工作空间下特定的投递任务。

公共应用

API标题API概述
ListGlobalApps获取公共应用列表获取平台公共应用列表。
GetGlobalApp查询公共应用详情查询平台公共应用详情。

开发者资源

API标题API概述
ListContainerImages获取公共工具镜像列表获取平台公共工具镜像列表。
ListAuthorizedSoftware获取第三方软件列表获取第三方软件列表信息。

公共数据集

API标题API概述
ListPublicDataset获取公共数据集列表获取平台公共数据集列表。
GetPublicDataset查询公共数据集详情查询平台公共数据集详情。
ListPublicDatasetEntities获取公共数据集实体类型列表获取平台公共数据集包含的实体类型列表。
GetPublicDatasetEntity查询公共数据集实体定义查询平台公共数据集特定的实体定义。
ListPublicDatasetEntityItems查询公共数据集实体数据表格查询平台公共数据集特定的实体数据表格内容。
ListPublicDatasetTags获取公共数据集分类获取公共数据集分类信息。

其他

API标题API概述
ListRegions查询产品上线区域查询基因分析平台产品支持使用的区域,如华北2-北京。
InstallGlobalApp安装公共应用安装平台公共应用到用户工作空间中使用。
  • 本页导读 (0)