forked from docs/doc-exports
525370b67d
ModelArts GA API 06052022 from R&D R&D has provided a right version of ModelArts GA API (06052022) Reviewed-by: Artem Goncharov <Artem.goncharov@gmail.com>
121 lines
11 KiB
HTML
121 lines
11 KiB
HTML
<a name="modelarts_03_0115"></a><a name="modelarts_03_0115"></a>
|
|
|
|
<h1 class="topictitle1">Managing a Development Environment Instance</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0115__en-us_topic_0136223954_section88894735616"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0115__en-us_topic_0136223954_p17844122205611">This API is used to startor stop a notebook instance.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0115__en-us_topic_0136223954_section20261580353"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0115__en-us_topic_0136223954_p134094315119">POST /v1/{project_id}/demanager/instances/{instance_id}/action</p>
|
|
</div>
|
|
<div class="p" id="modelarts_03_0115__en-us_topic_0136223954_p149561641164510"><a href="#modelarts_03_0115__en-us_topic_0136223954_table569625523811">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0115__en-us_topic_0136223954_table569625523811"></a><a name="en-us_topic_0136223954_table569625523811"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0115__en-us_topic_0136223954_table569625523811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0115__en-us_topic_0136223954_row169945510386"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.2.2.5.1.1"><p id="modelarts_03_0115__en-us_topic_0136223954_p370019557384">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.5.1.2"><p id="modelarts_03_0115__en-us_topic_0136223954_p2702115512388">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.2.5.1.3"><p id="modelarts_03_0115__en-us_topic_0136223954_p1704955163819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.3.2.2.5.1.4"><p id="modelarts_03_0115__en-us_topic_0136223954_p070515554383">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0115__en-us_topic_0136223954_row187062555388"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_03_0115__en-us_topic_0136223954_p570711558389">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_03_0115__en-us_topic_0136223954_p1070819552389">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_03_0115__en-us_topic_0136223954_p147095558384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_03_0115__en-us_topic_0136223954_p4972959911831">Project ID. For details about how to obtain the project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0115__en-us_topic_0136223954_row16670119161415"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_03_0115__en-us_topic_0136223954_p11308137181317">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_03_0115__en-us_topic_0136223954_p175711944161316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_03_0115__en-us_topic_0136223954_p05711544181313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_03_0115__en-us_topic_0136223954_p830883717136">Instance ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0115__en-us_topic_0136223954_section722833995517"><h4 class="sectiontitle">Request Body</h4><div class="p" id="modelarts_03_0115__en-us_topic_0136223954_p61943115467"><a href="#modelarts_03_0115__en-us_topic_0136223954_table46411941555">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0115__en-us_topic_0136223954_table46411941555"></a><a name="en-us_topic_0136223954_table46411941555"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0115__en-us_topic_0136223954_table46411941555" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0115__en-us_topic_0136223954_row26431149518"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.2.2.2.5.1.1"><p id="modelarts_03_0115__en-us_topic_0136223954_p66461141354">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.2.2.5.1.2"><p id="modelarts_03_0115__en-us_topic_0136223954_p9646841254">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.2.2.2.5.1.3"><p id="modelarts_03_0115__en-us_topic_0136223954_p06477412510">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.2.2.2.5.1.4"><p id="modelarts_03_0115__en-us_topic_0136223954_p76491840517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0115__en-us_topic_0136223954_row14649141251"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.2.2.5.1.1 "><p id="modelarts_03_0115__en-us_topic_0136223954_p135851959153210">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.2.5.1.2 "><p id="modelarts_03_0115__en-us_topic_0136223954_p2585859143211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.2.2.5.1.3 "><p id="modelarts_03_0115__en-us_topic_0136223954_p5585135923214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.2.2.5.1.4 "><p id="modelarts_03_0115__en-us_topic_0136223954_p1726412121981">Operation on a development environment instance. The options are as follows:</p>
|
|
<ul id="modelarts_03_0115__en-us_topic_0136223954_ul121104457206"><li id="modelarts_03_0115__en-us_topic_0136223954_li7111645152017"><strong id="modelarts_03_0115__en-us_topic_0136223954_b169731430204611">start</strong></li><li id="modelarts_03_0115__en-us_topic_0136223954_li177241647172018"><strong id="modelarts_03_0115__en-us_topic_0136223954_b1875014324468">stop</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0115__en-us_topic_0136223954_section8857352133212"><h4 class="sectiontitle">Response Body</h4><p id="modelarts_03_0115__en-us_topic_0136223954_p171672054134620"><a href="#modelarts_03_0115__en-us_topic_0136223954_table14581542113111">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0115__en-us_topic_0136223954_table14581542113111"></a><a name="en-us_topic_0136223954_table14581542113111"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0115__en-us_topic_0136223954_table14581542113111" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0115__en-us_topic_0136223954_row7581144216315"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.5.3.2.4.1.1"><p id="modelarts_03_0115__en-us_topic_0136223954_p4886449203110">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.5.3.2.4.1.2"><p id="modelarts_03_0115__en-us_topic_0136223954_p1388718492317">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65%" id="mcps1.3.5.3.2.4.1.3"><p id="modelarts_03_0115__en-us_topic_0136223954_p48891049143113">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0115__en-us_topic_0136223954_row1558134210313"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0115__en-us_topic_0136223954_p478563424717">current_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0115__en-us_topic_0136223954_p7741113017490">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0115__en-us_topic_0136223954_p56329492917">Current status of an instance</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0115__en-us_topic_0136223954_row0159718325"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0115__en-us_topic_0136223954_p101604112325">previous_state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0115__en-us_topic_0136223954_p12160161183219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0115__en-us_topic_0136223954_p126776443415">Previous status of an instance</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0115__en-us_topic_0136223954_section207913354815"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0115__en-us_topic_0136223954_p1023743012319">The following shows how to start instance <span class="parmvalue" id="modelarts_03_0115__en-us_topic_0136223954_parmvalue92591917526"><b>6fa459ea-ee8a-3ca4-894e-db77e160355e</b></span>.</p>
|
|
<ul id="modelarts_03_0115__en-us_topic_0136223954_ul865811485616"><li id="modelarts_03_0115__en-us_topic_0136223954_li142441340112511">Sample request<pre class="screen" id="modelarts_03_0115__en-us_topic_0136223954_screen725313225527">{
|
|
"action": "start"
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="modelarts_03_0115__en-us_topic_0136223954_ul491082154516"><li id="modelarts_03_0115__en-us_topic_0136223954_li992710100564">Successful sample response<pre class="screen" id="modelarts_03_0115__en-us_topic_0136223954_screen1670163495212">{
|
|
"current_status": "STARTING",
|
|
"previous_state": "STOPPED"
|
|
}</pre>
|
|
</li><li id="modelarts_03_0115__en-us_topic_0136223954_li3645112016373">Failed sample response<pre class="screen" id="modelarts_03_0115__en-us_topic_0136223954_screen113794419527">{
|
|
"error_message": "The instance does not exist.",
|
|
"error_code": "ModelArts.6309"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0115__en-us_topic_0136223954_section157661945274"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0115__en-us_topic_0136223954_p919113015575">For details about the status code, see <a href="modelarts_03_0094.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0115__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0115__p1572811255123">See <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0108.html">DevEnviron</a></div>
|
|
</div>
|
|
</div>
|
|
|