yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
26dfc1fff2dd6735fb9ace16a3a59edecfd9873c
doc-exports/docs/modelarts/api-ref/StopNotebook.html
Wuwan, Qi 78d5ebfce8 ModelArts API 25.3.0 20250710 
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-07-28 12:24:54 +00:00

763 lines
92 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002374896581"></a><a name="EN-US_TOPIC_0000002374896581"></a>
<h1 class="topictitle1">Stopping a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_section17928202564017"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p19282254408">This API is used to stop a notebook instance.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_section209294251405"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p59295259407">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_section149311725104015"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p79321325184017">POST /v1/{project_id}/notebooks/{id}/stop</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_table19332254406" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row793215259407"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1493352574012">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_0000002374896581__en-us_topic_0000002055322414_p4934192519400">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_0000002374896581__en-us_topic_0000002055322414_p14935142564010">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_0000002374896581__en-us_topic_0000002055322414_p1493532513401">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row8932325114018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p393618253401">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p39367257406">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p14937525134017">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p17937925144010">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_0000002374896581__en-us_topic_0000002055322414_row109325256402"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p7938122512401">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_0000002374896581__en-us_topic_0000002055322414_p18938202514403">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p79390250402">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p18940125164013">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>
<div class="section" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_section29401252409"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p149411525144017">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_section1894282517405"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p694372534011"><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1094315255404">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row294414255404"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p20946202511404">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_0000002374896581__en-us_topic_0000002055322414_p6946925194018">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_0000002374896581__en-us_topic_0000002055322414_p1947725124012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row894410252404"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p18947172513409">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_0000002374896581__en-us_topic_0000002055322414_p394892515409">Array of <a href="#EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_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_0000002374896581__en-us_topic_0000002055322414_p10949122554012">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row5944122515404"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p13950225144019">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p15950182594014">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p14951325194019">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row294482504017"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p195113259403">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p20952142544018">Array of <a href="#EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_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_0000002374896581__en-us_topic_0000002055322414_p295222584012">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_0000002374896581__en-us_topic_0000002055322414_row1194420253400"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p995315253401">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_0000002374896581__en-us_topic_0000002055322414_p59533258408">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p195420254405">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row139441725204010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p8954152518405">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1195518258401">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p169552025164020">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row10944162504018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1695642524015">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1095614257404">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p99578251405">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row199441255403"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p69572025144013">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p495882510408"><a href="#EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_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_0000002374896581__en-us_topic_0000002055322414_p1995932564017">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row15944152594020"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p14959162584012">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p99601425114015"><a href="#EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_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_0000002374896581__en-us_topic_0000002055322414_p19960202514402">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row15944142584015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p5961142516408">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p11961625124013">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p89626259406">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row2944172520405"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1962192554012">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p18963162510402"><a href="#EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_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_0000002374896581__en-us_topic_0000002055322414_p10963122564019">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_0000002374896581__en-us_topic_0000002055322414_row1694472515401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p17964152574017">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1396542584018">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1596572544019">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul10967182544012"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li79671625104011"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p199671725164016"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li79671625104011"></a><a name="en-us_topic_0000002055322414_li79671625104011"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b17967142516408">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li8967152517405"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p296822524016"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li8967152517405"></a><a name="en-us_topic_0000002055322414_li8967152517405"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b996810254407">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li49687251401"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1396814256406"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li49687251401"></a><a name="en-us_topic_0000002055322414_li49687251401"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b12969425144020">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1496982514017"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p0969102564014"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1496982514017"></a><a name="en-us_topic_0000002055322414_li1496982514017"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1396912544010">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li99695254407"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p12970725114014"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li99695254407"></a><a name="en-us_topic_0000002055322414_li99695254407"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1197018259408">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1970102554012"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p797032594014"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1970102554012"></a><a name="en-us_topic_0000002055322414_li1970102554012"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b8971182544017">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li119711025134017"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p189711254401"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li119711025134017"></a><a name="en-us_topic_0000002055322414_li119711025134017"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1497115256405">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li99714250404"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p8972142513404"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li99714250404"></a><a name="en-us_topic_0000002055322414_li99714250404"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b2972825194017">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li7972625124019"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p9972725114014"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li7972625124019"></a><a name="en-us_topic_0000002055322414_li7972625124019"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1197312544015">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li997382514017"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p149737250403"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li997382514017"></a><a name="en-us_topic_0000002055322414_li997382514017"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b297372584018">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1097313254409"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p597412251403"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1097313254409"></a><a name="en-us_topic_0000002055322414_li1097313254409"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b16974122520405">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1097482517408"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p4974112524013"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1097482517408"></a><a name="en-us_topic_0000002055322414_li1097482517408"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b897582584015">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1197532564010"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p897516254403"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1197532564010"></a><a name="en-us_topic_0000002055322414_li1197532564010"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b9975192511402">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5975142513406"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p169761525124017"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5975142513406"></a><a name="en-us_topic_0000002055322414_li5975142513406"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1797672510403">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row109441725104014"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p189761225134018">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p8977152524011">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p16977152512409">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row189441725124015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p5978122554012">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p49781825104012">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p3979102574019">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row5944122515403"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p597902518408">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1698172584011"><a href="#EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_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_0000002374896581__en-us_topic_0000002055322414_p59811258407">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row4944132554015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p6982825154018">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_0000002374896581__en-us_topic_0000002055322414_p998232516400">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p29838255406">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b14983125144017">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1994513252408"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p29841925194010">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p7984125154017">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p14985142511406">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul12985825114010"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li15985925144014"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p139868252404"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li15985925144014"></a><a name="en-us_topic_0000002055322414_li15985925144014"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b179869251408">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li129866257401"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1598617250409"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li129866257401"></a><a name="en-us_topic_0000002055322414_li129866257401"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b598642534019">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row99452257409"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1298752510403">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_0000002374896581__en-us_topic_0000002055322414_p1598722514014">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_0000002374896581__en-us_topic_0000002055322414_p11988825114012">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p12988925134017">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p9989162512405">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p198914259407">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row594522544015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p89907251402">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1099012524013"><a href="#EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_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_0000002374896581__en-us_topic_0000002055322414_p14991125144013">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_JobProgress"></a><a name="en-us_topic_0000002055322414_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 3 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row599192534013"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p099382504012">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_0000002374896581__en-us_topic_0000002055322414_p999372564012">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_0000002374896581__en-us_topic_0000002055322414_p09941525194013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row599172516400"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p6994182564019">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_0000002374896581__en-us_topic_0000002055322414_p12995725154015">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p69959251403">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1899122517404"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1299612564020">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1899622513408">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p099717253403">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul8997132516404"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1499820251408"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1299813251408"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1499820251408"></a><a name="en-us_topic_0000002055322414_li1499820251408"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b13998142514014">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5998122518408"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p89985253409"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5998122518408"></a><a name="en-us_topic_0000002055322414_li5998122518408"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1799962514409">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1599915253409"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p89992251405"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1599915253409"></a><a name="en-us_topic_0000002055322414_li1599915253409"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1099913256405">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li10010266405"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p18017263407"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li10010266405"></a><a name="en-us_topic_0000002055322414_li10010266405"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b70326184018">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row149921625114019"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1901826184012">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1142611405">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1711226194010">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul132122613406"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li122226164018"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p52162618401"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li122226164018"></a><a name="en-us_topic_0000002055322414_li122226164018"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b2313262402">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li6362614015"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p17372654011"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li6362614015"></a><a name="en-us_topic_0000002055322414_li6362614015"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b7392620403">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li9318265401"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p12452614018"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li9318265401"></a><a name="en-us_topic_0000002055322414_li9318265401"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b44162611401">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li2041526124011"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p174102644011"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li2041526124011"></a><a name="en-us_topic_0000002055322414_li2041526124011"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b10513267402">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1499211257406"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p20520262407">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_0000002374896581__en-us_topic_0000002055322414_p135152674019">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p46226204020">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_EndpointsRes"></a><a name="en-us_topic_0000002055322414_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 4 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row96172617403"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p38926144013">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_0000002374896581__en-us_topic_0000002055322414_p0810262405">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_0000002374896581__en-us_topic_0000002055322414_p8982619409">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1168260402"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p091826104018">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_0000002374896581__en-us_topic_0000002055322414_p16101426184011">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_0000002374896581__en-us_topic_0000002055322414_p121052612409">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_0000002374896581__en-us_topic_0000002055322414_row117102618403"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p5112265407">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_0000002374896581__en-us_topic_0000002055322414_p131112674017">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p12122026114015">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul312202617400"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li313112674014"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p213142619409"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li313112674014"></a><a name="en-us_topic_0000002055322414_li313112674014"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b131392611402">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li513142664013"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p14131126184010"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li513142664013"></a><a name="en-us_topic_0000002055322414_li513142664013"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b6143266404">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row15720264401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p4145261409">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_0000002374896581__en-us_topic_0000002055322414_p1915626174016">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_0000002374896581__en-us_topic_0000002055322414_p16153262408">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_0000002374896581__en-us_topic_0000002055322414_row97142617408"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p191542634010">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p616926114017">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p217112614409">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul21713266409"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li117172617403"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p117326104019"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li117172617403"></a><a name="en-us_topic_0000002055322414_li117172617403"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b141872664013">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li12187268401"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p318162614404"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li12187268401"></a><a name="en-us_topic_0000002055322414_li12187268401"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1818122618400">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row207192616404"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p119132610407">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p4198266404">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p13201926174010">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_Image"></a><a name="en-us_topic_0000002055322414_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_Image" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row14209262406"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p62282664018">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_0000002374896581__en-us_topic_0000002055322414_p192352674018">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_0000002374896581__en-us_topic_0000002055322414_p14241026144016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row721142613407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p13242266406">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p202519263406">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p172592616403">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul0260261405"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li112612694016"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1526162616408"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li112612694016"></a><a name="en-us_topic_0000002055322414_li112612694016"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b182617268408">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li927326184019"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p15271326144013"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li927326184019"></a><a name="en-us_topic_0000002055322414_li927326184019"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b2027112610403">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row321112619400"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p827172664013">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_0000002374896581__en-us_topic_0000002055322414_p17281326124015">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p19291926144013">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row3211626174010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p629326194018">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p173062619403">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p330172634015">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row621192694013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p431926154016">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_0000002374896581__en-us_topic_0000002055322414_p1831126184015">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_0000002374896581__en-us_topic_0000002055322414_p183252615408">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul23292634011"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1032172618409"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1033142624015"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1032172618409"></a><a name="en-us_topic_0000002055322414_li1032172618409"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b233172613400">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li10330264409"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1733426134012"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li10330264409"></a><a name="en-us_topic_0000002055322414_li10330264409"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b234526144014">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_0000002374896581__en-us_topic_0000002055322414_row122112267404"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p18344268404">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p135926164011">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p15355269407">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_0000002374896581__en-us_topic_0000002055322414_row821226134014"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p133617260402">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p736102684010">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p33612624018">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_0000002374896581__en-us_topic_0000002055322414_row152112654020"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p9371726114012">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p123752618409">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p73862634018">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1238182611404">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row12110268405"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1939126144018">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p4391226194016">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p7401526114012">Image source, which defaults to <strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b440726154018">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul54122619409"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li941202616405"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p74102614010"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li941202616405"></a><a name="en-us_topic_0000002055322414_li941202616405"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1641182616407">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li6411626134015"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p2421026144015"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li6411626134015"></a><a name="en-us_topic_0000002055322414_li6411626134015"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b2428262408">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row162111260400"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p4421426174010">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_0000002374896581__en-us_topic_0000002055322414_p104342619408">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_0000002374896581__en-us_topic_0000002055322414_p743132624011">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul244192664019"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li844192684016"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p744192644019"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li844192684016"></a><a name="en-us_topic_0000002055322414_li844192684016"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b244826194012">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5457269402"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1845172644011"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5457269402"></a><a name="en-us_topic_0000002055322414_li5457269402"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b7451726184011">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row62115265402"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p34562644020">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_0000002374896581__en-us_topic_0000002055322414_p64642674017">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p154662618401">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul1471266401"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li19478265402"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p204772612403"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li19478265402"></a><a name="en-us_topic_0000002055322414_li19478265402"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1048112624012">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li248102613403"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p948152611402"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li248102613403"></a><a name="en-us_topic_0000002055322414_li248102613403"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b16481826184014">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li848152694011"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1549142614019"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li848152694011"></a><a name="en-us_topic_0000002055322414_li848152694011"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5364926124019"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p11364202611405"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5364926124019"></a><a name="en-us_topic_0000002055322414_li5364926124019"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li15364172610401"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1836415269409"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li15364172610401"></a><a name="en-us_topic_0000002055322414_li15364172610401"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row9211626184010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p436517266404">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p836516261406">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p6365926194014">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1421142616401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p636511265407">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p20365192619402">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p43651026154013">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul1336662619407"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1736672604013"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p33661426154014"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1736672604013"></a><a name="en-us_topic_0000002055322414_li1736672604013"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b10366026174013">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5366192684018"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p63666262403"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li5366192684018"></a><a name="en-us_topic_0000002055322414_li5366192684018"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b636618266401">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li436692634013"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p23662266401"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li436692634013"></a><a name="en-us_topic_0000002055322414_li436692634013"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b7366142654010">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li436612620401"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p6366192619404"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li436612620401"></a><a name="en-us_topic_0000002055322414_li436612620401"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b7366192619406">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li10366326144019"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p17366726134012"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li10366326144019"></a><a name="en-us_topic_0000002055322414_li10366326144019"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b13674263404">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li183671264405"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p436714267406"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li183671264405"></a><a name="en-us_topic_0000002055322414_li183671264405"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b193673268405">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_0000002374896581__en-us_topic_0000002055322414_row421132616406"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p19367426174016">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_0000002374896581__en-us_topic_0000002055322414_p17367826194016">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p193671726194016">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row152110268407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p83672026194019">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_0000002374896581__en-us_topic_0000002055322414_p836732634018">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_0000002374896581__en-us_topic_0000002055322414_p3368426174016">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul183681326134017"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li436862616406"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p143681526144013"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li436862616406"></a><a name="en-us_topic_0000002055322414_li436862616406"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b336832617402">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1336862610404"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p16368226114019"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1336862610404"></a><a name="en-us_topic_0000002055322414_li1336862610404"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b9368152644014">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row92120266407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1936842644016">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_0000002374896581__en-us_topic_0000002055322414_p123688269408">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p136952644019">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row18211826114013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1136942614407">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1336922604019">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p17369162674017">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1921162684013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p5369112618404">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p13369142684013">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p237015263408">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul6370102610406"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1237042615405"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p2370182664016"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1237042615405"></a><a name="en-us_topic_0000002055322414_li1237042615405"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b143702026134011">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1337092610404"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p13370526174019"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1337092610404"></a><a name="en-us_topic_0000002055322414_li1337092610404"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1437002617401">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1321122694020"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1437002614011">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_0000002374896581__en-us_topic_0000002055322414_p3371102664016">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p153711826194012">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row10211826134019"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p93711526194018">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p43711226154010">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1737117267404">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul33711926184010"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li4371202613403"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1371126194010"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li4371202613403"></a><a name="en-us_topic_0000002055322414_li4371202613403"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b43721226144012">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li16372926194019"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p18372102644013"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li16372926194019"></a><a name="en-us_topic_0000002055322414_li16372926194019"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b03721826184016">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1321142612406"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p16372142674014">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_0000002374896581__en-us_topic_0000002055322414_p143721026124011">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p103721026114010">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1137211265405">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_Lease"></a><a name="en-us_topic_0000002055322414_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row770192613407"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1937462619406">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_0000002374896581__en-us_topic_0000002055322414_p83747266404">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_0000002374896581__en-us_topic_0000002055322414_p143741826154016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row19704269409"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p337482644018">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_0000002374896581__en-us_topic_0000002055322414_p1637412265407">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p103751226154018">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row97022674013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p337552617409">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p13375126144018">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1037513268405">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_0000002374896581__en-us_topic_0000002055322414_row10701726154013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p63758264406">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1637552614403">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p2037517263402">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row67092694019"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p16376202612405">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1737610260400">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p637616267404">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul9376426154018"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li123761726184010"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p337613263409"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li123761726184010"></a><a name="en-us_topic_0000002055322414_li123761726184010"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1937632684011"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1637672617401"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1937632684011"></a><a name="en-us_topic_0000002055322414_li1937632684011"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row18704269407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p937712614404">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_0000002374896581__en-us_topic_0000002055322414_p16377526164014">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p93776263404">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_0000002374896581__en-us_topic_0000002055322414_response_Pool"></a><a name="en-us_topic_0000002055322414_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1478426144012"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1637792664011">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_0000002374896581__en-us_topic_0000002055322414_p1337818265405">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_0000002374896581__en-us_topic_0000002055322414_p337818267405">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row197910262400"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p237882611408">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p17378202664020">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p4378526194014">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row8791326114010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p237862654012">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1437832694017">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p03796261405">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_VolumeRes"></a><a name="en-us_topic_0000002055322414_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 8 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1583102624020"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p173798265408">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_0000002374896581__en-us_topic_0000002055322414_p13379142613403">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_0000002374896581__en-us_topic_0000002055322414_p33799268408">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row12832268406"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p18379172620402">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p93804265409">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p33801026174014">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_0000002374896581__en-us_topic_0000002055322414_row983102613404"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p8380326174015">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p4380192634016">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p16380162613401">Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_i53801269407">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul138002610404"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li13806262401"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p338112617406"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li13806262401"></a><a name="en-us_topic_0000002055322414_li13806262401"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b738192614019">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1538112684015"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p438112614012"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1538112684015"></a><a name="en-us_topic_0000002055322414_li1538112684015"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b0381122618406">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1583182604010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1338182664013">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_0000002374896581__en-us_topic_0000002055322414_p93811261402">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p3381182612409">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b3381202644010">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row78442616406"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p12381726114013">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1438282664020">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p17382132604014">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_ul53826264408"><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li73822026104018"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1338272674015"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li73822026104018"></a><a name="en-us_topic_0000002055322414_li73822026104018"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b1382926194013">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1738222624020"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p18382626134019"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_li1738222624020"></a><a name="en-us_topic_0000002055322414_li1738222624020"></a><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b103821026144015">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b838262694010">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row0843267400"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1438212615405">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1738262612404">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1538342610402">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b0383132612404">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_0000002374896581__en-us_topic_0000002055322414_response_user"></a><a name="en-us_topic_0000002055322414_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_user" frame="border" border="1" rules="all"><caption><b>Table 9 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1910216264402"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p8383172694017">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_0000002374896581__en-us_topic_0000002055322414_p1383426184014">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_0000002374896581__en-us_topic_0000002055322414_p438315267406">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row11102182604012"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p113830266408">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p9384126184019"><a href="#EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_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_0000002374896581__en-us_topic_0000002055322414_p8384192610409">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row111021826114018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p193841026104018">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p133841726114019">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p43847264403">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row151021726104019"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p4384172613401">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1538512263407">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p2385182684010">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_domain"></a><a name="en-us_topic_0000002055322414_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_response_domain" frame="border" border="1" rules="all"><caption><b>Table 10 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row19109726174012"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p23851026124018">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_0000002374896581__en-us_topic_0000002055322414_p4385526134017">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_0000002374896581__en-us_topic_0000002055322414_p1038572654011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row101091126124015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p53851526134019">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p8386202615404">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p1738612612409">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row21095266401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p193861326124014">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p73866262409">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p7387926144015">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_section113870260408"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_screen238717267406">POST https://{endpoint}/v1/{project_id}/notebooks/{id}/stop</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_section038772664019"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p15388162694015"><strong id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_b5388192674012">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p2388126124014">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_screen938822614404">{
"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" : 5313106,
"enable" : true,
"update_at" : 1638843457621
},
"name" : "notebooks_test",
"status" : "STOPPING",
"token" : "7bddd8ff-8a0d-e063-3107-c70a862832de",
"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_0000002374896581__en-us_topic_0000002055322414_section3393142694013"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row61231126124012"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p83935263403">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_0000002374896581__en-us_topic_0000002055322414_p33941926164017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row11231126194015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p139417267406">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p163941926174010">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row141231026124019"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p739482617404">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p11394182614400">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row61237262402"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p2394192610407">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p9395172614019">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row71233263401"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p20395142624014">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p143951726184015">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_row1912320266405"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p7395526184018">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p13395142620404">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_section143954266401"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002374896581__en-us_topic_0000002055322414_p83961426114019">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