本产品（
机器学习PAI-AI工作空间/2021-02-04）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
镜像
| 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 | 创建数据集 | 调用CreateDataset创建一个数据集。 |
| GetDataset | 获取数据集 | 获取数据集。 |
| UpdateDataset | 更新数据集 | 更新数据集，支持更新名称，描述等。 |
| PublishDataset | 发布数据集 | 将私有数据集在工作空间内公开。 |
| ListDatasets | 获取数据集列表 | 获取某个工作空间下的数据集列表。 |
| DeleteDataset | 删除数据集 | 删除数据集。 |
| CreateDatasetLabels | 创建数据集标签 | 为数据集打标签。 |
| DeleteDatasetLabels | 删除数据集标签 | 删除数据集标签。 |
代码配置
| API | 标题 | API概述 |
|---|---|---|
| CreateCodeSource | 创建代码配置 | 创建代码配置到PAI，支持配置Git的代码分支与CommitId。创建完成后，可以在DLC作业中引用。 |
| DeleteCodeSource | 删除代码配置 | 指定ID，删除一个代码配置。 |
| PublishCodeSource | 发布代码配置 | 发布私有的代码配置到工作空间公开可见。 |
| 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后付费。 |
| ListServiceTemplates | 获取服务模板列表 | 获取服务模板列表，目前只支持pai平台提供服务模板。 |
| GetServiceTemplate | 获取服务模板 | 获取服务模板详情。目前只支持pai提供的服务模板。 |