modelarts-umn/api-ref/source/devenviron/restarting_an_ml_studio_instance.rst
Artem Goncharov 488022ee6b
Import api-ref docs (#2)
Import api-ref docs

Reviewed-by: kucerakk <kucerakk@gmail.com>
2022-03-28 12:03:38 +00:00

3.8 KiB

Restarting an ML Studio Instance

Function

This API is used to restart an ML Studio development environment 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 and Name.
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 value can be restart.

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 restart the ML Studio instance whose ID is 47cf4ff3-0c59-44fe-9821-2840a34c02a9.

  • Sample request

    {
        "action": "restart"
    }
  • Sample response

    {
    "current_status": "REBOOTING",
    "previous_state": "ACTIVE"
    }

Status Code

For details about the status code, see Status Code.