API概览-人工智能平台 PAI-阿里云

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

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

实验

API	标题	API概述
CreateExperiment	创建实验	创建实验
UpdateExperiment	更新实验信息	更新实验
GetExperiment	获取实验详情	获取实验
ListExperiment	获取实验列表	获取实验列表。
DeleteExperiment	删除实验	删除实验
SetExperimentLabels	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	移除镜像标签	移除镜像标签。
CreateImageBuild	构建自定义镜像	根据指定配置构建自定义镜像，构建成功后，会添加到当前工作空间的自定义镜像里。

工作空间

API	标题	API概述
权限	权限
ListPermissions	获取工作空间的权限列表	获取用户在工作空间内的权限列表。
GetPermission	获取工作空间的权限	获取工作空间的权限。
资源	资源
DeleteWorkspaceResource	删除工作空间的资源	删除工作空间对资源的引用，不会删除底层的资源。
UpdateWorkspaceResource	更新工作空间的资源	更新工作空间的资源。
ListResources	获取工作空间的资源列表	获取工作空间内已关联的资源列表。
CreateWorkspaceResource	创建工作空间的资源	添加资源引用到工作空间。
成员	成员
AddMemberRole	成员添加角色	为工作空间内的成员添加某个角色，使其拥有角色的权限。
RemoveMemberRole	删除成员角色	删除成员角色。
DeleteMembers	工作空间删除成员	删除工作空间的成员。
GetMember	获取工作空间的成员	获取工作空间的成员。
ListMembers	获取工作空间的成员列表	获取工作空间的成员列表。
CreateMember	工作空间添加成员	添加用户到工作空间，作为工作空间的成员，可以添加多个用户为成员。
配置	配置
UpdateConfigs	批量更新或新增工作空间配置	批量更新或新增工作空间配置。
GetConfig	获取工作空间配置	获取工作空间配置。
ListConfigs	获取工作空间配置列表	获取工作空间配置列表。
DeleteConfig	删除工作空间配置	删除工作空间配置。
UpdateConfig	更新或新增工作空间配置	更新或新增工作空间配置。
工作空间	工作空间
ListWorkspaces	获取工作空间列表	获取某个地域下的工作空间列表。
CreateWorkspace	创建工作空间	创建工作空间。
GetWorkspace	获取工作空间	获取工作空间详细信息。
DeleteWorkspace	删除工作空间	删除工作空间，关联的资源不会释放，需要您自已释放。
UpdateWorkspace	更新工作空间	更新工作空间名称和描述信息。
GetDefaultWorkspace	获取默认工作空间	获取默认工作空间详情。
UpdateDefaultWorkspace	指定默认工作空间	将某个工作空间指定为默认工作空间。
ListWorkspaceUsers	获取可被添加至工作空间的用户列表	列出未加入工作空间的用户列表，这些用户可被加入工作空间成为成员。
ListQuotas	获取MaxCompute GPU资源组的资源配额列表	获取资源配额列表。

数据集

API	标题	API概述
多模态检索	多模态检索
GetDatasetFileMetasStatistics	获取数据集下文件元数据的统计信息	获取数据集下元数据的统计信息。
StopDatasetJob	停止数据集任务	停止数据集任务。
GetDatasetJob	获取数据集任务	获取数据集任务
CreateDatasetFileMetas	批量创建数据集文件元数据	批量创建数据集下的文件元数据记录。
UpdateDatasetJob	更新数据集任务	更新数据集任务。
ListDatasetJobs	获取数据集任务列表	获取数据集任务列表。
DeleteDatasetJobConfig	删除数据集任务配置	删除数据集任务配置。
DeleteDatasetJob	删除数据集任务	删除数据集任务。
UpdateDatasetJobConfig	更新数据集任务配置	更新数据集任务配置。
UpdateDatasetFileMetas	批量更新数据集文件元数据	批量更新数据集下的文件元数据记录
ListDatasetJobConfigs	获取数据集任务配置列表	批量查询数据集任务配置。
ListDatasetFileMetas	获取数据集文件元数据列表	查询数据集文件列表。
GetDatasetJobConfig	获取数据集任务配置	获取数据集任务配置。
GetDatasetFileMeta	获取数据集文件元数据详情	获取数据集下的指定文件元数据记录。
DeleteDatasetFileMetas	批量删除数据集文件元数据	批量删除数据集下的文件元数据记录
CreateDatasetJobConfig	创建数据集任务配置	创建数据集任务配置。
CreateDatasetJob	创建数据集任务	创建数据集任务。
CreateDataset	创建数据集	创建一个数据集。
GetDataset	获取数据集	获取数据集。
UpdateDataset	更新数据集	更新数据集，支持更新名称，描述等。
PublishDataset	发布数据集	将私有数据集在工作空间内公开。
ListDatasets	获取数据集列表	获取某个工作空间下的数据集列表。
DeleteDataset	删除数据集	删除数据集。
CreateDatasetLabels	创建数据集标签	为数据集打标签。
DeleteDatasetLabels	删除数据集标签	删除数据集标签。
CreateDatasetVersion	创建数据集版本	创建数据集版本。
GetDatasetVersion	获取数据集版本	获取指定版本的数据集信息。
ListDatasetVersions	获取数据集版本列表	获取数据集版本列表。
UpdateDatasetVersion	更新数据集版本	更新指定版本的数据集信息。
DeleteDatasetVersion	删除数据集版本	删除指定版本的数据集信息。其中版本v1无法使用本接口删除，需要使用DeleteDataset接口删除数据集的时候同步删除。
DeleteDatasetVersionLabels	删除数据集版本标签	删除数据集版本的标签。
CreateDatasetVersionLabels	创建数据集版本标签	创建数据集版本的标签。

连接

API	标题	API概述
CreateConnection	创建连接	创建连接。用于LangStudio、数据集多模态检索服务等场景中连接PAI云端到客户的模型、数据库等服务。
GetConnection	查询连接	获取连接详情。
UpdateConnection	更新连接	更新连接配置。
ListConnections	获取连接列表	获取连接列表。
DeleteConnection	删除连接	删除连接。

代码配置

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概述
SetUserConfigs	更新用户配置	更新用户配置。
DeleteUserConfig	删除用户配置	删除用户配置。
ListUserConfigs	获取用户配置	获取用户配置。

其他

API	标题	API概述
CreateProductOrders	购买产品	购买产品，目前只支持购买DataWorks后付费、OSS后付费、PAI后付费、MaxCompute后付费。
AcceptDataworksEvent	接收并处理DataWorks系统事件	PAI系统用于接收并处理DataWorks发送的系统事件消息。
ChangeResourceGroup	更改资源组	更改资源ID对应的资源组。
ListFeatures	列举客户特性	列举特性