yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
c3942cbc2c838523f02d2277ab2068ded07ab4b2
doc-exports/docs/modelarts/api-ref/StartNotebook.html
Wuwan, Qi 4ee10e3166 ModelArts API 24.9.0 20250414 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2025-05-09 10:22:58 +00:00

806 lines
76 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002233726950"></a><a name="EN-US_TOPIC_0000002233726950"></a>
<h1 class="topictitle1">Starting a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002233726950__section1729257123619"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002233726950__p1072975793612">This API is used to start a notebook instance.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726950__section19730257173612"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002233726950__p10730457103616">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726950__section9730125712368"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002233726950__p17731145715360">POST /v1/{project_id}/notebooks/{id}/start</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__table37319578364" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row47311857173617"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002233726950__p12732857123611">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002233726950__p1673235717363">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002233726950__p13732145717361">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002233726950__p9732165713613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row12731657113617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726950__p147328579363">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726950__p11733557153614">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726950__p11733155703617">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726950__p18733857103613">Notebook instance ID, which can be obtained by calling the API for querying the notebook instance list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1173125713619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726950__p973310577363">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726950__p8733757103610">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726950__p073315712366">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726950__p373345763614">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__table8734457193620" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row673495718367"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000002233726950__p873455719367">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000002233726950__p10734125783615">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000002233726950__p1173514570367">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000002233726950__p87351578366">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row3734757163611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726950__p107351757153612">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726950__p4735165793613">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726950__p9735145713617">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726950__p127351157103615">Running duration after startup, in milliseconds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row19734155793614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726950__p073515713620">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726950__p167351257183615">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1973605719363">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726950__p1173685716367">Automatic stop type. The default value is timing.</p>
<ul id="EN-US_TOPIC_0000002233726950__ul6736105753613"><li id="EN-US_TOPIC_0000002233726950__li473615577365"><p id="EN-US_TOPIC_0000002233726950__p13736135753617"><a name="EN-US_TOPIC_0000002233726950__li473615577365"></a><a name="li473615577365"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li97365573362"><p id="EN-US_TOPIC_0000002233726950__p4736175773619"><a name="EN-US_TOPIC_0000002233726950__li97365573362"></a><a name="li97365573362"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726950__section2736557203616"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002233726950__p16736657143613">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726950__section15736157203610"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002233726950__p5737195713620"><strong id="EN-US_TOPIC_0000002233726950__b57371757113611">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row2737857143618"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p16738105710365">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p17739115715364">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p147391557113613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row87371657153616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p974055712367">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p127401657173611">Array of <a href="#EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_JobProgress">JobProgress</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p97400577361">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row173710570367"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p13740457103618">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p774010577364">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p197401757153614">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row5737457183619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p0741957193611">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p147411957143612">Array of <a href="#EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_EndpointsRes">EndpointsRes</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p11741115712366">This section describes how to configure the local IDE (such as PyCharm and VS Code) or SSH client to remotely access a notebook instance through SSH.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row37371057183613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p974175714366">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1374116578367">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1374235715364">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row11737557123617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p137422574369">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1074213576365">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p17421857193615">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row27371057133617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p2074217572360">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p19742657193617">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1074235713369">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row3737357103613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p37431457193618">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1174395715360"><a href="#EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Image">Image</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p137431957163616">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1738135713364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p97431257133615">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p117431357153612"><a href="#EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Lease">Lease</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p16743185783619">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row5738125715365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p167441575367">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1574445753619">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p67441457163616">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1073813577367"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1274475715367">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1374475718364"><a href="#EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Pool">Pool</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1574411574368">Basic information about the dedicated pool, which is returned by the instance created in the dedicated pool.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row17738657183613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p12744195773613">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p147451857193615">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p12745185743616">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul7745115715361"><li id="EN-US_TOPIC_0000002233726950__li12745195723620"><p id="EN-US_TOPIC_0000002233726950__p27451257193614"><a name="EN-US_TOPIC_0000002233726950__li12745195723620"></a><a name="li12745195723620"></a><strong id="EN-US_TOPIC_0000002233726950__b574511574361">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li1974585717363"><p id="EN-US_TOPIC_0000002233726950__p274512576369"><a name="EN-US_TOPIC_0000002233726950__li1974585717363"></a><a name="li1974585717363"></a><strong id="EN-US_TOPIC_0000002233726950__b17745657113617">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li174512573365"><p id="EN-US_TOPIC_0000002233726950__p7745115703619"><a name="EN-US_TOPIC_0000002233726950__li174512573365"></a><a name="li174512573365"></a><strong id="EN-US_TOPIC_0000002233726950__b57456576360">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li20745557163613"><p id="EN-US_TOPIC_0000002233726950__p10745115743611"><a name="EN-US_TOPIC_0000002233726950__li20745557163613"></a><a name="li20745557163613"></a><strong id="EN-US_TOPIC_0000002233726950__b18745457203610">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li10746185717365"><p id="EN-US_TOPIC_0000002233726950__p574635723617"><a name="EN-US_TOPIC_0000002233726950__li10746185717365"></a><a name="li10746185717365"></a><strong id="EN-US_TOPIC_0000002233726950__b10746145717366">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li1974625783615"><p id="EN-US_TOPIC_0000002233726950__p177464573363"><a name="EN-US_TOPIC_0000002233726950__li1974625783615"></a><a name="li1974625783615"></a><strong id="EN-US_TOPIC_0000002233726950__b137466575367">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li774645713614"><p id="EN-US_TOPIC_0000002233726950__p1074625710369"><a name="EN-US_TOPIC_0000002233726950__li774645713614"></a><a name="li774645713614"></a><strong id="EN-US_TOPIC_0000002233726950__b16746957143612">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li174715718365"><p id="EN-US_TOPIC_0000002233726950__p1174755743618"><a name="EN-US_TOPIC_0000002233726950__li174715718365"></a><a name="li174715718365"></a><strong id="EN-US_TOPIC_0000002233726950__b474710571368">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li207472057143616"><p id="EN-US_TOPIC_0000002233726950__p1274785723610"><a name="EN-US_TOPIC_0000002233726950__li207472057143616"></a><a name="li207472057143616"></a><strong id="EN-US_TOPIC_0000002233726950__b574775715360">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li19747125713611"><p id="EN-US_TOPIC_0000002233726950__p9747195763613"><a name="EN-US_TOPIC_0000002233726950__li19747125713611"></a><a name="li19747125713611"></a><strong id="EN-US_TOPIC_0000002233726950__b8747557113616">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li4747175710367"><p id="EN-US_TOPIC_0000002233726950__p18748185712368"><a name="EN-US_TOPIC_0000002233726950__li4747175710367"></a><a name="li4747175710367"></a><strong id="EN-US_TOPIC_0000002233726950__b474835716366">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li5748145703615"><p id="EN-US_TOPIC_0000002233726950__p20748115753610"><a name="EN-US_TOPIC_0000002233726950__li5748145703615"></a><a name="li5748145703615"></a><strong id="EN-US_TOPIC_0000002233726950__b874815716363">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li1748195773616"><p id="EN-US_TOPIC_0000002233726950__p107482572368"><a name="EN-US_TOPIC_0000002233726950__li1748195773616"></a><a name="li1748195773616"></a><strong id="EN-US_TOPIC_0000002233726950__b10748257113619">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li19748195717364"><p id="EN-US_TOPIC_0000002233726950__p2748657113618"><a name="EN-US_TOPIC_0000002233726950__li19748195717364"></a><a name="li19748195717364"></a><strong id="EN-US_TOPIC_0000002233726950__b974912574364">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row97381571363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p17749155715369">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p97491757183616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p774925773614">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row20738857183616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p574985783614">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1075075712362">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p5750357163610">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row12738155719364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p37501457193616">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p97501574367"><a href="#EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_VolumeRes">VolumeRes</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p675045793612">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row117381157113613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p12751125715364">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1375119570369">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p575175793613">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726950__b675185773613">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row57381457163619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p10751357113611">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p12751457123618">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p127511557193611">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul16751135717361"><li id="EN-US_TOPIC_0000002233726950__li7751957173619"><p id="EN-US_TOPIC_0000002233726950__p875110572365"><a name="EN-US_TOPIC_0000002233726950__li7751957173619"></a><a name="li7751957173619"></a><strong id="EN-US_TOPIC_0000002233726950__b7751185793616">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li1975116574363"><p id="EN-US_TOPIC_0000002233726950__p1875275723616"><a name="EN-US_TOPIC_0000002233726950__li1975116574363"></a><a name="li1975116574363"></a><strong id="EN-US_TOPIC_0000002233726950__b13752195773610">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1973811571366"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p57521257173617">billing_items</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p147522572361">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p6752357143619">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002233726950__p07525579367">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726950__p1375215713363">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726950__p117525577366">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1473814576361"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p475214579364">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p77521578365"><a href="#EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_user">user</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p5753125793611">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_JobProgress"></a><a name="en-us_topic_0000002091201333_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 4 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row1175316570364"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p2753105714365">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p8754195723618">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p157541573365">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row197531957123610"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p14754185703620">notebook_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1754257193614">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p16754257193615">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row147539576365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p20754145763620">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p475455716364">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p0755357153617">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul1275514575369"><li id="EN-US_TOPIC_0000002233726950__li18755757113616"><p id="EN-US_TOPIC_0000002233726950__p07551357103615"><a name="EN-US_TOPIC_0000002233726950__li18755757113616"></a><a name="li18755757113616"></a><strong id="EN-US_TOPIC_0000002233726950__b375517578363">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li9755457153614"><p id="EN-US_TOPIC_0000002233726950__p87555572367"><a name="EN-US_TOPIC_0000002233726950__li9755457153614"></a><a name="li9755457153614"></a><strong id="EN-US_TOPIC_0000002233726950__b137551757123617">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li5755175719362"><p id="EN-US_TOPIC_0000002233726950__p19756157163611"><a name="EN-US_TOPIC_0000002233726950__li5755175719362"></a><a name="li5755175719362"></a><strong id="EN-US_TOPIC_0000002233726950__b1975618573367">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li9756145720365"><p id="EN-US_TOPIC_0000002233726950__p2756557163619"><a name="EN-US_TOPIC_0000002233726950__li9756145720365"></a><a name="li9756145720365"></a><strong id="EN-US_TOPIC_0000002233726950__b12756125733610">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row27531257103615"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p67562571368">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p075785763612">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p117571757153614">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul1275785783614"><li id="EN-US_TOPIC_0000002233726950__li37572571361"><p id="EN-US_TOPIC_0000002233726950__p1575735713617"><a name="EN-US_TOPIC_0000002233726950__li37572571361"></a><a name="li37572571361"></a><strong id="EN-US_TOPIC_0000002233726950__b275713578364">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li107578577360"><p id="EN-US_TOPIC_0000002233726950__p197573574368"><a name="EN-US_TOPIC_0000002233726950__li107578577360"></a><a name="li107578577360"></a><strong id="EN-US_TOPIC_0000002233726950__b197574576367">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li075795719360"><p id="EN-US_TOPIC_0000002233726950__p1875813578361"><a name="EN-US_TOPIC_0000002233726950__li075795719360"></a><a name="li075795719360"></a><strong id="EN-US_TOPIC_0000002233726950__b1758557103620">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li87581057193619"><p id="EN-US_TOPIC_0000002233726950__p97581457153614"><a name="EN-US_TOPIC_0000002233726950__li87581057193619"></a><a name="li87581057193619"></a><strong id="EN-US_TOPIC_0000002233726950__b17758135713616">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row7753357203617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p14758175753618">step_description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1075812571365">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1175895719363">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_EndpointsRes"></a><a name="en-us_topic_0000002091201333_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 5 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row175985710369"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p18759165733610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p47599570366">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p19760195714368">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row1675918572366"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p07606571362">allowed_access_ips</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p7760657183613">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1176016575368">Whitelist of public IP addresses that are allowed to access the notebook instance through SSH. By default, all public IP addresses can access the notebook instance. If this parameter is specified, only the clients with the specified IP addresses can access the notebook instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row14759195733616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p14760557123613">dev_service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p10760115716362">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p10760195719364">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul2761195773615"><li id="EN-US_TOPIC_0000002233726950__li13761205718365"><p id="EN-US_TOPIC_0000002233726950__p13761757103617"><a name="EN-US_TOPIC_0000002233726950__li13761205718365"></a><a name="li13761205718365"></a><strong id="EN-US_TOPIC_0000002233726950__b176118574364">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li8761115719362"><p id="EN-US_TOPIC_0000002233726950__p976155711361"><a name="EN-US_TOPIC_0000002233726950__li8761115719362"></a><a name="li8761115719362"></a><strong id="EN-US_TOPIC_0000002233726950__b18761657123620">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row8759165733611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1576111574368">ssh_keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1176155714360">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p10761105717367">List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row97591557153612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1276211577367">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p127621957113613">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p197621157133616">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul1276255713363"><li id="EN-US_TOPIC_0000002233726950__li376235717363"><p id="EN-US_TOPIC_0000002233726950__p1276265753618"><a name="EN-US_TOPIC_0000002233726950__li376235717363"></a><a name="li376235717363"></a><strong id="EN-US_TOPIC_0000002233726950__b107621757193618">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li10762857133614"><p id="EN-US_TOPIC_0000002233726950__p276215571365"><a name="EN-US_TOPIC_0000002233726950__li10762857133614"></a><a name="li10762857133614"></a><strong id="EN-US_TOPIC_0000002233726950__b107631757173620">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row57596578362"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1763357153610">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p127631157143610">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p10763205783611">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Image"></a><a name="en-us_topic_0000002091201333_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Image" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row1576445753614"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p1276505717369">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p77666575360">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p18766185712362">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row276415783610"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p0766457143618">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1976615572364">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p13766057123612">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul19766185718360"><li id="EN-US_TOPIC_0000002233726950__li10766195733616"><p id="EN-US_TOPIC_0000002233726950__p14766195712364"><a name="EN-US_TOPIC_0000002233726950__li10766195733616"></a><a name="li10766195733616"></a><strong id="EN-US_TOPIC_0000002233726950__b1976618573366">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002233726950__li9766125715366"><p id="EN-US_TOPIC_0000002233726950__p207661357183611"><a name="EN-US_TOPIC_0000002233726950__li9766125715366"></a><a name="li9766125715366"></a><strong id="EN-US_TOPIC_0000002233726950__b1976765719368">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row197641557103612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1576713572366">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p276765773619">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p147671057193614">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row3764165714360"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p5767165710361">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1767205703610">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p13767185711367">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row15764257183617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p47671757193617">dev_services</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p976825743610">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p2076835783615">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul3768115719369"><li id="EN-US_TOPIC_0000002233726950__li8768257123619"><p id="EN-US_TOPIC_0000002233726950__p876875753612"><a name="EN-US_TOPIC_0000002233726950__li8768257123619"></a><a name="li8768257123619"></a><strong id="EN-US_TOPIC_0000002233726950__b1676812578369">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li2076815714366"><p id="EN-US_TOPIC_0000002233726950__p167687575362"><a name="EN-US_TOPIC_0000002233726950__li2076815714366"></a><a name="li2076815714366"></a><strong id="EN-US_TOPIC_0000002233726950__b127683576369">SSH</strong>: You can remotely access a notebook instance from a local IDE through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row19764557163617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p2768135713611">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p147683579367">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p107681857163611">Specifies the image ID of the notebook instance to be created. The image ID is in the Universally Unique Identifier (UUID) format. For details about how to obtain the ID of a preset image, see ListImage.xml.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row8764657103620"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p15769145753614">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p117698576369">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p10769155783611">Image name, which contains a maximum of 512 characters, including lowercase letters, digits, hyphens (-), underscores (_), and periods (.)</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1776435723615"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p176995743610">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p16769105733614">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p376955718361">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002233726950__b157711157123620">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row0764157133616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p12431858103620">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p104395883620">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p19431658153612">Image source, which defaults to <strong id="EN-US_TOPIC_0000002233726950__b184345815360">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul184385817367"><li id="EN-US_TOPIC_0000002233726950__li1143115816368"><p id="EN-US_TOPIC_0000002233726950__p104319582369"><a name="EN-US_TOPIC_0000002233726950__li1143115816368"></a><a name="li1143115816368"></a><strong id="EN-US_TOPIC_0000002233726950__b124355823619">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002233726950__li7433582364"><p id="EN-US_TOPIC_0000002233726950__p1943165819364"><a name="EN-US_TOPIC_0000002233726950__li7433582364"></a><a name="li7433582364"></a><strong id="EN-US_TOPIC_0000002233726950__b174335873615">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row117641571368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p2435589364">resource_categories</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p13431158143613">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p944145863614">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul444558153617"><li id="EN-US_TOPIC_0000002233726950__li1644258103617"><p id="EN-US_TOPIC_0000002233726950__p24415823617"><a name="EN-US_TOPIC_0000002233726950__li1644258103617"></a><a name="li1644258103617"></a><strong id="EN-US_TOPIC_0000002233726950__b134435843617">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726950__li194465813365"><p id="EN-US_TOPIC_0000002233726950__p1044158193611"><a name="EN-US_TOPIC_0000002233726950__li194465813365"></a><a name="li194465813365"></a><strong id="EN-US_TOPIC_0000002233726950__b15441058103619">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row576435715366"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p19441658143616">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p18440589366">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p19441358123614">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul1944145873611"><li id="EN-US_TOPIC_0000002233726950__li34465818361"><p id="EN-US_TOPIC_0000002233726950__p344158133620"><a name="EN-US_TOPIC_0000002233726950__li34465818361"></a><a name="li34465818361"></a><strong id="EN-US_TOPIC_0000002233726950__b134445873610">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002233726950__li1441658133619"><p id="EN-US_TOPIC_0000002233726950__p444858163617"><a name="EN-US_TOPIC_0000002233726950__li1441658133619"></a><a name="li1441658133619"></a><strong id="EN-US_TOPIC_0000002233726950__b244145814363">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002233726950__li744135863615"><p id="EN-US_TOPIC_0000002233726950__p134455823615"><a name="EN-US_TOPIC_0000002233726950__li744135863615"></a><a name="li744135863615"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002233726950__li944125810367"><p id="EN-US_TOPIC_0000002233726950__p344758183610"><a name="EN-US_TOPIC_0000002233726950__li944125810367"></a><a name="li944125810367"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002233726950__li644175816365"><p id="EN-US_TOPIC_0000002233726950__p10441458153617"><a name="EN-US_TOPIC_0000002233726950__li644175816365"></a><a name="li644175816365"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row27643575369"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p17445583363">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p124414587367">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p11441558183613">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row12764357183611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p114435893617">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p134415585367">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p2448581369">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul44465818361"><li id="EN-US_TOPIC_0000002233726950__li1644125818368"><p id="EN-US_TOPIC_0000002233726950__p5441658143616"><a name="EN-US_TOPIC_0000002233726950__li1644125818368"></a><a name="li1644125818368"></a><strong id="EN-US_TOPIC_0000002233726950__b174445843611">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li44475818362"><p id="EN-US_TOPIC_0000002233726950__p9441858153614"><a name="EN-US_TOPIC_0000002233726950__li44475818362"></a><a name="li44475818362"></a><strong id="EN-US_TOPIC_0000002233726950__b444205893618">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li34405814361"><p id="EN-US_TOPIC_0000002233726950__p344165813617"><a name="EN-US_TOPIC_0000002233726950__li34405814361"></a><a name="li34405814361"></a><strong id="EN-US_TOPIC_0000002233726950__b1544115815367">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li194416587366"><p id="EN-US_TOPIC_0000002233726950__p194465818361"><a name="EN-US_TOPIC_0000002233726950__li194416587366"></a><a name="li194416587366"></a><strong id="EN-US_TOPIC_0000002233726950__b544185810369">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li184519586366"><p id="EN-US_TOPIC_0000002233726950__p114585883610"><a name="EN-US_TOPIC_0000002233726950__li184519586366"></a><a name="li184519586366"></a><strong id="EN-US_TOPIC_0000002233726950__b64519589363">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li4456584366"><p id="EN-US_TOPIC_0000002233726950__p645105819369"><a name="EN-US_TOPIC_0000002233726950__li4456584366"></a><a name="li4456584366"></a><strong id="EN-US_TOPIC_0000002233726950__b14535873610">ACTIVE</strong>: The image has been saved, which you can view on the SWR console and use to create notebook instances.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1576411576365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p2458581366">status_message</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1451058113615">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1145185813620">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row37641857133611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1245135873612">support_res_categories</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p84512586367">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p124515873612">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul64535819368"><li id="EN-US_TOPIC_0000002233726950__li94555815366"><p id="EN-US_TOPIC_0000002233726950__p6458585366"><a name="EN-US_TOPIC_0000002233726950__li94555815366"></a><a name="li94555815366"></a><strong id="EN-US_TOPIC_0000002233726950__b104518580363">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726950__li1645358103610"><p id="EN-US_TOPIC_0000002233726950__p16451558183615"><a name="EN-US_TOPIC_0000002233726950__li1645358103610"></a><a name="li1645358103610"></a><strong id="EN-US_TOPIC_0000002233726950__b14453581362">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row9765185715366"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p7452585363">swr_path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p3453582360">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p104525843620">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1776518576363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p144519581365">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1545658133618">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p245358163614">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row2076505723619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p114511581363">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p194575815368">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p445135811369">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul74515814369"><li id="EN-US_TOPIC_0000002233726950__li64545863610"><p id="EN-US_TOPIC_0000002233726950__p1545658103614"><a name="EN-US_TOPIC_0000002233726950__li64545863610"></a><a name="li64545863610"></a><strong id="EN-US_TOPIC_0000002233726950__b1145158163620">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002233726950__li13454583366"><p id="EN-US_TOPIC_0000002233726950__p1745135893610"><a name="EN-US_TOPIC_0000002233726950__li13454583366"></a><a name="li13454583366"></a><strong id="EN-US_TOPIC_0000002233726950__b1645115833611">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row3765557153612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p34516584364">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p20451258173614">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p11451458143612">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row87652057153614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p14595817369">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p74595883617">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p184565811368">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul0451658183618"><li id="EN-US_TOPIC_0000002233726950__li3451658103617"><p id="EN-US_TOPIC_0000002233726950__p84575803614"><a name="EN-US_TOPIC_0000002233726950__li3451658103617"></a><a name="li3451658103617"></a><strong id="EN-US_TOPIC_0000002233726950__b145155819362">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002233726950__li345115833618"><p id="EN-US_TOPIC_0000002233726950__p124545893617"><a name="EN-US_TOPIC_0000002233726950__li345115833618"></a><a name="li345115833618"></a><strong id="EN-US_TOPIC_0000002233726950__b184515586362">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row576525712365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p124565817369">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p12450585366">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p174605883619">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726950__b246858143618">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row0765185712362"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1246165863616">flavor_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p2461158113612">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p546155815363">Image resource type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Lease"></a><a name="en-us_topic_0000002091201333_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row11778135720366"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p184615863616">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p446105816368">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.7.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p646175863620">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row1877816577365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p246258183612">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p846135853614">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p746058193613">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row10778357103616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p946858113615">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p104675812361">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p346185873612">Instance running duration, which is calculated based on the instance creation time. If the instance creation time plus the duration is greater than the current time, the system automatically stops the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row2778457193615"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p446165813614">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p154613584362">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1646125843620">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1177845717369"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p174645803611">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p346145818364">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1046155893614">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002233726950__ul3461258193615"><li id="EN-US_TOPIC_0000002233726950__li1846185833618"><p id="EN-US_TOPIC_0000002233726950__p154612585366"><a name="EN-US_TOPIC_0000002233726950__li1846185833618"></a><a name="li1846185833618"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li114655893614"><p id="EN-US_TOPIC_0000002233726950__p64614588367"><a name="EN-US_TOPIC_0000002233726950__li114655893614"></a><a name="li114655893614"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row07781157193615"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p134614584366">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p134610588361">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p9461458143613">Time when the instance is last updated (excluding the heartbeat detection time), in UTC milliseconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Pool"></a><a name="en-us_topic_0000002091201333_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row187801157133617"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p346658103619">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p346185853616">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.8.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p946125813617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row9781115715361"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1547195833610">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p74714580364">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p12477582368">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row378185715367"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p74715818366">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p2479589369">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p0475589368">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_VolumeRes"></a><a name="en-us_topic_0000002091201333_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 9 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row167821057143612"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p184755820368">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p14714581364">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.9.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p4471758113619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row27821657173610"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1847358183616">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1847958133614">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1471958123618">Storage capacity. The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4096 GB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row778255710362"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1847958133610">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p84765816368">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p12471258193610">Supported storage types. For details about the differences between the storage types, see"Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002233726950__i1847165853617">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul1547195813362"><li id="EN-US_TOPIC_0000002233726950__li1547195883611"><p id="EN-US_TOPIC_0000002233726950__p3473583361"><a name="EN-US_TOPIC_0000002233726950__li1547195883611"></a><a name="li1547195883611"></a><strong id="EN-US_TOPIC_0000002233726950__b10475589364">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002233726950__li194718587369"><p id="EN-US_TOPIC_0000002233726950__p7471258173615"><a name="EN-US_TOPIC_0000002233726950__li194718587369"></a><a name="li194718587369"></a><strong id="EN-US_TOPIC_0000002233726950__b174765818360">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row878217574369"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p11471858183611">mount_path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1547135863611">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p14735816364">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002233726950__b144785813364">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row177821657133620"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p2479583369">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p7471558183617">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1347145863618">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726950__ul847105873614"><li id="EN-US_TOPIC_0000002233726950__li184795811364"><p id="EN-US_TOPIC_0000002233726950__p1447558123616"><a name="EN-US_TOPIC_0000002233726950__li184795811364"></a><a name="li184795811364"></a><strong id="EN-US_TOPIC_0000002233726950__b147135816369">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002233726950__li1647858103611"><p id="EN-US_TOPIC_0000002233726950__p1647558143618"><a name="EN-US_TOPIC_0000002233726950__li1647858103611"></a><a name="li1647858103611"></a><strong id="EN-US_TOPIC_0000002233726950__b184716580363">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002233726950__b144725819368">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1478220578367"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p647125819362">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p747135883618">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p44755814362">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002233726950__b447145814360">RESIZING</strong> during capacity expansion and does not affect the instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_user"></a><a name="en-us_topic_0000002091201333_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_user" frame="border" border="1" rules="all"><caption><b>Table 10 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row11785195717369"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p6473580369">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p5471958163617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.10.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p84815818360">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row17785145720366"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p14855843619">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p104811584362"><a href="#EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_domain">domain</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1148145883618">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1378535753610"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p104817582360">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p748165818369">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p648658183611">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row17785257113616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p94875873617">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p10481858163611">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p948105811369">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_domain"></a><a name="en-us_topic_0000002091201333_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_response_domain" frame="border" border="1" rules="all"><caption><b>Table 11 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row137883574365"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002233726950__p548558103612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.2"><p id="EN-US_TOPIC_0000002233726950__p1648115873611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.11.2.4.1.3"><p id="EN-US_TOPIC_0000002233726950__p1248125818366">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row978825773612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p348205843611">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p134820582367">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p1748558173613">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row1378885712361"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726950__p14483585362">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726950__p94875843610">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726950__p648115817361">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726950__section134818581364"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002233726950__screen20483586366">{ }</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726950__section144815586360"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002233726950__p848135810367"><strong id="EN-US_TOPIC_0000002233726950__b1448175813613">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002233726950__p2492585366">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002233726950__screen1549185823615">{
"description" : "api-test",
"feature" : "NOTEBOOK",
"flavor" : "modelarts.vm.cpu.2u",
"id" : "f9937afa-4451-42db-a76b-72d624749f66",
"image" : {
"description" : "description",
"id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name" : "notebook2.0-mul-kernel-cpu-cp36",
"swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
"tag" : "3.3.2-release_v1",
"type" : "BUILD_IN"
},
"lease" : {
"create_at" : 1638841744515,
"duration" : 6327212,
"enable" : true,
"type" : "TIMING",
"update_at" : 1638844471727
},
"name" : "notebooks_test",
"status" : "STARTING",
"token" : "5cc60e8b-8772-7690-efd6-a5874ca387c0",
"url" : "https://authoring-modelarts-xxxxx.xxxxx.com/f9937afa-4451-42db-a76b-72d624749f66/lab",
"volume" : {
"category" : "EFS",
"ownership" : "MANAGED",
"mount_path" : "/home/ma-user/work/",
"capacity" : 50
},
"workspace_id" : "0"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726950__section15490588363"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726950__en-us_topic_0000002091201333_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002233726950__row16792957193611"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002233726950__p8497589368">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="EN-US_TOPIC_0000002233726950__p124920586365">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726950__row6792857163615"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726950__p144975883613">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726950__p84915815364">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row13792175763610"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726950__p349175810361">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726950__p174920589364">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row8792157123614"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726950__p54919583361">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726950__p54925817369">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row10792195712362"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726950__p94995873611">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726950__p1249558103620">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726950__row137926572361"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726950__p1495581366">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726950__p114920586362">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726950__section249155816360"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002233726950__p10491058103614">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="notebook.html">Development Environment Management</a></div>
</div>
</div>
View Git Blame Copy Permalink