全部API接口功能详细参考-基因分析平台-阿里云-基因分析平台-阿里云帮助中心

API标准及多语言预置SDK

本产品（EasyGene/2021-03-15）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

工作空间

API	标题	API概述
应用	应用
TagApp	应用版本打标	对应用的版本进行打标。
ImportApp	导入应用	安装平台公共应用到用户工作空间中使用。
DeleteApp	删除应用	删除不需要的应用。
GetApp	查询应用详情	查询工作空间下特定应用详情。
ListApps	获取应用列表	获取工作空间下的应用列表。
运行	运行
CreateRun	创建运行任务	工作空间中创建运行任务。
DeleteRun	删除运行任务	删除工作空间下特定运行任务记录。
AbortRun	终止运行任务	终止工作空间下特定的非结束状态的运行任务。
实体	实体
DeleteEntityItems	删除实体表格数据	删除工作空间中特定实体表格数据内容。
UpdateEntityItems	更新实体元素	更新工作空间中特定实体数据表格内容。
ListEntities	获取实体类型列表	获取工作空间下实体类型列表。
ListEntityItems	获取实体数据表格	获取工作空间下特定实体的数据表格内容。
CopyPublicEntity	拷贝公共数据集表格	拷贝公共数据集表格到工作空间中。
DownloadEntity	下载实体表格数据	从工作空间中下载实体表格数据到本地文件。
UploadEntity	上传实体数据	上传实体数据表格到工作空间中。
投递	投递
CreateSubmission	创建投递	创建投递，通过创建投递可以批量创建任务。
GetSubmission	查询投递任务详情	查询工作空间下特定的投递任务详情。
DeleteSubmission	删除投递任务	删除工作空间下特定的投递任务记录。
ListSubmissions	获取投递任务列表	获取工作空间下投递任务列表。
AbortSubmission	AbortSubmission	终止工作空间下特定的投递任务。
ResumeSubmission	ResumeSubmission	恢复工作空间下特定的投递任务。

公共应用

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

开发者资源

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

公共数据集

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

其他

API	标题	API概述
InstallGlobalApp	安装公共应用	安装平台公共应用到用户工作空间中使用。
CreateApp	创建应用	工作空间中创建应用。
CreateEntity	创建实体表格	工作空间中创建实体表格。
CreateTemplate	创建应用模板	工作空间中创建应用模板。
CreateWorkspace	创建工作空间	创建用户工作空间。
DeleteEntity	删除实体表格	删除工作空间中特定实体表格。
DeleteTemplate	删除应用模板	删除工作空间下特定应用模板。
DeleteWorkspace	删除工作空间	删除用户工作空间。
GetEntity	查询实体类型定义	查询工作空间下特定实体类型定义。
GetRun	获取任务详情	获取任务详情
GetTemplate	查询应用模板详情	查询工作空间下特定应用模板详情。
GetWorkspace	查询工作空间详情	查询工作空间的详细信息，包括状态，描述，作业生命周期等。
ListRegions	查询产品上线区域	查询基因分析平台产品支持使用的区域，如华北2-北京。
ListRuns	获取运行任务列表	获取工作空间下运行任务列表。
ListTemplates	获取应用模板列表	获取工作空间下应用模板列表。
ListWorkspaces	列出工作空间	列出符合条件的工作空间。
UpdateEntity	更新实体数据表格内容	更新工作空间中特定实体数据表格内容。
UpdateTemplate	更新应用模板	更新工作空间下特定应用模板详情。
UpdateWorkspace	更新工作空间	更新工作空间的部分信息。