本產品（
基因分析平臺/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 | 創建運行任務 | 工作空間中創建運行任務。 |
| GetRun | GetRun | 獲取任務詳情 |
| DeleteRun | DeleteRun | 刪除工作空間下特定運行任務記錄。 |
| ListRuns | 獲取運行任務列表 | 獲取工作空間下運行任務列表。 |
| ListUserActiveRuns | 獲取用戶所有運行任務 | 最近任務列表。 |
| AbortRun | 終止運行任務 | 終止工作空間下特定的非結束狀態的運行任務。 |
| 實體 | 實體 | |
| CreateEntity | 創建實體表格 | 工作空間中創建實體表格。 |
| GetEntity | 查詢實體類型定義 | 查詢工作空間下特定實體類型定義。 |
| DeleteEntity | 刪除實體表格 | 刪除工作空間中特定實體表格。 |
| DeleteEntityItems | 刪除實體表格數據 | 刪除工作空間中特定實體表格數據內容。 |
| UpdateEntity | 更新實體數據表格內容 | 更新工作空間中特定實體數據表格內容。 |
| UpdateEntityItems | 更新實體元素 | 更新工作空間中特定實體數據表格內容。 |
| ListEntities | 獲取實體類型列表 | 獲取工作空間下實體類型列表。 |
| ListEntityItems | 獲取實體數據表格 | 獲取工作空間下特定實體的數據表格內容。 |
| CopyPublicEntity | 拷貝公共數據集表格 | 拷貝公共數據集表格到工作空間中。 |
| DownloadEntity | 下載實體表格數據 | 從工作空間中下載實體表格數據到本地文件。 |
| UploadEntity | 上傳實體數據 | 上傳實體數據表格到工作空間中。 |
| 模板 | 模板 | |
| CreateTemplate | 創建應用模板 | 工作空間中創建應用模板。 |
| GetTemplate | 查詢應用模板詳情 | 查詢工作空間下特定應用模板詳情。 |
| DeleteTemplate | 刪除應用模板 | 刪除工作空間下特定應用模板。 |
| UpdateTemplate | 更新應用模板 | 更新工作空間下特定應用模板詳情。 |
| ListTemplates | 獲取應用模板列表 | 獲取工作空間下應用模板列表。 |
| 投遞 | 投遞 | |
| CreateSubmission | 創建投遞 | 創建投遞，通過創建投遞可以批量創建任務。 |
| GetSubmission | 查詢投遞任務詳情 | 查詢工作空間下特定的投遞任務詳情。 |
| DeleteSubmission | DeleteSubmission | 刪除工作空間下特定的投遞任務記錄。 |
| ListSubmissions | 獲取投遞任務列表 | 獲取工作空間下投遞任務列表。 |
| AbortSubmission | AbortSubmission | 終止工作空間下特定的投遞任務。 |
| ResumeSubmission | ResumeSubmission | 恢復工作空間下特定的投遞任務。 |
公共應用
| API | 標題 | API概述 |
|---|---|---|
| ListGlobalApps | 獲取公共應用列表 | 獲取平臺公共應用列表。 |
| GetGlobalApp | 查詢公共應用詳情 | 查詢平臺公共應用詳情。 |
開發者資源
| API | 標題 | API概述 |
|---|---|---|
| ListContainerImages | 獲取公共工具鏡像列表 | 獲取平臺公共工具鏡像列表。 |
| ListAuthorizedSoftware | 獲取第三方軟件列表 | 獲取第三方軟件列表信息。 |
公共數據集
| API | 標題 | API概述 |
|---|---|---|
| ListPublicDataset | 獲取公共數據集列表 | 獲取平臺公共數據集列表。 |
| GetPublicDataset | 查詢公共數據集詳情 | 查詢平臺公共數據集詳情。 |
| ListPublicDatasetEntities | 獲取公共數據集實體類型列表 | 獲取平臺公共數據集包含的實體類型列表。 |
| GetPublicDatasetEntity | 查詢公共數據集實體定義 | 查詢平臺公共數據集特定的實體定義。 |
| ListPublicDatasetEntityItems | 查詢公共數據集實體數據表格 | 查詢平臺公共數據集特定的實體數據表格內容。 |
| ListPublicDatasetTags | 獲取公共數據集分類 | 獲取公共數據集分類信息。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| ListRegions | 查詢產品上線區域 | 查詢基因分析平臺產品支持使用的區域，如華北2-北京。 |
| InstallGlobalApp | 安裝公共應用 | 安裝平臺公共應用到用戶工作空間中使用。 |