Help Center> ModelArts> API Reference> Development Environment> Managing a Development Environment Instance
View PDF

Managing a Development Environment Instance

Function

This API is used to start, stop, restart, queue, or cancel queuing of a notebook instance.

URI

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

Table 1 describes the required parameters.
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID

Request Body

Table 2 describes the request parameters.
Table 2 Parameter description

Parameter

Mandatory

Type

Description

action

Yes

String

Operation on a development environment instance. The options are as follows:

  • start
  • stop
  • restart
  • queue
  • dequeue

queue and dequeue operations can be performed only on free resources.

Response Body

Table 3 describes the response parameters.

Table 3 Parameter description

Parameter

Type

Description

current_status

String

Current status of an instance

previous_state

String

Previous status of an instance

Samples

The following shows how to start instance 6fa459ea-ee8a-3ca4-894e-db77e160355e.

  • Sample request 
    {
    "action": "start"
}
  • Successful sample response 
    {
    "current_status": "STARTING",
    "previous_state": "STOPPED"
}
  • Failed sample response 
    {
    "error_msg": "The instance does not exist.",
    "error_code": "ModelArts.6309"
}

Status Code

For details about the status code, see Status Code.

Parent topic: Development Environment