自动机器学习API接口功能总览-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

API标准及多语言预置SDK

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

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

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

HPO

API	标题	API概述
CreateHpoExperiment	创建一个HPO实验	calling HPO CreateExperiment
ListHpoExperiments	搜索符合条件的HPO实验	查询符合条件的HPO实验信息。
GetHpoExperiment	获取一个HPO实验的信息	获取一个HPO实验的信息，包括状态、配置、以及所属trials的状态等数据。
UpdateHpoExperiment	更新HPO实验设置	更新一个正在运行中的HPO实验的设置。更新成功后，该实验将按照新的设置继续执行。
StopHpoExperiment	停止一个指定的HPO实验	完全停止一个指定的AutoML HPO实验，包括停止该实验所属的trials，和这些trials所依赖的后台任务。
DeleteHpoExperiment	删除一个HPO实验	删除一个HPO实验。删除后，实验和它的trials数据都不会再通过Get/List API返回。
ListHpoExperimentLogs	显示HPO实验一个指定log的内容	显示一个HPO实验指定log的内容。
ListHpoTrials	获取一个HPO实验里的多个trials信息	返回指定实验id的trial
GetHpoTrial	获取一个HPO实验里一个指定Trial的信息	获取一个HPO实验里一个指定Trial的信息。
StopHpoTrials	停止一个HPO实验里指定的trials	停止一个HPO实验里指定的trials，以及这些trials对应的后台任务。
RestartHpoTrials	重启一个HPO实验里失败的trials	重启一个HPO实验里失败的trials。对于指定的trial，提取它使用的超参配置。如果该实验所有使用这个配置的trials都没有成功过，那么用这个配置重新启动一个trial。
ListHpoTrialLogNames	获取HPO实验指定trial的所有log文件名称	返回指定的HPO实验里指定的trial所拥有的所有的log文件的名称。
ListHpoTrialLogs	显示一个HPO trial的一个指定的日志内容	分页显示一个hpo trial的一个指定日治的内容
ListHpoTrialCommands	获取HPO实验指定trial的后台任务的命令和输出	HPO一个trial会按配置里的命令集，顺序运行一个或多个后台命令。这些命令在执行时的输出可以通过这个API返回。

AutoFE

API	标题	API概述
CreateAutofeExperiment	创建一个自动特征工程实验。	CreateAutofeExperiment
GetAutofeExperiment	获取AutoFE实验信息	获取AutoFE实验信息。

其他

API	标题	API概述
CreateServiceIdentityRole	创建服务关联角色	创建服务关联角色。
GetServiceIdentityRole	获取服务关联角色相关信息	GetServiceIdentityRole, return role name if SLR exists, empty otherwise