文档

API概览

更新时间:
本产品(机器学习PAI-交互式建模/2022-01-01)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例

API标题API概述
CreateInstance创建实例调用CreateInstance创建一个DSW实例。
DeleteInstance删除实例删除指定DSW实例。
UpdateInstance更新实例更新DSW实例的属性。
StartInstance启动实例启动DSW实例。
StopInstance停止实例调用StopInstance,停止DSW实例。
GetInstance查询实例详情查询DSW实例详情。
ListInstances查询实例列表查询DSW实例列表。
GetInstanceEvents获取实例的事件列表获取DSW实例的系统事件。

生命周期

API标题API概述
GetLifecycle获取实例生命周期获取实例的生命周期。

资源监控

API标题API概述
GetInstanceMetrics获取实例指标获取实例运行的资源指标。

实例快照

API标题API概述
CreateInstanceSnapshot创建实例快照创建实例快照。
DeleteInstanceSnapshot删除实例快照删除实例快照。
GetInstanceSnapshot获取实例快照调用GetInstanceSnapshot,获取用户实例快照。
ListInstanceSnapshot查询实例快照列表查询实例快照列表。

统计

API标题API概述
GetResourceGroupStatistics获取资源组统计信息资源组是特定用户,在使用PAI产品前,预先购买的一组机器资源;这些机器资源专属于此客户,不会被其他客户分享。用户后续的PAI计算任务,或算法开发环境,将运行在这组机器上。 此功能用于统计在指定资源组上,运行的DSW实例(算法开发环境)的当前和历史运行状态(成功,失败,停止等等),以帮助用户了解在资源组内运行任务的历史状态,更有效率的利用资源组内的机器资源。
ListInstanceStatistics获取实例统计信息获取实例统计信息。

实例定时自动关机

API标题API概述
CreateInstanceShutdownTimer创建实例定时关机任务调用CreateInstanceShutdownTimer,创建实例定时关机任务。
DeleteInstanceShutdownTimer删除实例定时关机任务删除实例定时关机任务。
GetInstanceShutdownTimer获取实例定时关机任务详情获取实例定时关机任务详情。

闲置实例自动关机

API标题API概述
CreateIdleInstanceCuller创建闲置实例自动关机策略创建指定实例的自动关机策略,满足条件时将自动停止DSW实例。一个DSW实例只支持创建一个闲置自动关机策略,如果指定实例已设定过闲置自动关机策略,请先调用DeleteIdleInstanceCuller将其删除。
DeleteIdleInstanceCuller删除实例闲置关机策略删除实例闲置关机策略。
GetIdleInstanceCuller获取闲置实例自动关机策略获取指定实例的闲置自动关机策略。

ECS规格

API标题API概述
ListEcsSpecs获取ECS规格列表获取ECS规格列表。

用户配置

API标题API概述
GetUserConfig查询用户信息调用GetUserConfig,查询用户信息。

其他

API标题API概述
GetToken获取实例临时鉴权信息获取指定DSW实例的临时鉴权信息。
  • 本页导读 (1)