文档首页/ AI开发平台ModelArts/ API参考/ 历史API/ 开发环境（旧版）/ 管理开发环境实例
更新时间：2024-05-30 GMT+08:00
查看PDF
分享

管理开发环境实例

功能介绍

该接口用于启动、停止、重启、排队、取消排队开发环境Notebook实例。

URI

POST /v1/{project_id}/demanager/instances/{instance_id}/action

参数说明如表1所示。
表1 参数说明

参数

是否必选

参数类型

说明。

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。

instance_id

是

String

实例ID。

请求消息

请求参数如表2所示。
表2 请求参数

参数

是否必选

参数类型

说明。

action

是

String

操作开发环境实例，支持：

  • start
  • stop
  • restart
  • queue
  • dequeue

其中，queue和dequeue仅支持对免费资源进行操作。

响应消息

响应参数如表3所示。

表3 响应参数

参数

参数类型

说明

current_status

String

实例当前状态。

previous_state

String

实例上一状态。

请求示例

如下以启动实例ID为“6fa459ea-ee8a-3ca4-894e-db77e160355e”的实例为例。

{
    "action": "start"
}

响应示例

  • 成功响应示例 
    {
    "current_status": "STARTING",
    "previous_state": "STOPPED"
}
  • 失败响应示例 
    {
    "error_message": "The instance does not exist.",
    "error_code": "ModelArts.6309"
}

状态码

状态码请参见状态码。