本產品（
人工智能平臺 PAI - AI 工作空間/2021-02-04）的OpenAPI采用ROA簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
實驗
| API | 標題 | API概述 |
|---|---|---|
| CreateExperiment | 創建實驗 | 創建實驗 |
| UpdateExperiment | 更新實驗信息 | 更新實驗 |
| GetExperiment | 獲取實驗詳情 | 獲取實驗 |
| ListExperiment | 獲取實驗列表 | 獲取實驗列表。 |
| DeleteExperiment | 刪除實驗 | 刪除實驗 |
| SetExperimentLabels | 設置實驗的標簽 | 更新實驗標簽 |
| DeleteExperimentLabel | 刪除實驗的標簽 | 刪除實驗的標簽 |
| CreateRun | 創建運行 | 創建一次運行，運行（Run）屬于一個實驗（Experiment），可以與具體的workload關聯，也可以是一次單純的代碼運行。 |
| UpdateRun | 更新運行信息 | 更新運行信息 |
| GetRun | 獲取Run詳情 | 獲取Run詳情 |
| ListRuns | 獲取運行列表 | 獲取Run列表。 |
| DeleteRun | 刪除Run | 刪除Run |
| DeleteRunLabel | 刪除Run標簽 | 刪除Run標簽 |
| LogRunMetrics | 批量記錄Run的指標 | 批量記錄Run的指標 |
| ListRunMetrics | 獲取Run的指標記錄列表 | 獲取Run的指標記錄列表 |
鏡像
| API | 標題 | API概述 |
|---|---|---|
| AddImage | 添加鏡像 | 添加自定義鏡像到工作空間。 |
| AddImageLabels | 添加鏡像標簽 | 為鏡像添加標簽。 |
| GetImage | 獲取鏡像 | 獲取鏡像詳情。 |
| ListImageLabels | 獲取鏡像標簽列表 | 獲取鏡像標簽列表。 |
| ListImages | 獲取鏡像列表 | 獲取鏡像列表。 |
| RemoveImage | 刪除鏡像 | 刪除鏡像。 |
| PublishImage | 發布鏡像 | 發布鏡像，把鏡像的可見性從PRIVATE變為PUBLIC。 |
| RemoveImageLabels | 移除鏡像標簽 | 移除鏡像標簽。 |
工作空間
| API | 標題 | API概述 |
|---|---|---|
| CreateWorkspace | 創建工作空間 | 創建工作空間。 |
| ListWorkspaces | 獲取工作空間列表 | 獲取某個地域下的工作空間列表。 |
| GetWorkspace | 獲取工作空間 | 獲取工作空間詳細信息。 |
| DeleteWorkspace | 刪除工作空間 | 刪除工作空間，關聯的資源不會釋放，需要您自已釋放。 |
| UpdateWorkspace | 更新工作空間 | 更新工作空間名稱和描述信息。 |
| GetDefaultWorkspace | 獲取默認工作空間 | 獲取默認工作空間詳情。 |
| UpdateDefaultWorkspace | 指定默認工作空間 | 將某個工作空間指定為默認工作空間。 |
| GetPermission | 獲取工作空間的權限 | 獲取工作空間的權限。 |
| ListPermissions | 獲取工作空間的權限列表 | 獲取用戶在工作空間內的權限列表。 |
| ListWorkspaceUsers | 獲取可被添加至工作空間的用戶列表 | 列出未加入工作空間的用戶列表，這些用戶可被加入工作空間成為成員。 |
| CreateMember | 工作空間添加成員 | 添加用戶到工作空間，作為工作空間的成員，可以添加多個用戶為成員。 |
| ListMembers | 獲取工作空間的成員列表 | 獲取工作空間的成員列表。 |
| GetMember | 獲取工作空間的成員 | 獲取工作空間的成員。 |
| DeleteMembers | 工作空間刪除成員 | 刪除工作空間的成員。 |
| AddMemberRole | 成員添加角色 | 為工作空間內的成員添加某個角色，使其擁有角色的權限。 |
| RemoveMemberRole | 刪除成員角色 | 刪除成員角色。 |
| CreateWorkspaceResource | 創建工作空間的資源 | 添加資源引用到工作空間。 |
| DeleteWorkspaceResource | 刪除工作空間的資源 | 刪除工作空間對資源的引用，不會刪除底層的資源。 |
| UpdateWorkspaceResource | 更新工作空間的資源 | 更新工作空間的資源。 |
| ListResources | 獲取工作空間的資源列表 | 獲取工作空間內已關聯的資源列表。 |
| ListQuotas | 獲取MaxCompute GPU資源組的資源配額列表 | 獲取資源配額列表。 |
數據集
| API | 標題 | API概述 |
|---|---|---|
| CreateDataset | 創建數據集 | 創建一個數據集。 |
| GetDataset | 獲取數據集 | 獲取數據集。 |
| UpdateDataset | 更新數據集 | 更新數據集，支持更新名稱，描述等。 |
| PublishDataset | 發布數據集 | 將私有數據集在工作空間內公開。 |
| ListDatasets | 獲取數據集列表 | 獲取某個工作空間下的數據集列表。 |
| DeleteDataset | 刪除數據集 | 刪除數據集。 |
| CreateDatasetLabels | 創建數據集標簽 | 為數據集打標簽。 |
| DeleteDatasetLabels | 刪除數據集標簽 | 刪除數據集標簽。 |
| CreateDatasetVersion | 創建數據集版本 | 創建數據集版本。 |
| GetDatasetVersion | 獲取數據集版本 | 獲取指定版本的數據集信息。 |
| ListDatasetVersions | 獲取數據集版本列表 | 獲取數據集版本列表。 |
| UpdateDatasetVersion | 更新數據集版本 | 更新指定版本的數據集信息。 |
| DeleteDatasetVersion | 刪除數據集版本 | 刪除指定版本的數據集信息。其中版本v1無法使用本接口刪除，需要使用DeleteDataset接口刪除數據集的時候同步刪除。 |
| DeleteDatasetVersionLabels | 刪除數據集版本標簽 | 刪除數據集版本的標簽。 |
| DeleteDatasetVersionLabels | 刪除數據集版本標簽 | 刪除數據集版本的標簽。 |
| CreateDatasetVersionLabels | 創建數據集版本標簽 | 創建數據集版本的標簽。 |
代碼配置
| API | 標題 | API概述 |
|---|---|---|
| CreateCodeSource | 創建代碼配置 | 創建代碼配置到PAI，支持配置Git的代碼分支與CommitId。創建完成后，可以在DLC作業中引用。 |
| DeleteCodeSource | 刪除代碼配置 | 指定ID，刪除一個代碼配置。 |
| PublishCodeSource | 發布代碼配置 | 發布私有的代碼配置到工作空間公開可見。 |
| UpdateCodeSource | 更新代碼配置 | 更新代碼配置。 |
| GetCodeSource | 獲取代碼配置 | 獲取一個代碼配置的詳細信息。 |
| ListCodeSources | 獲取代碼配置列表 | 查詢代碼配置列表，支持分頁、排序和按條件過濾。 |
模型
| API | 標題 | API概述 |
|---|---|---|
| CreateModel | 創建模型 | 創建模型。模型是模型版本的集合，創建模型時需要指定模型名稱，描述等信息。 |
| UpdateModel | 更新模型 | 更新模型的基本配置信息。 |
| GetModel | 獲取模型 | 獲取指定模型詳情信息。 |
| ListModels | 獲取模型列表 | 獲取模型列表。 |
| DeleteModel | 刪除模型 | 刪除模型。 |
| CreateModelVersion | 創建模型版本 | 為指定模型新增版本。 |
| UpdateModelVersion | 更新模型版本 | 更新模型版本。 |
| GetModelVersion | 獲取模型版本 | 獲取模型版本。 |
| ListModelVersions | 獲取模型版本列表 | 獲取模型版本列表。 |
| DeleteModelVersion | 刪除模型版本 | 刪除模型版本。 |
| CreateModelLabels | 創建模型標簽 | 為模型創建標簽。 |
| DeleteModelLabels | 刪除模型標簽 | 刪除模型標簽。 |
| CreateModelVersionLabels | 創建模型版本標簽 | 為模型版本創建標簽。 |
| DeleteModelVersionLabels | 刪除模型版本標簽 | 刪除模型版本標簽。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| ListProducts | 獲取產品和服務詳情列表 | 獲取產品和服務詳情列表。 |
| CreateProductOrders | CreateProductOrders | 購買產品，目前只支持購買DataWorks后付費、OSS后付費、PAI后付費、MaxCompute后付費。 |