vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/StartNotebook.html
Lai, Weijian 68e5cd0687 ModelArts API 23.3.0 Version. 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
2024-06-18 11:02:37 +00:00

724 lines
67 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001909847892"></a><a name="EN-US_TOPIC_0000001909847892"></a>
<h1 class="topictitle1">Starting a Notebook Instance</h1>
<div id="body0000001537833676"><div class="section" id="EN-US_TOPIC_0000001909847892__section9512121312919"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909847892__p051211131299">This API is used to start a notebook instance.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909847892__section151210131391"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000001909847892__p2513181312912">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909847892__section1513513598"><h4 class="sectiontitle">Debugging</h4><p id="EN-US_TOPIC_0000001909847892__p151301317913">You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909847892__section105131613994"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909847892__p13513151310914">POST /v1/{project_id}/notebooks/{id}/start</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__table451561319917" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row18514151311918"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000001909847892__p205151113697">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000001909847892__p451614135915">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000001909847892__p2516161310920">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000001909847892__p15167132915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row451481311912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909847892__p551610131892">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1751713131893">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909847892__p1151716132920">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909847892__p1051718131298">Notebook instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row8514191316913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001909847892__p95181613998">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1551871310920">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001909847892__p14518171312915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001909847892__p1451981313911">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_0000001909847892__table1452151319914" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row452091310916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000001909847892__p152115131393">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0000001909847892__p16522171310912">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0000001909847892__p19523113793">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0000001909847892__p55231713698">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row452061320911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1152317135914">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909847892__p252421316911">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909847892__p165241113296">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909847892__p1252411318910">Running duration after startup, in milliseconds</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row752071315915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001909847892__p145252131094">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001909847892__p65259136918">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001909847892__p7526191317913">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001909847892__p135264131391">Automatic stop type. The default value is timing.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909847892__section15263131993"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__request_NotebookStartRequest" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row145276131291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909847892__p25288131094">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909847892__p16529613094">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909847892__p10529413392">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.5.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909847892__p75301313897">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row652718131693"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909847892__p3530131316916">-</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1253015131917">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909847892__p953131318912">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.5.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909847892__p1553119138919">notebookStartRequest</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909847892__section85310130916"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000001909847892__p053212136912"><strong id="EN-US_TOPIC_0000001909847892__b175321913897">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row105332134916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.3.2.4.1.1"><p id="EN-US_TOPIC_0000001909847892__p05367134915">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.3.2.4.1.2"><p id="EN-US_TOPIC_0000001909847892__p12536713796">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.3.2.4.1.3"><p id="EN-US_TOPIC_0000001909847892__p85369134918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row453320131916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p353615131918">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1153714134912">Array of <a href="#EN-US_TOPIC_0000001909847892__response_JobProgress">JobProgress</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p75371413691">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1553316131692"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1753721311915">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p6537213190">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p145381131492">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row195336131899"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p15538413495">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p19538111319917">Array of <a href="#EN-US_TOPIC_0000001909847892__response_EndpointsRes">EndpointsRes</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p953961316914">Local IDE (such as PyCharm and vsCode) or SSH client for remotely accessing a notebook instance through SSH.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row65339132091"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1453991312918">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p55399131918">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p254014135914">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row145333133913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1854018134919">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p75403131797">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p185411132091">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row185344131091"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1654110136915">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p3542613996">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p105422131699">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1653412131795"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p15542413893">image</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p115434131695"><a href="#EN-US_TOPIC_0000001909847892__response_Image">Image</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p4543181316918">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1853441311911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1554311315914">lease</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p13544013891"><a href="#EN-US_TOPIC_0000001909847892__response_Lease">Lease</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p135447137910">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row153418132919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1254510131096">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p115452013891">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p4545151310910">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row155342131398"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p155451131293">pool</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p95466137919"><a href="#EN-US_TOPIC_0000001909847892__response_Pool">Pool</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p15461413897">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_0000001909847892__row1353417131994"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p11546121310919">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p85471313292">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p754715131795">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul55474131915"><li id="EN-US_TOPIC_0000001909847892__li1554741312914"><p id="EN-US_TOPIC_0000001909847892__p1754717133911"><a name="EN-US_TOPIC_0000001909847892__li1554741312914"></a><a name="li1554741312914"></a><strong id="EN-US_TOPIC_0000001909847892__b165487131299">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li554810134916"><p id="EN-US_TOPIC_0000001909847892__p185481131495"><a name="EN-US_TOPIC_0000001909847892__li554810134916"></a><a name="li554810134916"></a><strong id="EN-US_TOPIC_0000001909847892__b2548201314916">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li4548113795"><p id="EN-US_TOPIC_0000001909847892__p5548313396"><a name="EN-US_TOPIC_0000001909847892__li4548113795"></a><a name="li4548113795"></a><strong id="EN-US_TOPIC_0000001909847892__b65484131498">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1854921312916"><p id="EN-US_TOPIC_0000001909847892__p654915132099"><a name="EN-US_TOPIC_0000001909847892__li1854921312916"></a><a name="li1854921312916"></a><strong id="EN-US_TOPIC_0000001909847892__b754911312911">STOPPING</strong>: The instance is stopping.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li16549131313910"><p id="EN-US_TOPIC_0000001909847892__p454961314920"><a name="EN-US_TOPIC_0000001909847892__li16549131313910"></a><a name="li16549131313910"></a><strong id="EN-US_TOPIC_0000001909847892__b85490131399">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1954911316912"><p id="EN-US_TOPIC_0000001909847892__p5549111312914"><a name="EN-US_TOPIC_0000001909847892__li1954911316912"></a><a name="li1954911316912"></a><strong id="EN-US_TOPIC_0000001909847892__b854920131498">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li654981310913"><p id="EN-US_TOPIC_0000001909847892__p1154917131798"><a name="EN-US_TOPIC_0000001909847892__li654981310913"></a><a name="li654981310913"></a><strong id="EN-US_TOPIC_0000001909847892__b1555021312913">STOPPED</strong>: The instance is stopped.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li205505131490"><p id="EN-US_TOPIC_0000001909847892__p1955018131096"><a name="EN-US_TOPIC_0000001909847892__li205505131490"></a><a name="li205505131490"></a><strong id="EN-US_TOPIC_0000001909847892__b12550131313919">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li15550713592"><p id="EN-US_TOPIC_0000001909847892__p3550201314914"><a name="EN-US_TOPIC_0000001909847892__li15550713592"></a><a name="li15550713592"></a><strong id="EN-US_TOPIC_0000001909847892__b16550413591">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li75501213397"><p id="EN-US_TOPIC_0000001909847892__p1255011131695"><a name="EN-US_TOPIC_0000001909847892__li75501213397"></a><a name="li75501213397"></a><strong id="EN-US_TOPIC_0000001909847892__b4551101313910">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li11551181315913"><p id="EN-US_TOPIC_0000001909847892__p7551121318920"><a name="EN-US_TOPIC_0000001909847892__li11551181315913"></a><a name="li11551181315913"></a><strong id="EN-US_TOPIC_0000001909847892__b1255141320915">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li17551913097"><p id="EN-US_TOPIC_0000001909847892__p1155131318919"><a name="EN-US_TOPIC_0000001909847892__li17551913097"></a><a name="li17551913097"></a><strong id="EN-US_TOPIC_0000001909847892__b1555119137914">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li125510132910"><p id="EN-US_TOPIC_0000001909847892__p355131318910"><a name="EN-US_TOPIC_0000001909847892__li125510132910"></a><a name="li125510132910"></a><strong id="EN-US_TOPIC_0000001909847892__b17552413794">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li755216133916"><p id="EN-US_TOPIC_0000001909847892__p175525131493"><a name="EN-US_TOPIC_0000001909847892__li755216133916"></a><a name="li755216133916"></a><strong id="EN-US_TOPIC_0000001909847892__b75529133916">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row14534171319914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p2055211312911">token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p105521813790">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p1555310131499">Token used for notebook authentication</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1653419139919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p175531513794">url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p85531613395">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p9554161318915">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row15357131395"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p195549134917">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p955412131497"><a href="#EN-US_TOPIC_0000001909847892__response_VolumeRes">VolumeRes</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p135551513392">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row20535111318911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p115551130910">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1655519137911">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p175551913391">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000001909847892__b105561130918">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row165352132093"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p95560131194">feature</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p13556413995">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p12556191317910">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul18557201312918"><li id="EN-US_TOPIC_0000001909847892__li2557121318913"><p id="EN-US_TOPIC_0000001909847892__p6557131319911"><a name="EN-US_TOPIC_0000001909847892__li2557121318913"></a><a name="li2557121318913"></a><strong id="EN-US_TOPIC_0000001909847892__b955717133910">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1855715137917"><p id="EN-US_TOPIC_0000001909847892__p155713131294"><a name="EN-US_TOPIC_0000001909847892__li1855715137917"></a><a name="li1855715137917"></a><strong id="EN-US_TOPIC_0000001909847892__b95571131293">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909847892__response_JobProgress"></a><a name="response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 5 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row125587131096"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.4.2.4.1.1"><p id="EN-US_TOPIC_0000001909847892__p10559141319918">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.4.2.4.1.2"><p id="EN-US_TOPIC_0000001909847892__p15607134919">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.4.2.4.1.3"><p id="EN-US_TOPIC_0000001909847892__p556081313910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row15558121311918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p95608133918">notebook_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p156131314911">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p05618138916">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row255811135915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p956111313915">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p456291313917">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p1456213131996">Job status in a specified step. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul115622013193"><li id="EN-US_TOPIC_0000001909847892__li155626138911"><p id="EN-US_TOPIC_0000001909847892__p356251312914"><a name="EN-US_TOPIC_0000001909847892__li155626138911"></a><a name="li155626138911"></a><strong id="EN-US_TOPIC_0000001909847892__b75631713496">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li15639138913"><p id="EN-US_TOPIC_0000001909847892__p4563013697"><a name="EN-US_TOPIC_0000001909847892__li15639138913"></a><a name="li15639138913"></a><strong id="EN-US_TOPIC_0000001909847892__b1256331313911">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li10563101318916"><p id="EN-US_TOPIC_0000001909847892__p16563111316918"><a name="EN-US_TOPIC_0000001909847892__li10563101318916"></a><a name="li10563101318916"></a><strong id="EN-US_TOPIC_0000001909847892__b35631513391">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li145632131496"><p id="EN-US_TOPIC_0000001909847892__p1156319131897"><a name="EN-US_TOPIC_0000001909847892__li145632131496"></a><a name="li145632131496"></a><strong id="EN-US_TOPIC_0000001909847892__b85633131691">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row125581313592"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p155642013794">step</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1356412131293">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p756421313910">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul165643131792"><li id="EN-US_TOPIC_0000001909847892__li1856414138910"><p id="EN-US_TOPIC_0000001909847892__p956531314914"><a name="EN-US_TOPIC_0000001909847892__li1856414138910"></a><a name="li1856414138910"></a><strong id="EN-US_TOPIC_0000001909847892__b1156513138918">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li15565713693"><p id="EN-US_TOPIC_0000001909847892__p13565181316917"><a name="EN-US_TOPIC_0000001909847892__li15565713693"></a><a name="li15565713693"></a><strong id="EN-US_TOPIC_0000001909847892__b756561314918">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1656515131896"><p id="EN-US_TOPIC_0000001909847892__p456541315917"><a name="EN-US_TOPIC_0000001909847892__li1656515131896"></a><a name="li1656515131896"></a><strong id="EN-US_TOPIC_0000001909847892__b6565151319911">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li65659139917"><p id="EN-US_TOPIC_0000001909847892__p7565613597"><a name="EN-US_TOPIC_0000001909847892__li65659139917"></a><a name="li65659139917"></a><strong id="EN-US_TOPIC_0000001909847892__b75661113397">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row9558413698"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p105663131919">step_description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1256610131791">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p105668131910">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909847892__response_EndpointsRes"></a><a name="response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 6 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row195672131093"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.5.2.4.1.1"><p id="EN-US_TOPIC_0000001909847892__p1456821314911">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.5.2.4.1.2"><p id="EN-US_TOPIC_0000001909847892__p1456991317914">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.5.2.4.1.3"><p id="EN-US_TOPIC_0000001909847892__p205691713594">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row175677133913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p15569181312916">allowed_access_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p165708136915">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p35701013394">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_0000001909847892__row18567121317912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p957011131299">dev_service</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p25719132914">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p857112131093">Supported service. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul115717136913"><li id="EN-US_TOPIC_0000001909847892__li1557112137911"><p id="EN-US_TOPIC_0000001909847892__p165718131192"><a name="EN-US_TOPIC_0000001909847892__li1557112137911"></a><a name="li1557112137911"></a><strong id="EN-US_TOPIC_0000001909847892__b125711313199">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li11572151313914"><p id="EN-US_TOPIC_0000001909847892__p75721613591"><a name="EN-US_TOPIC_0000001909847892__li11572151313914"></a><a name="li11572151313914"></a><strong id="EN-US_TOPIC_0000001909847892__b35729131098">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1656811315914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1757215131499">ssh_keys</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p057210138916">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p257314137919">List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909847892__response_Image"></a><a name="response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__response_Image" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row1057519131299"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.6.2.4.1.1"><p id="EN-US_TOPIC_0000001909847892__p1357918131396">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.6.2.4.1.2"><p id="EN-US_TOPIC_0000001909847892__p1557910131994">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.6.2.4.1.3"><p id="EN-US_TOPIC_0000001909847892__p45800133919">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row257519136918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p9580201318920">arch</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1258017131790">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p145811813595">Processor architecture supported by the image. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul758114131391"><li id="EN-US_TOPIC_0000001909847892__li45811013898"><p id="EN-US_TOPIC_0000001909847892__p1458121314917"><a name="EN-US_TOPIC_0000001909847892__li45811013898"></a><a name="li45811013898"></a><strong id="EN-US_TOPIC_0000001909847892__b135816131291">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1158114132093"><p id="EN-US_TOPIC_0000001909847892__p185829133912"><a name="EN-US_TOPIC_0000001909847892__li1158114132093"></a><a name="li1158114132093"></a><strong id="EN-US_TOPIC_0000001909847892__b165826135910">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1957517131598"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p4582111320911">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p45824137912">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p165831131793">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1457511315911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1658315131796">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p6584813090">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p9584101311915">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1557620131092"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p125841913997">dev_services</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1758518131199">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p15853131390">Services supported by the image. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul1158520131690"><li id="EN-US_TOPIC_0000001909847892__li1158511315920"><p id="EN-US_TOPIC_0000001909847892__p25851136912"><a name="EN-US_TOPIC_0000001909847892__li1158511315920"></a><a name="li1158511315920"></a><strong id="EN-US_TOPIC_0000001909847892__b155851137919">NOTEBOOK</strong>: You can access the notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li3585201320910"><p id="EN-US_TOPIC_0000001909847892__p1158514139916"><a name="EN-US_TOPIC_0000001909847892__li3585201320910"></a><a name="li3585201320910"></a><strong id="EN-US_TOPIC_0000001909847892__b1458617139913">SSH</strong>: You can remotely access the notebook instance from a local IDE through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row457691312911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p145861131894">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1558617132918">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p6586213997">ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format.For details, see <a href="ListImage.html">Querying Supported Images</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1157617131794"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p258713131094">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p115876131699">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p95871213997">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_0000001909847892__row157612131796"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1358820131990">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p13588613197">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p35889131797">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000001909847892__b358811313913">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row8576013792"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1358814131695">origin</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p258914131193">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p175891813892">Image source, which defaults to <strong id="EN-US_TOPIC_0000001909847892__b185891135912">CUSTOMIZE</strong>. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul258913135918"><li id="EN-US_TOPIC_0000001909847892__li8589111312918"><p id="EN-US_TOPIC_0000001909847892__p1358941319911"><a name="EN-US_TOPIC_0000001909847892__li8589111312918"></a><a name="li8589111312918"></a><strong id="EN-US_TOPIC_0000001909847892__b1359011131896">CUSTOMIZE</strong>: user-defined image</p>
</li><li id="EN-US_TOPIC_0000001909847892__li19590191319915"><p id="EN-US_TOPIC_0000001909847892__p1159016137918"><a name="EN-US_TOPIC_0000001909847892__li19590191319915"></a><a name="li19590191319915"></a><strong id="EN-US_TOPIC_0000001909847892__b1459021320915">IMAGE_SAVE</strong>: image saved using a development environment instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row757771316918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p35902131596">resource_categories</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p959014139914">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p135909135914">Flavors supported by the image. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul459131311911"><li id="EN-US_TOPIC_0000001909847892__li2591101310911"><p id="EN-US_TOPIC_0000001909847892__p1159117131396"><a name="EN-US_TOPIC_0000001909847892__li2591101310911"></a><a name="li2591101310911"></a><strong id="EN-US_TOPIC_0000001909847892__b75910131091">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000001909847892__li13591813299"><p id="EN-US_TOPIC_0000001909847892__p75918131398"><a name="EN-US_TOPIC_0000001909847892__li13591813299"></a><a name="li13591813299"></a><strong id="EN-US_TOPIC_0000001909847892__b19593313397">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row157714132093"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p6272111411912">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p122721214597">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p127211420910">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul1427314141399"><li id="EN-US_TOPIC_0000001909847892__li4273111411918"><p id="EN-US_TOPIC_0000001909847892__p182733144918"><a name="EN-US_TOPIC_0000001909847892__li4273111411918"></a><a name="li4273111411918"></a><strong id="EN-US_TOPIC_0000001909847892__b11273614899">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1927319141991"><p id="EN-US_TOPIC_0000001909847892__p827318141098"><a name="EN-US_TOPIC_0000001909847892__li1927319141991"></a><a name="li1927319141991"></a><strong id="EN-US_TOPIC_0000001909847892__b02737141299">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000001909847892__li172733141095"><p id="EN-US_TOPIC_0000001909847892__p172731514494"><a name="EN-US_TOPIC_0000001909847892__li172733141095"></a><a name="li172733141095"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1227314141395"><p id="EN-US_TOPIC_0000001909847892__p202732141493"><a name="EN-US_TOPIC_0000001909847892__li1227314141395"></a><a name="li1227314141395"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000001909847892__li18273714398"><p id="EN-US_TOPIC_0000001909847892__p14273314198"><a name="EN-US_TOPIC_0000001909847892__li18273714398"></a><a name="li18273714398"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1157721315913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p7273121415917">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p12742141797">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p82741141891">Image size, in unit of KB</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row95773131797"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p162744141295">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p162741214798">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p162741614296">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul2027416141690"><li id="EN-US_TOPIC_0000001909847892__li127413148917"><p id="EN-US_TOPIC_0000001909847892__p1527418142918"><a name="EN-US_TOPIC_0000001909847892__li127413148917"></a><a name="li127413148917"></a><strong id="EN-US_TOPIC_0000001909847892__b1527461410918">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li62744147913"><p id="EN-US_TOPIC_0000001909847892__p227471417910"><a name="EN-US_TOPIC_0000001909847892__li62744147913"></a><a name="li62744147913"></a><strong id="EN-US_TOPIC_0000001909847892__b127413144916">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li20274314895"><p id="EN-US_TOPIC_0000001909847892__p20275914090"><a name="EN-US_TOPIC_0000001909847892__li20274314895"></a><a name="li20274314895"></a><strong id="EN-US_TOPIC_0000001909847892__b10275114394">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1127541415919"><p id="EN-US_TOPIC_0000001909847892__p1927541420919"><a name="EN-US_TOPIC_0000001909847892__li1127541415919"></a><a name="li1127541415919"></a><strong id="EN-US_TOPIC_0000001909847892__b15275101418917">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li152751147916"><p id="EN-US_TOPIC_0000001909847892__p327581410916"><a name="EN-US_TOPIC_0000001909847892__li152751147916"></a><a name="li152751147916"></a><strong id="EN-US_TOPIC_0000001909847892__b527513145914">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li5275191413919"><p id="EN-US_TOPIC_0000001909847892__p122757141493"><a name="EN-US_TOPIC_0000001909847892__li5275191413919"></a><a name="li5275191413919"></a><strong id="EN-US_TOPIC_0000001909847892__b1527517141298">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_0000001909847892__row125778135913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p527516141898">status_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p327691417912">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p82766149911">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1757717131193"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p182765143919">support_res_categories</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p32761143920">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p10276191413918">Flavors supported by the image. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul02761141696"><li id="EN-US_TOPIC_0000001909847892__li127616148916"><p id="EN-US_TOPIC_0000001909847892__p22761914194"><a name="EN-US_TOPIC_0000001909847892__li127616148916"></a><a name="li127616148916"></a><strong id="EN-US_TOPIC_0000001909847892__b327671413911">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000001909847892__li82761914496"><p id="EN-US_TOPIC_0000001909847892__p1427612141393"><a name="EN-US_TOPIC_0000001909847892__li82761914496"></a><a name="li82761914496"></a><strong id="EN-US_TOPIC_0000001909847892__b02763140911">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row15577201312915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p327671411916">swr_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1427613141296">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p142764141199">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row115783131398"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1227691413912">tag</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p927613148912">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p9277114892">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row8578191314916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p227717141198">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p62771014298">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p152774141796">Image type. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul92773145918"><li id="EN-US_TOPIC_0000001909847892__li1927713141094"><p id="EN-US_TOPIC_0000001909847892__p52771141090"><a name="EN-US_TOPIC_0000001909847892__li1927713141094"></a><a name="li1927713141094"></a><strong id="EN-US_TOPIC_0000001909847892__b1027713140918">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000001909847892__li1227718146911"><p id="EN-US_TOPIC_0000001909847892__p727715141093"><a name="EN-US_TOPIC_0000001909847892__li1227718146911"></a><a name="li1227718146911"></a><strong id="EN-US_TOPIC_0000001909847892__b327717145918">DEDICATED</strong>: private image</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row105781133913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p227719148916">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p22774147910">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p62777148915">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row35789131592"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p152777141292">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p5277014699">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p1427715140910">Image visibility. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul1227718142911"><li id="EN-US_TOPIC_0000001909847892__li4277014796"><p id="EN-US_TOPIC_0000001909847892__p727711149916"><a name="EN-US_TOPIC_0000001909847892__li4277014796"></a><a name="li4277014796"></a><strong id="EN-US_TOPIC_0000001909847892__b192771014392">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000001909847892__li627716141494"><p id="EN-US_TOPIC_0000001909847892__p627718140919"><a name="EN-US_TOPIC_0000001909847892__li627716141494"></a><a name="li627716141494"></a><strong id="EN-US_TOPIC_0000001909847892__b142783141912">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row165785131098"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p227817148918">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p62781414598">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p182785149912">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000001909847892__b92784149918">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909847892__response_Lease"></a><a name="response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__response_Lease" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row10606813799"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.7.2.4.1.1"><p id="EN-US_TOPIC_0000001909847892__p22787141492">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.7.2.4.1.2"><p id="EN-US_TOPIC_0000001909847892__p42782014797">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.7.2.4.1.3"><p id="EN-US_TOPIC_0000001909847892__p162786141192">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row186061513195"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p12278131415912">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p2278161418910">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p17278161419910">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1660718131197"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p3278414099">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p13278914296">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p1278111411919">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_0000001909847892__row160718132093"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1227931415914">enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p142791314297">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p32791214590">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row160715134913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p827921412916">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p12795148919">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p827919143913">Indicates the automatic stop type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1960701311917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p82790141496">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p2279151410912">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p1127911141697">Time (UTC) when the instance is last updated (excluding the keepalive heartbeat time), accurate to millisecond.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909847892__response_Pool"></a><a name="response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__response_Pool" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row16135131094"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.8.2.4.1.1"><p id="EN-US_TOPIC_0000001909847892__p12791148913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.8.2.4.1.2"><p id="EN-US_TOPIC_0000001909847892__p1027921412915">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.8.2.4.1.3"><p id="EN-US_TOPIC_0000001909847892__p12279914495">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row15613713498"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p4279101415914">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p32793141295">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p228061413918">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row176141713897"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1628017146914">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p42808140910">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p1828010146915">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909847892__response_VolumeRes"></a><a name="response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 10 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row4617313396"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.9.2.4.1.1"><p id="EN-US_TOPIC_0000001909847892__p728018141696">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.9.2.4.1.2"><p id="EN-US_TOPIC_0000001909847892__p728051417914">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.9.2.4.1.3"><p id="EN-US_TOPIC_0000001909847892__p62805141997">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row14617171314920"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p7280814599">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1328012149917">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p172807141190">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_0000001909847892__row1461761311919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p92804143919">category</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p5280131418912">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p42806143913">Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000001909847892__i2280181410913">User Guide</em>. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul16280161417915"><li id="EN-US_TOPIC_0000001909847892__li132803141796"><p id="EN-US_TOPIC_0000001909847892__p32801114994"><a name="EN-US_TOPIC_0000001909847892__li132803141796"></a><a name="li132803141796"></a><strong id="EN-US_TOPIC_0000001909847892__b728014146916">EFS</strong>: Scalable File Service, which is the default storage</p>
</li><li id="EN-US_TOPIC_0000001909847892__li132806141297"><p id="EN-US_TOPIC_0000001909847892__p192807141399"><a name="EN-US_TOPIC_0000001909847892__li132806141297"></a><a name="li132806141297"></a><strong id="EN-US_TOPIC_0000001909847892__b92811014692">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1761812131892"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p1328115142917">mount_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p182812141794">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p828115141098">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000001909847892__b52811148913">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row12618513895"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p42812141399">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p192813141917">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p1728111147920">Owner to which the resource belongs. Options:</p>
<ul id="EN-US_TOPIC_0000001909847892__ul028113141790"><li id="EN-US_TOPIC_0000001909847892__li72811314998"><p id="EN-US_TOPIC_0000001909847892__p112811214492"><a name="EN-US_TOPIC_0000001909847892__li72811314998"></a><a name="li72811314998"></a><strong id="EN-US_TOPIC_0000001909847892__b72813146913">MANAGED</strong>: Resources are managed by service.</p>
</li><li id="EN-US_TOPIC_0000001909847892__li92819146910"><p id="EN-US_TOPIC_0000001909847892__p128112144913"><a name="EN-US_TOPIC_0000001909847892__li92819146910"></a><a name="li92819146910"></a><strong id="EN-US_TOPIC_0000001909847892__b112811141892">DEDICATED</strong>: Resources are managed by user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000001909847892__b12281314192">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row16618111317915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001909847892__p142812141491">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001909847892__p6281141414915">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001909847892__p11281914997">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000001909847892__b132815145911">RESIZING</strong> during capacity expansion and does not affect the instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909847892__section82812141699"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000001909847892__screen2028111145917">{ }</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001909847892__section152811814199"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000001909847892__p162811314191"><strong id="EN-US_TOPIC_0000001909847892__b6281101415917">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000001909847892__p1528211146914">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000001909847892__screen128219141195">{
"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.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_0000001909847892__section1282514891"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909847892__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001909847892__row763218139919"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.9.2.1.3.1.1"><p id="EN-US_TOPIC_0000001909847892__p2283514294">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.9.2.1.3.1.2"><p id="EN-US_TOPIC_0000001909847892__p2283111418918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909847892__row186321213594"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909847892__p192836141097">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909847892__p15283201417910">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row136327131396"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909847892__p17283121414912">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909847892__p628316141912">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1063312131192"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909847892__p528319141992">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1283181419911">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row663314131912"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909847892__p12831141591">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909847892__p4283201416915">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909847892__row1963310131896"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001909847892__p528312141899">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001909847892__p1428381416919">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909847892__section228318141091"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000001909847892__p1228414149914">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">DevEnviron (New Version)</a></div>
</div>
</div>
View Git Blame Copy Permalink