API概览

API标准及多语言预置SDK

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

自定义签名场景

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

账号与安全准备

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

资源组

API标题API概述
UpdateResourceGroup更新资源组您可以通过UpdateResourceGroup更新资源组信息。
ListResourceGroups获取资源组列表您可以通过该接口获取通用计算资源或灵骏智算资源的资源组列表。
GetResourceGroup获取资源组详情您可以通过GetResourceGroup获取资源组的详情信息。
CreateResourceGroup创建资源组您可以使用CreateResourceGroup创建ResourceGroup。
DeleteResourceGroup删除资源组您可以使用DeleteResourceGroup删除资源组。

训练算法

API标题API概述
CreateAlgorithm创建算法创建算法。
CreateAlgorithmVersion创建算法版本创建算法版本。
DeleteAlgorithm删除算法删除算法。
DeleteAlgorithmVersion删除算法版本删除算法版本。
GetAlgorithm获取算法详情获取算法详情。
GetAlgorithmVersion获取算法版本详情获取算法版本详情。
ListAlgorithms获取算法详情列表获取算法详情列表。
ListAlgorithmVersions获取算法版本详情列表获取算法版本详情列表。
UpdateAlgorithm更新算法更新算法。
UpdateAlgorithmVersion更新算法版本更新算法版本。

训练任务

API标题API概述
CreateTrainingJob创建训练任务创建训练任务。
CreateInstanceWebTerminal创建进入实例容器链接创建进入实例容器链接。
CheckInstanceWebTerminal校验进入实例容器链接校验进入实例容器链接。
DeleteTrainingJob删除训练任务删除一个训练任务。
DeleteTrainingJobLabels删除训练任务标签删除训练任务的标签。
GetToken获取训练任务分享令牌获取训练任务分享令牌。
GetTrainingJob获取训练任务详情获取训练任务的详情。
GetTrainingJobErrorInfo获取训练任务错误信息获取训练任务的运行错误信息。
GetTrainingJobLatestMetrics获取训练任务最新指标
ListTrainingJobs获取训练任务列表获取训练任务列表。
ListTrainingJobEvents获取训练任务事件获取指定训练任务的事件,以帮助您详细了解训练过程中的信息。
ListTrainingJobInstanceEvents获取训练任务实例事件获取训练任务实例对应的事件。
ListTrainingJobInstanceMetrics获取训练任务实例监控指标获取训练任务实例的监控指标。
ListTrainingJobLogs获取训练任务的日志获取训练任务的日志。
ListTrainingJobMetrics获取训练任务指标获取训练任务的监控数据。
ListTrainingJobOutputModels获取训练任务产出模型获取训练任务产出的模型信息。
StopTrainingJob停止训练任务停止一个训练任务。
UpdateTrainingJobLabels更新训练任务标签更新训练任务的标签。

资源配额

API标题API概述
CreateQuota创建资源配额您可以通过CreateQuota接口创建一个资源配额。
ListQuotas获取资源配额列表您可以通过ListQuotas获取资源配额列表。
GetQuota获取资源配额详情您可以通过GetQuota获取一个资源配额详情,以了解当前资源使用情况,方便进行资源管理和规划。
UpdateQuota更新资源配额配置您可以通过UpdateQuota更新一个资源配额信息。
ScaleQuota扩缩容资源配额您可以通过ScaleQuota扩缩容资源配额。
DeleteQuota删除资源配额您可以通过DeleteQuota删除一个资源配额。
ListQuotaWorkloads获取资源配额上的任务列表您可以通过此API获取Quota上的任务信息列表。

标签

API标题API概述
ListTagResources查询标签列表查标签接口。
TagResources为指定的资源列表统一创建并绑定标签打标签接口。
UntagResources为指定的资源列表统一解绑标签为指定的资源列表统一解绑标签。解绑后,如果该标签没有绑定其他任何资源,会被自动删除。

其他

API标题API概述
ListNodes获取节点列表获取资源节点列表。
GetSpotPriceHistory获取抢占式实例历史价格获取抢占式实例历史价格