yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
78d5ebfce83bc710b05fb0adb3f7afc83565640f
doc-exports/docs/modelarts/api-ref/StartNotebook.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

799 lines
96 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002374896609"></a><a name="EN-US_TOPIC_0000002374896609"></a>
<h1 class="topictitle1">Starting a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section0686172594016"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p9687152584016">This API is used to start a notebook instance.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section96871025134019"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p06887253403">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section668919252406"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p76901725204013">POST /v1/{project_id}/notebooks/{id}/start</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_table469114254409" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row20691525164013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p15692112510405">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_0000002374896609__en-us_topic_0000002091201333_p969211253408">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_0000002374896609__en-us_topic_0000002091201333_p1269320258407">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_0000002374896609__en-us_topic_0000002091201333_p166932254404">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row86913252408"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16694192504012">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p106957256406">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p5695182534020">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p969617257404">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_0000002374896609__en-us_topic_0000002091201333_row3691142515406"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p969622574018">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_0000002374896609__en-us_topic_0000002091201333_p269732574015">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p669702517402">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p3698172544015">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_table1969962534013" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row18698122524016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p10700425174013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1670042564014">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1170112251404">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p13701102574011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row14699182534018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1370215252401">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p15702425194015">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p870317254405">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16703112520405">Running duration after startup, in milliseconds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1969932516401"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p207041725114012">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p970412512409">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p8705132512402">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p10705142511408">Automatic stop type. The default value is timing.</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul8706125124015"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li187061257408"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1070692513404"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li187061257408"></a><a name="en-us_topic_0000002091201333_li187061257408"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li0706225114010"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p137068250403"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li0706225114010"></a><a name="en-us_topic_0000002091201333_li0706225114010"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section8707202515407"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p9707325144020">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section57091325184015"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p77091125194016"><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b2709122517407">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row77101025174014"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p971242564019">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_0000002374896609__en-us_topic_0000002091201333_p1671310259408">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_0000002374896609__en-us_topic_0000002091201333_p8714152511402">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row157103256401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16714132515406">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_0000002374896609__en-us_topic_0000002091201333_p971552514012">Array of <a href="#EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_JobProgress">JobProgress</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p20715825184020">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row971062574010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p10716102564011">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p137176252406">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p10717825124015">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row2071072517406"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p771862513406">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p167183258409">Array of <a href="#EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_EndpointsRes">EndpointsRes</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1471902594012">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_0000002374896609__en-us_topic_0000002091201333_row157101925124011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1571902554018">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_0000002374896609__en-us_topic_0000002091201333_p87203255400">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p19720132510409">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1971012252408"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p177211125174019">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p8721525154010">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p137226256408">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1771032564015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p972217256401">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p4723112524012">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p117231725114012">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1871192564018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p672419257401">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p172432534014"><a href="#EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_Image">Image</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p7725192510404">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row17711725184018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2072552510408">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p57261625164016"><a href="#EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_Lease">Lease</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p172792515408">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1371119251407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1472772544014">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p97281025134012">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1272852544016">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1571120252408"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p11729112516406">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p572942516407"><a href="#EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_Pool">Pool</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1173082554013">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_0000002374896609__en-us_topic_0000002091201333_row97115259408"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p173017254408">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p973102512405">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p173262564010">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul97330257400"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1733025114011"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p127331625194015"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1733025114011"></a><a name="en-us_topic_0000002091201333_li1733025114011"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b2734172524018">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li8734112515401"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p0734162534019"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li8734112515401"></a><a name="en-us_topic_0000002091201333_li8734112515401"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b107341725154013">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1073592510405"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p773522519403"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1073592510405"></a><a name="en-us_topic_0000002091201333_li1073592510405"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1673562564019">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1673552544011"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p12735025184019"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1673552544011"></a><a name="en-us_topic_0000002091201333_li1673552544011"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1673632574013">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li6736202514017"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p173610251402"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li6736202514017"></a><a name="en-us_topic_0000002091201333_li6736202514017"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b2736112516407">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1873642520402"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p4737825134019"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1873642520402"></a><a name="en-us_topic_0000002091201333_li1873642520402"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b273732510402">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li107371425164019"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p973742504010"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li107371425164019"></a><a name="en-us_topic_0000002091201333_li107371425164019"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b173812255402">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li14738152544017"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p157387255405"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li14738152544017"></a><a name="en-us_topic_0000002091201333_li14738152544017"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b973892519408">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li10738182514013"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p207391257404"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li10738182514013"></a><a name="en-us_topic_0000002091201333_li10738182514013"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b87396254407">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li12739525144013"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p37391125144019"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li12739525144013"></a><a name="en-us_topic_0000002091201333_li12739525144013"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1674012524020">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li197401725104010"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16740142564010"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li197401725104010"></a><a name="en-us_topic_0000002091201333_li197401725104010"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b574012253405">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li27406259401"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p9741112513407"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li27406259401"></a><a name="en-us_topic_0000002091201333_li27406259401"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1174192584012">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li12741202514408"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p07413258401"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li12741202514408"></a><a name="en-us_topic_0000002091201333_li12741202514408"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1574211254402">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li37428250406"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1174214254404"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li37428250406"></a><a name="en-us_topic_0000002091201333_li37428250406"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b167421825164014">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row17116255409"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1974322534013">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p17743825184010">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p17744925144013">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row10711025184012"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p7744122514012">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p774592554011">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p7745112524016">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row157112254408"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p117461025114013">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p187461125154012"><a href="#EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_VolumeRes">VolumeRes</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p117471425154016">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row4711122520400"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p187478251409">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_0000002374896609__en-us_topic_0000002091201333_p19748825174015">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2748132513406">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b19749202519408">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row871118250400"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p7749122564012">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p15750172512405">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p11750132524011">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul1475122512402"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1775162514012"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p15751182584016"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1775162514012"></a><a name="en-us_topic_0000002091201333_li1775162514012"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1975132515405">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li14751625104016"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p14752525174018"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li14751625104016"></a><a name="en-us_topic_0000002091201333_li14751625104016"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b11752122594012">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row87112258409"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p18752182544010">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_0000002374896609__en-us_topic_0000002091201333_p3753325104012">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_0000002374896609__en-us_topic_0000002091201333_p875382510406">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p0754122514019">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p18754102517408">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p197541250403">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row11711182512401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p12755182510403">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p475613253403"><a href="#EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_user">user</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p17756192564016">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_JobProgress"></a><a name="en-us_topic_0000002091201333_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 4 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row117571725154012"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1275892504017">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_0000002374896609__en-us_topic_0000002091201333_p20758172517409">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_0000002374896609__en-us_topic_0000002091201333_p1875942564013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row177570259402"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p11759142510401">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_0000002374896609__en-us_topic_0000002091201333_p20760172514019">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p7760625154019">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row14757152517407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p6761825144016">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p18762182514403">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p13763152584015">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul1876332512409"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li4763925144019"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p276362514016"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li4763925144019"></a><a name="en-us_topic_0000002091201333_li4763925144019"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b14764325184010">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li87647250404"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16764825174015"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li87647250404"></a><a name="en-us_topic_0000002091201333_li87647250404"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1764102510409">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li77651625184014"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p177651025134014"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li77651625184014"></a><a name="en-us_topic_0000002091201333_li77651625184014"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b87655252407">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li197652257408"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p276682519406"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li197652257408"></a><a name="en-us_topic_0000002091201333_li197652257408"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1766122514409">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1575782544019"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1376612534016">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1767102514404">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p57675256408">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul97681625164013"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li07681825114012"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p17768132513403"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li07681825114012"></a><a name="en-us_topic_0000002091201333_li07681825114012"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b197687255404">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li15769325164014"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p07691925134014"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li15769325164014"></a><a name="en-us_topic_0000002091201333_li15769325164014"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b117690255407">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li0769525144012"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1076916255407"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li0769525144012"></a><a name="en-us_topic_0000002091201333_li0769525144012"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b377002564010">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li12770125194018"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1977014258406"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li12770125194018"></a><a name="en-us_topic_0000002091201333_li12770125194018"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b17701325184015">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row9757162514020"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p177122544011">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_0000002374896609__en-us_topic_0000002091201333_p18771112514018">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p177721525174020">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_EndpointsRes"></a><a name="en-us_topic_0000002091201333_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 5 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row13773025174017"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1977452512406">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_0000002374896609__en-us_topic_0000002091201333_p1977512574019">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_0000002374896609__en-us_topic_0000002091201333_p15775182520404">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row977318259407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p8776162554018">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_0000002374896609__en-us_topic_0000002091201333_p167761225124013">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_0000002374896609__en-us_topic_0000002091201333_p13777162514015">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_0000002374896609__en-us_topic_0000002091201333_row20773182511405"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p277719259403">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_0000002374896609__en-us_topic_0000002091201333_p97788256406">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p177812252403">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul14779122564017"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li107791625194019"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1177911256408"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li107791625194019"></a><a name="en-us_topic_0000002091201333_li107791625194019"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b14779202513402">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li178062554018"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p14780172524019"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li178062554018"></a><a name="en-us_topic_0000002091201333_li178062554018"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b16780182515406">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row19773925164011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1478092564020">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_0000002374896609__en-us_topic_0000002091201333_p578162554016">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_0000002374896609__en-us_topic_0000002091201333_p678122524014">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_0000002374896609__en-us_topic_0000002091201333_row19773202520407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p4782102510408">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p3782425194012">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p10783182524019">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul87841825144015"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li57844258404"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2784132524012"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li57844258404"></a><a name="en-us_topic_0000002091201333_li57844258404"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b47849259409">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li4784202511404"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1978592504015"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li4784202511404"></a><a name="en-us_topic_0000002091201333_li4784202511404"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b5785202510405">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1777332514015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p107850253406">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p3786122564012">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p15786102515404">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_Image"></a><a name="en-us_topic_0000002091201333_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_Image" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row167873251409"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p97891625204019">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_0000002374896609__en-us_topic_0000002091201333_p1279082504018">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_0000002374896609__en-us_topic_0000002091201333_p179042514406">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row4787925164011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p0791192534011">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p11791192574016">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p13792102512404">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul167921225164010"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li47931253403"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1579352574015"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li47931253403"></a><a name="en-us_topic_0000002091201333_li47931253403"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b279317258402">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li279302516402"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p11794142516403"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li279302516402"></a><a name="en-us_topic_0000002091201333_li279302516402"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b11794225124013">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row57877259408"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p18794825114016">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_0000002374896609__en-us_topic_0000002091201333_p9795172520404">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p197961925174018">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row17787525154018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p879672554015">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p37971625134010">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2079713254408">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row378715254409"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p979818259405">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_0000002374896609__en-us_topic_0000002091201333_p1798625174012">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_0000002374896609__en-us_topic_0000002091201333_p14799102594011">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul380022520409"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1800162594014"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1980012534011"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1800162594014"></a><a name="en-us_topic_0000002091201333_li1800162594014"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b48011325144014">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li28011025144011"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p168019257405"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li28011025144011"></a><a name="en-us_topic_0000002091201333_li28011025144011"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b10802122510402">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_0000002374896609__en-us_topic_0000002091201333_row078719251405"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p9802325154019">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p158031525104013">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1980432518407">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_0000002374896609__en-us_topic_0000002091201333_row117871925134019"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p28051125204017">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p4806152511405">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p168067259407">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_0000002374896609__en-us_topic_0000002091201333_row1478742520405"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p128071125194013">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1807172584014">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16808625104010">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b118101125124019">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1778716255401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p4326626154016">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p3326172614403">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p8327192634018">Image source, which defaults to <strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b232792618408">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul11327526124012"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li93271226194016"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16327192617401"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li93271226194016"></a><a name="en-us_topic_0000002091201333_li93271226194016"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b7327122664018">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1132716263406"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p232712674013"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1132716263406"></a><a name="en-us_topic_0000002091201333_li1132716263406"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b5327526164019">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row77878253406"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p232712684014">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_0000002374896609__en-us_topic_0000002091201333_p10328626104016">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_0000002374896609__en-us_topic_0000002091201333_p73281026164018">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul18328122613400"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li193281926114015"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16328192674011"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li193281926114015"></a><a name="en-us_topic_0000002091201333_li193281926114015"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b132819262408">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li732802616404"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1132872612408"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li732802616404"></a><a name="en-us_topic_0000002091201333_li732802616404"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1532820266400">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1378810251403"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1632822614018">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_0000002374896609__en-us_topic_0000002091201333_p7329102618404">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1732922610402">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul6329172613404"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li17329122614018"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p6329162644016"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li17329122614018"></a><a name="en-us_topic_0000002091201333_li17329122614018"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b15329182624018">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li13291526114016"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p632910267402"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li13291526114016"></a><a name="en-us_topic_0000002091201333_li13291526114016"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b19329132664020">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li232915263402"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p203294263409"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li232915263402"></a><a name="en-us_topic_0000002091201333_li232915263402"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li93308266400"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p63301526184011"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li93308266400"></a><a name="en-us_topic_0000002091201333_li93308266400"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li633072694013"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p143305268409"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li633072694013"></a><a name="en-us_topic_0000002091201333_li633072694013"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row187887255407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p9330162674016">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p18330102612407">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2331326124012">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row197881725184013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1233114268409">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p113319268402">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p63312261406">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul6331112664010"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li18331626184018"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p333152684018"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li18331626184018"></a><a name="en-us_topic_0000002091201333_li18331626184018"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b433119265408">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li133272611404"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p63321726144012"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li133272611404"></a><a name="en-us_topic_0000002091201333_li133272611404"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b193321126154019">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li533292664016"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p6332626184012"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li533292664016"></a><a name="en-us_topic_0000002091201333_li533292664016"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1633212267405">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1933232611409"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p12332626184016"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1933232611409"></a><a name="en-us_topic_0000002091201333_li1933232611409"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b12332132644015">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li23321126114014"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p153320269403"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li23321126114014"></a><a name="en-us_topic_0000002091201333_li23321126114014"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b17332926174011">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li143321326124012"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p6332152684015"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li143321326124012"></a><a name="en-us_topic_0000002091201333_li143321326124012"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b633282664018">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_0000002374896609__en-us_topic_0000002091201333_row12788182584010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p19333226204011">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_0000002374896609__en-us_topic_0000002091201333_p17333192674010">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p133337268403">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1578862564018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p433322611406">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_0000002374896609__en-us_topic_0000002091201333_p12333152612400">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_0000002374896609__en-us_topic_0000002091201333_p15333102614403">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul9334182618402"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1933402611402"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p19334182614401"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li1933402611402"></a><a name="en-us_topic_0000002091201333_li1933402611402"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b19334102674015">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li17334112617403"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p6334826174011"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li17334112617403"></a><a name="en-us_topic_0000002091201333_li17334112617403"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b73341426194013">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row278872594010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p13334142694016">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_0000002374896609__en-us_topic_0000002091201333_p633452674010">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p19334112674018">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row57881525134018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p73351426134017">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p15335202619403">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p33351026144015">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row57882257403"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p20335152664018">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p7335182614403">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p18335192634010">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul12335112616406"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li43361626114014"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1233692611404"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li43361626114014"></a><a name="en-us_topic_0000002091201333_li43361626114014"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1333612619405">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li18336726194019"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p533612263407"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li18336726194019"></a><a name="en-us_topic_0000002091201333_li18336726194019"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b11336112604012">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row157888253404"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p633652654010">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_0000002374896609__en-us_topic_0000002091201333_p16336626124020">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1336122620406">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row17788152513401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p133692617405">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p6337192616402">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1633782684017">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul63371326174015"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li113376265400"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2033718267400"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li113376265400"></a><a name="en-us_topic_0000002091201333_li113376265400"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b233732644011">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li10337132614406"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p14337102684019"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li10337132614406"></a><a name="en-us_topic_0000002091201333_li10337132614406"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1533718262405">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row878842512404"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p73376261401">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_0000002374896609__en-us_topic_0000002091201333_p193381026184015">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p033802664010">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b13382026144019">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_Lease"></a><a name="en-us_topic_0000002091201333_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row19838132574012"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p13339112610401">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_0000002374896609__en-us_topic_0000002091201333_p203401326124010">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_0000002374896609__en-us_topic_0000002091201333_p13340162654016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1583816252401"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p434019269405">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_0000002374896609__en-us_topic_0000002091201333_p8340182612406">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16340152611406">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row8838152524011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p9340126154010">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p7341132604016">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1034111267409">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_0000002374896609__en-us_topic_0000002091201333_row7838172574013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1341826174013">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p034114260401">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p73411326134017">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1383892554011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1834110268401">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1034222664012">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p17342182614013">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul143421426164014"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li234262616408"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p8342102694015"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li234262616408"></a><a name="en-us_topic_0000002091201333_li234262616408"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li934217266405"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1034211265400"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li934217266405"></a><a name="en-us_topic_0000002091201333_li934217266405"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row28381325174016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2342426144013">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_0000002374896609__en-us_topic_0000002091201333_p4343152611408">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p9343122694019">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_0000002374896609__en-us_topic_0000002091201333_response_Pool"></a><a name="en-us_topic_0000002091201333_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row19846125114019"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p834352615404">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_0000002374896609__en-us_topic_0000002091201333_p934352620403">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_0000002374896609__en-us_topic_0000002091201333_p3343162684018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row7846192518403"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2344326204017">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p153441926184013">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p14344226114017">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row158461259407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p113444268403">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p163441626154010">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1534422619408">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_VolumeRes"></a><a name="en-us_topic_0000002091201333_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 9 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row384912518404"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p43451826114015">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_0000002374896609__en-us_topic_0000002091201333_p1134522614011">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_0000002374896609__en-us_topic_0000002091201333_p1634532644011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row3849125194016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p18345152612404">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p4345132674010">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p13461826144016">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_0000002374896609__en-us_topic_0000002091201333_row17850225134012"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p12346626194011">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p17346182694020">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p133465261406">Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_i1734682644012">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul634622684015"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li16346152612407"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p13461326184015"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li16346152612407"></a><a name="en-us_topic_0000002091201333_li16346152612407"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b113471426164013">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li9347162611401"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1734720265405"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li9347162611401"></a><a name="en-us_topic_0000002091201333_li9347162611401"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b153474269407">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row8850132519409"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p4347926164011">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_0000002374896609__en-us_topic_0000002091201333_p20347192610406">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p434716262403">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b134714263404">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row485018251407"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p834718261408">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p93482026184015">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p6348926144017">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_ul20348142654020"><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li12348142612406"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1434862654014"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li12348142612406"></a><a name="en-us_topic_0000002091201333_li12348142612406"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b193481626174019">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li103481226144018"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p434872618405"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_li103481226144018"></a><a name="en-us_topic_0000002091201333_li103481226144018"></a><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b11348172610400">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b18348162634012">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1785072511408"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2348142654010">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p13490262405">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p14349726144015">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b173495268407">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_0000002374896609__en-us_topic_0000002091201333_response_user"></a><a name="en-us_topic_0000002091201333_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_user" frame="border" border="1" rules="all"><caption><b>Table 10 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row785922510407"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p33493263403">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_0000002374896609__en-us_topic_0000002091201333_p534982618404">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_0000002374896609__en-us_topic_0000002091201333_p8350162611404">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row178609253409"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1235042664011">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p17350182614404"><a href="#EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_domain">domain</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1835082613409">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1886012544011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16350102612401">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p11350162612402">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p0351172614405">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row198606259402"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1035132694019">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p5351122634016">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p20351526184019">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_domain"></a><a name="en-us_topic_0000002091201333_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_response_domain" frame="border" border="1" rules="all"><caption><b>Table 11 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row286411255406"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p8351112619409">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_0000002374896609__en-us_topic_0000002091201333_p0352202624013">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_0000002374896609__en-us_topic_0000002091201333_p1352132614409">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row198642025194015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p19352626114010">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p2035272684019">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p12352122617407">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row148641325104015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p17352142614010">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p11353132614406">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p16353726124011">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section43532266407"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_screen035372664013">{ }</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section18353202611403"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p11354152684016"><strong id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_b1335472624013">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p935412617402">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_screen1235415264405">{
"description" : "api-test",
"feature" : "NOTEBOOK",
"flavor" : "modelarts.vm.cpu.2u",
"id" : "f9937afa-4451-42db-a76b-72d624749f66",
"image" : {
"description" : "description",
"id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name" : "notebook2.0-mul-kernel-cpu-cp36",
"swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
"tag" : "3.3.2-release_v1",
"type" : "BUILD_IN"
},
"lease" : {
"create_at" : 1638841744515,
"duration" : 6327212,
"enable" : true,
"type" : "TIMING",
"update_at" : 1638844471727
},
"name" : "notebooks_test",
"status" : "STARTING",
"token" : "5cc60e8b-8772-7690-efd6-a5874ca387c0",
"url" : "https://authoring-modelarts-xxxxx.xxxxx.com/f9937afa-4451-42db-a76b-72d624749f66/lab",
"volume" : {
"category" : "EFS",
"ownership" : "MANAGED",
"mount_path" : "/home/ma-user/work/",
"capacity" : 50
},
"workspace_id" : "0"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section0360026194012"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row5879152515405"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p143601265400">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_0000002374896609__en-us_topic_0000002091201333_p16361122616400">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1887912516407"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p193611826124017">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1436116261407">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row13879325164018"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p1361152617408">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p103611926104015">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row0879152524016"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p4361162684018">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p113621626184013">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row12879122584018"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p23622262409">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p136217261404">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_row1987942511402"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p143621226114017">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p183624264404">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_section636242654014"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002374896609__en-us_topic_0000002091201333_p9363132616403">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