API概览

更新时间:
复制为 MD 格式

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

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

资源组

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 获取训练任务最新指标 获取TrainingJob最近的Metrics
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 获取抢占式实例历史价格 获取抢占式实例历史价格
OperateNode 操作节点 您可以通过OperateNode对节点进行操作