API标准及多语言预置SDK
本产品（PaiStudio/2021-02-02）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
工作流草稿
|
API |
标题 |
API概述 |
| CopyExperiment | 复制工作流草稿 | 复制PAI Designer工作流草稿。 |
| UpdateExperimentMeta | 更新工作流草稿Meta | 更新PAI Designer工作流草稿的Meta信息。 |
| UpdateExperimentContent | 更新工作流草稿的内容 | 更新工作流草稿的内容。 |
| PublishExperiment | 公开工作流草稿到工作空间 | 将工作流草稿发布到工作空间，让工作空间所有用户可见。 |
| GetExperimentMeta | 查询工作流草稿Meta | 查询工作流草稿Meta。 |
| GetExperimentStatus | 查询工作流草稿状态 | 获取工作流草稿以及工作流草稿中节点的状态。 |
工作流草稿作业
|
API |
标题 |
API概述 |
| GetJob | 查询工作流草稿作业 | 查询工作流草稿作业详细信息。 |
| StopJob | 停止工作流草稿作业 | 停止工作流草稿作业。 |
| StopExperiment | 停止工作流草稿所有作业 | 停止工作流草稿提交的所有运行中的作业，停止是异步操作，接口返回后，需要等待一段时间才能停止成功。 |
工作流草稿目录
|
API |
标题 |
API概述 |
| CreateExperimentFolder | 创建工作流草稿文件夹 | 创建工作流草稿文件夹。 |
| UpdateExperimentFolder | 更新工作流草稿文件夹 | 更新工作量草稿文件夹。 |
| GetExperimentFolderChildren | 获取工作流草稿文件夹下成员 | 列出某一个工作流草稿文件夹下的子文件夹或工作流草稿。 |
| DeleteExperimentFolder | 删除工作流草稿文件夹 | 删除工作流草稿文件夹。 |
算法
|
API |
标题 |
API概述 |
| GetAlgorithmTree | 获取算法树 | 获取算法树。 |
| GetAlgorithmDef | 获取算法定义 | 获取算法定义 |
其它(未在目录中的文档)
|
API |
标题 |
API概述 |
| ListRecentExperiments | 获取最近的工作流草稿 | 获取当前用户最近更新或创建的工作流草稿。 |
| GetExperimentsStatistics | 统计工作空间中工作流草稿的数量 | 获取实验统计信息 |
| GetExperimentsUsersStatistics | 统计创建了工作流草稿的用户 | 获取实验或文件夹所有者列表 |
| PreviewMCTable | 预览MaxCompute表 | 预览MaxCompute表数据。 |
| GetMCTableSchema | 获取MaxCompute表的Schema | 获取MaxCompute表的Scheme。 |
| SearchMCTables | 搜索MaxCompute表 | 在当前工作空间关联的MaxCompute project中搜索MaxCompute表。 |
| GetNodeInputSchema | 获取节点输入Schema | 获取节点输入Schema。 |
| GetExperimentVisualizationMeta | 获取工作流草稿可视化的Meta | 获取工作流草稿可视化信息的Meta。 |
| QueryExperimentVisualizationData | 获取工作流草稿可视化数据 | 获取工作流草稿可视化数据。 |
| GetAlgoTree | 获取算法树 | 获取算法树。 |
| ListNodeOutputs | 获取节点的输出模型 | 获取工作流草稿节点的输出模型。 |
| GetNodeOutput | 获取某个节点的输出模型信息 | 获取某个节点的输出模型信息。 |
| ListAuthRoles | 获取授权角色列表 | 获取授权角色列表。 |
| MigrateExperiments | 从Studio 1.0迁移工作流草稿到Designer | 从Studio 1.0迁移工作流草稿到Designer |
| CreateExperimentMigrateValidation | 创建工作流草稿迁移的校验 | 创建工作流草稿迁移的校 |
| MigrateExperimentFolders | 从Studio 1.0迁移工作流草稿目录 | 迁移PAI Studio 1.0的实验目录 |
| GetAlgorithmDefs | 批量获取算法定义 | 批量获取算法定义。 |
其他
|
API |
标题 |
API概述 |
| CreateExperiment | 创建工作流草稿 | 创建PAI Designer工作流草稿。 |
| CreateJob | 创建工作流草稿作业 | 创建工作流草稿的作业。 |
| DeleteExperiment | 删除工作流草稿 | 删除PAI Designer工作流草稿。 |
| GetExperiment | 获取工作流草稿 | 获取PAI Designer工作流草稿。 |
| ListExperiments | 获取工作流草稿列表 | 获取PAI Designer的工作流草稿列表。 |
| ListJobs | 获取工作流草稿作业列表 | 获取工作流草稿作业列表。 |
该文章对您有帮助吗？