Lai, Weijian 2f0818cf3d ModelArts API 22.3.0 version-20240311

Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>

2024-04-05 09:35:42 +00:00

8.7 KiB

Raw Blame History

Managing a Development Environment Instance

Function

This API is used to startor stop a notebook instance.

URI

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 the project ID, see Obtaining a Project ID and Name.
instance_id	Yes	String	Instance ID

Request Body

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

Response Body

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

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_message": "The instance does not exist.",
    "error_code": "ModelArts.6309"
}

Status Code

For details about the status code, see Status Code.

Parent topic: DevEnviron (Old Version)

8.7 KiB Raw Blame History