Managing a Development Environment Instance

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

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

Table 1 describes the required parameters.

**Table 1** Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.
instance_id	Yes	String	Instance ID

Table 2 describes the request parameters.

**Table 2** Parameters
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.

Table 3 describes the response parameters.

**Table 3** Parameters
Parameter	Type	Description
current_status	String	Current status of an instance
previous_state	String	Previous status of an instance

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

{
    "action": "start"
}

Successful response

{
    "current_status": "STARTING",
    "previous_state": "STOPPED"
}

Failed response

{
    "error_message": "The instance does not exist.",
    "error_code": "ModelArts.6309"
}

For details about the status code, see Status Code.

Parent topic: DevEnviron (Old Version)

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.