API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(人工智能平台PAI-自动机器学习/2022-08-28)的 OpenAPI 采用 ROA 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

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

账号与安全准备

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

服务关联角色

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

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信息返回指定实验idtrial
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实验信息。