本产品（
机器学习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实例的临时鉴权信息。 |