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

948 lines
113 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002374896573"></a><a name="EN-US_TOPIC_0000002374896573"></a>
<h1 class="topictitle1">Querying Notebook Instances</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section473113536385"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p167311453123811">This API is used to query the notebook instance list. You can query the notebook instance list that meets the search criteria as required.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section107314536388"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p20731753183815">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section14732153143810"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p3732125363814">GET /v1/{project_id}/notebooks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_table107321530380" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1373213534382"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1373255319389">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_0000002374896573__en-us_topic_0000002055164050_p11732105393819">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_0000002374896573__en-us_topic_0000002055164050_p9732125316386">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_0000002374896573__en-us_topic_0000002055164050_p17732185333813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row6732195310385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p87331953123819">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_0000002374896573__en-us_topic_0000002055164050_p27331053133810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p13733195312389">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p147331053153818">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_0000002374896573__en-us_topic_0000002055164050_table15734205363817" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row197331253113818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1273485315389">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_0000002374896573__en-us_topic_0000002055164050_p1673413531386">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_0000002374896573__en-us_topic_0000002055164050_p14734553103811">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_0000002374896573__en-us_topic_0000002055164050_p16734155310382">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1673365317385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p10734155318389">feature</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p673518532385">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p3735115373820">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p773518533384">Instance type. The default value is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b67356531382">NOTEBOOK</strong>. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul27353532384"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li127351253163818"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107357535383"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li127351253163818"></a><a name="en-us_topic_0000002055164050_li127351253163818"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b273514537385">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li2735165319387"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p773585315386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li2735165319387"></a><a name="en-us_topic_0000002055164050_li2735165319387"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b673555303812">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row16733155319385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p20735353163817">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p15735105333814">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1673525314387">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p273511539389">Number of records on each page. The default value is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1973575333810">10</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1973325314387"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17735115313815">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1073525310385">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p97357536385">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p127361537384">Specifies the instance name. Fuzzy match is supported. The value contains a maximum of 128 characters, including uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row12733165317381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p167361153183813">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p573645310383">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p187369533385">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18736115315388">ID of a dedicated resource pool.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1673465319385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17736135303817">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1073635318383">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p177361533388">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1973614531387">Start offset of the records on each page. The default value is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b673615315387">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1973410536381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77361053153811">owner</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1673613531389">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p10736105313389">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p773614532389">ID of the user to which the instance belongs. The value is a string of 32 characters consisting of lowercase letters and digits. This parameter is valid only when the account is a large account or the admin permission is granted. Generally, the value is the ID of the current login user.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1073445320385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p167371453103817">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107371353153810">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p187376532389">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p19737155318388">Sorting mode. The options are <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b14737953143816">ASC</strong> (ascending order) and <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b107371053163810">DESC</strong> (descending order). The default value is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b77371453173816">DESC</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row127346532384"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p9737453133817">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1273765316381">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p14737115315385">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p5737165343817">Sorting fields. Separate multiple fields with commas (,).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1673414530388"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p167376538389">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17737153143814">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p373715363810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p11737145343813">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul197371153133812"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li4737145317389"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p117381953173820"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li4737145317389"></a><a name="en-us_topic_0000002055164050_li4737145317389"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b873895373816">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li87381353163815"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p8738155314386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li87381353163815"></a><a name="en-us_topic_0000002055164050_li87381353163815"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b117380532381">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li2073835318389"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p12738165319388"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li2073835318389"></a><a name="en-us_topic_0000002055164050_li2073835318389"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b373820532387">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li77381532387"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p7738125320385"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li77381532387"></a><a name="en-us_topic_0000002055164050_li77381532387"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1073815537389">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li7738353173817"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1373815319388"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li7738353173817"></a><a name="en-us_topic_0000002055164050_li7738353173817"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b17738135373819">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li10738153123812"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p2738165313811"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li10738153123812"></a><a name="en-us_topic_0000002055164050_li10738153123812"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b873812532385">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li77384533388"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77384537388"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li77384533388"></a><a name="en-us_topic_0000002055164050_li77384533388"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b18738155313813">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li273812531383"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p207386537384"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li273812531383"></a><a name="en-us_topic_0000002055164050_li273812531383"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b37383535388">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1073885311381"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p67381853143819"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1073885311381"></a><a name="en-us_topic_0000002055164050_li1073885311381"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b17384537388">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li19738125311382"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p973815363814"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li19738125311382"></a><a name="en-us_topic_0000002055164050_li19738125311382"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1073875373816">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li197381537382"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p10738653113819"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li197381537382"></a><a name="en-us_topic_0000002055164050_li197381537382"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1973811537385">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li15738135318388"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p10738135312386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li15738135318388"></a><a name="en-us_topic_0000002055164050_li15738135318388"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1073945315387">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li2739653173812"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p0739155318389"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li2739653173812"></a><a name="en-us_topic_0000002055164050_li2739653173812"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b6739155311381">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li14739165313812"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p207391753163817"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li14739165313812"></a><a name="en-us_topic_0000002055164050_li14739165313812"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b167392536386">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row2073465323816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p3739105383811">workspaceId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p137391353143813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1173917535387">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p12739195393820">Workspace ID If no workspace is created, the default value is 0. If a workspace is created and used, the actual value prevails.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section197391053133818"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1873919535387">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section273945317387"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p127398533383"><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b5739253123816">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_NotebookListResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row3740145314388"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p67404534382">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_0000002374896573__en-us_topic_0000002055164050_p18740105393816">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_0000002374896573__en-us_topic_0000002055164050_p127406533384">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1374035323816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p374185333814">current</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p157414538381">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p2741135319381">Current page</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row197407531382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p474185315387">data</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p7741553203816">Array of <a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_NotebookResp">NotebookResp</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_0000002374896573__en-us_topic_0000002055164050_p374117535388">Data</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row20740353143812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p174113532387">pages</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18741155311388">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p5741553183818">Total pages</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1174005313819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p174175313387">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p674185317382">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p127411153173813">Number of records on each page</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row117405537387"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p874165323812">total</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p274165312386">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p174255363815">Total records</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_NotebookResp"></a><a name="en-us_topic_0000002055164050_response_NotebookResp"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>NotebookResp</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row0742165315384"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107432538383">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_0000002374896573__en-us_topic_0000002055164050_p474318537382">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_0000002374896573__en-us_topic_0000002055164050_p13743125317387">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row10742195317381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p12744165313382">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p3744453153818">Array of <a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_JobProgress">JobProgress</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p9744353193819">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1174219533389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p14744205314385">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p574455323815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p147441753143812">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row137421553183811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18744125316386">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1574425315387">Array of <a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_EndpointsRes">EndpointsRes</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1574475323814">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_0000002374896573__en-us_topic_0000002055164050_row107421953133811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p117447536381">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p47455536382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p0745185343819">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1574285317384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p15745653173816">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1374575393810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1174565383814">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row167421653153817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p2745145363818">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77452532383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p2745175317382">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row177421753123817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1674513534382">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p674518538384"><a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_Image">Image</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1074585393814">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row77421753183818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17451253173819">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p774518531383"><a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_Lease">Lease</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1746205313820">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row157426535381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p137461853183810">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p3746753193810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p8746155315386">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1974355373812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p474610534381">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1474605312382"><a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_Pool">Pool</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p774612531382">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_0000002374896573__en-us_topic_0000002055164050_row147435531384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17463531380">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p7746195323819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p2074685314382">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul10746145323816"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li774685312387"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1374685333819"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li774685312387"></a><a name="en-us_topic_0000002055164050_li774685312387"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b57461533384">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li4746135313388"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p4746185315387"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li4746135313388"></a><a name="en-us_topic_0000002055164050_li4746135313388"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b4746653203820">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li17461153163814"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p20747105393817"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li17461153163814"></a><a name="en-us_topic_0000002055164050_li17461153163814"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b17471853193814">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li47471153173818"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17471353123817"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li47471153173818"></a><a name="en-us_topic_0000002055164050_li47471153173818"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b074717537381">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li774755333819"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p67471053113813"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li774755333819"></a><a name="en-us_topic_0000002055164050_li774755333819"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1774710537385">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li20747185315386"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p187479536383"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li20747185315386"></a><a name="en-us_topic_0000002055164050_li20747185315386"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b167471753173810">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li574710531385"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p874795319389"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li574710531385"></a><a name="en-us_topic_0000002055164050_li574710531385"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b12747165323818">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1974710531385"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p4747053183812"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1974710531385"></a><a name="en-us_topic_0000002055164050_li1974710531385"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b177476536388">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1174745323811"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p974785312381"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1174745323811"></a><a name="en-us_topic_0000002055164050_li1174745323811"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b19747853163812">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li12747105312383"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p974714533382"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li12747105312383"></a><a name="en-us_topic_0000002055164050_li12747105312383"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b174705315389">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li19747105313383"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17747353133818"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li19747105313383"></a><a name="en-us_topic_0000002055164050_li19747105313383"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b5747205316384">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li117478531385"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1174712534386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li117478531385"></a><a name="en-us_topic_0000002055164050_li117478531385"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b9747553153812">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1274785383812"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1374719533386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1274785383812"></a><a name="en-us_topic_0000002055164050_li1274785383812"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1747753153820">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1747553113817"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77486536380"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1747553113817"></a><a name="en-us_topic_0000002055164050_li1747553113817"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b4748125323813">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row6743653143819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p87482053193811">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107481953143820">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p174817530384">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1574355393818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p47481453173817">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1474855311389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p11748145314387">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row87431535387"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p174885315383">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p117480536389"><a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_VolumeRes">VolumeRes</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p274845314381">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1074315312384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p774811532380">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p167481253193815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1574845393818">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b874885315382">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row12743155319384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p37495534381">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77494530388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p11749353153811">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul12749553153816"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li77491253183819"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1474919537383"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li77491253183819"></a><a name="en-us_topic_0000002055164050_li77491253183819"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b147491953203816">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li19749953183814"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p15749195363811"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li19749953183814"></a><a name="en-us_topic_0000002055164050_li19749953183814"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b10749135383817">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row14743115320384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p27491253153819">billing_items</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p974965318383">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p12749053103818">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1374910535387">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p5749753113820">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p177490536386">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row147433535385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p11749175353820">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p157491653113819"><a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_user">user</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p13750155315384">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_JobProgress"></a><a name="en-us_topic_0000002055164050_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 5 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row6750115316385"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1675035310387">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_0000002374896573__en-us_topic_0000002055164050_p1751953133815">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_0000002374896573__en-us_topic_0000002055164050_p1875105373818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row3750145313389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p575135343810">notebook_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17751195316383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p10751115312380">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1175005314385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p207519533383">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p07512053173814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p7751105315387">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul10751145315385"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li20751135319389"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p11751165323813"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li20751135319389"></a><a name="en-us_topic_0000002055164050_li20751135319389"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b12751753203810">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li9751253123818"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p87514535388"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li9751253123818"></a><a name="en-us_topic_0000002055164050_li9751253123818"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b57516536384">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li675125363813"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p16751135303819"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li675125363813"></a><a name="en-us_topic_0000002055164050_li675125363813"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1575119533380">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1475111538388"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p675165313819"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1475111538388"></a><a name="en-us_topic_0000002055164050_li1475111538388"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b5751135363818">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row775019536389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1975165343816">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p137521253143813">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1575115410383">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul137655443819"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li77645411386"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p16769548382"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li77645411386"></a><a name="en-us_topic_0000002055164050_li77645411386"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b97611540383">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li276185419384"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p476354123812"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li276185419384"></a><a name="en-us_topic_0000002055164050_li276185419384"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b127619545385">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li147635416389"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p16760542381"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li147635416389"></a><a name="en-us_topic_0000002055164050_li147635416389"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b77614549389">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li576115423813"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p6768545387"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li576115423813"></a><a name="en-us_topic_0000002055164050_li576115423813"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b2766544389">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row5750353203810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p10761754143815">step_description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p37685433819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p47615463812">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_EndpointsRes"></a><a name="en-us_topic_0000002055164050_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 6 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1575365313382"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1076125453816">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_0000002374896573__en-us_topic_0000002055164050_p1276195415384">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_0000002374896573__en-us_topic_0000002055164050_p187616544380">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row2754165319380"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p37655410383">allowed_access_ips</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107645412384">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_0000002374896573__en-us_topic_0000002055164050_p127616541381">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_0000002374896573__en-us_topic_0000002055164050_row10754195316382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18760548388">dev_service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p776105423813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1776854173817">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul3767543383"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li137615483810"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p47614549386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li137615483810"></a><a name="en-us_topic_0000002055164050_li137615483810"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b197635416386">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li147635403819"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p137616542381"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li147635403819"></a><a name="en-us_topic_0000002055164050_li147635403819"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b676165419387">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row5754145323815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p147635493816">ssh_keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p12761954173813">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_0000002374896573__en-us_topic_0000002055164050_p7761654123814">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_0000002374896573__en-us_topic_0000002055164050_row12754105318389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p7763547383">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p276165410383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p197695413817">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul1276125433817"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li2762540381"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p676125410387"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li2762540381"></a><a name="en-us_topic_0000002055164050_li2762540381"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b57615493818">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li3766546386"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p57625410387"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li3766546386"></a><a name="en-us_topic_0000002055164050_li3766546386"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b207619548382">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1375420534384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p197685417382">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p37613547381">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1976175413820">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_Image"></a><a name="en-us_topic_0000002055164050_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_Image" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row15756145312389"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77765419383">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_0000002374896573__en-us_topic_0000002055164050_p18771854163810">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_0000002374896573__en-us_topic_0000002055164050_p877165415386">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row375675315388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p207745493812">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p277185443819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17755413383">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul107785412389"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li5771554193810"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p6771554153810"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li5771554193810"></a><a name="en-us_topic_0000002055164050_li5771554193810"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b17773543389">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li197717544382"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p07713545384"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li197717544382"></a><a name="en-us_topic_0000002055164050_li197717544382"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b977554173813">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row77561653173810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p117775473810">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_0000002374896573__en-us_topic_0000002055164050_p0777547380">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p187775453811">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1775618531389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p137717543384">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p8771545387">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p27719543385">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row16756105313812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17777546382">dev_services</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p117716542383">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1177165423817">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul77735412384"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1772054103813"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p37785420380"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1772054103813"></a><a name="en-us_topic_0000002055164050_li1772054103813"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b187711546380">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1277654203812"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107716543387"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1277654203812"></a><a name="en-us_topic_0000002055164050_li1277654203812"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b117735413816">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_0000002374896573__en-us_topic_0000002055164050_row675617534380"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p977195483811">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1077115463811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77715443814">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_0000002374896573__en-us_topic_0000002055164050_row875685312389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77718547387">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p8771354113817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1377175410384">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_0000002374896573__en-us_topic_0000002055164050_row6756105313816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p5771854123816">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p10775541383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p11776542388">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b13776548386">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row7756175314388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1977454113816">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p117712548382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p127712547386">Image source, which defaults to <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1277145415384">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul3771554133810"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1977954143810"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p16771054123817"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1977954143810"></a><a name="en-us_topic_0000002055164050_li1977954143810"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b177715433819">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li3771754103818"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p117785415381"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li3771754103818"></a><a name="en-us_topic_0000002055164050_li3771754103818"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b67755483813">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row17756853163816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p2077205453820">resource_categories</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p177845473814">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p3781054193814">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul97885414386"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li57835463815"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p878135418386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li57835463815"></a><a name="en-us_topic_0000002055164050_li57835463815"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b97895423812">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1378145410382"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p14781754183814"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1378145410382"></a><a name="en-us_topic_0000002055164050_li1378145410382"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b17813544385">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row275675315385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p16781154183816">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1978854103811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p4781654173819">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul8781554193817"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li178175483810"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p7783547387"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li178175483810"></a><a name="en-us_topic_0000002055164050_li178175483810"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b6781954153819">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1978205410385"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1778125414385"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1978205410385"></a><a name="en-us_topic_0000002055164050_li1978205410385"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1178195417383">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li578195417388"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p378654173820"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li578195417388"></a><a name="en-us_topic_0000002055164050_li578195417388"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li157805453814"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p11783545386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li157805453814"></a><a name="en-us_topic_0000002055164050_li157805453814"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li6781354153810"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18781554163812"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li6781354153810"></a><a name="en-us_topic_0000002055164050_li6781354153810"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row375695315386"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p8781954133810">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p87815411383">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1778554153816">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row275611538381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p578105412386">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1789542386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p15781054123814">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul5781454133816"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li137819548380"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p578175420381"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li137819548380"></a><a name="en-us_topic_0000002055164050_li137819548380"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b578105433817">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li17781354183813"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1278165411385"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li17781354183813"></a><a name="en-us_topic_0000002055164050_li17781354183813"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b77810544382">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li187835416389"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p178185416389"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li187835416389"></a><a name="en-us_topic_0000002055164050_li187835416389"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b97875453819">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1778185415380"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p187865415387"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1778185415380"></a><a name="en-us_topic_0000002055164050_li1778185415380"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1781754123819">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li678054143819"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p178155483814"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li678054143819"></a><a name="en-us_topic_0000002055164050_li678054143819"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1478254193815">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li27815417387"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p87885416389"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li27815417387"></a><a name="en-us_topic_0000002055164050_li27815417387"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b178354113817">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_0000002374896573__en-us_topic_0000002055164050_row1375645314386"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18789547389">status_message</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1878145403811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p9789546383">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row9756115353817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p378115433814">support_res_categories</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p378654183813">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p14781544381">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul2783548380"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1878125416385"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18789546386"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1878125416385"></a><a name="en-us_topic_0000002055164050_li1878125416385"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b17814547383">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li0786546386"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p157835410384"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li0786546386"></a><a name="en-us_topic_0000002055164050_li0786546386"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1178135453818">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row14756953193817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p15781454133813">swr_path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107845493812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p87811542381">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row187565533384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p87885493818">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1479185453814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p979154193812">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row7756165373818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p77965411381">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p57905403814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1879165414381">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul13791554163818"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li6791546381"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p179654193810"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li6791546381"></a><a name="en-us_topic_0000002055164050_li6791546381"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b107945417384">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li137914541381"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p379135413384"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li137914541381"></a><a name="en-us_topic_0000002055164050_li137914541381"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1979175413382">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row27574534386"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p67913549388">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_0000002374896573__en-us_topic_0000002055164050_p157995493818">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p13791754143810">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row075720535384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107920549389">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p107985415381">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p37917543382">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul979165493810"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li67955413818"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p14797546381"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li67955413818"></a><a name="en-us_topic_0000002055164050_li67955413818"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b27985419387">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li107911545387"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1879165415384"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li107911545387"></a><a name="en-us_topic_0000002055164050_li107911545387"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b5791354153815">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row18757753153817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p57965413381">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1679115413388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p4791154133818">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b2079175493817">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_Lease"></a><a name="en-us_topic_0000002055164050_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row976219533384"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1979954153815">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_0000002374896573__en-us_topic_0000002055164050_p157917544383">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_0000002374896573__en-us_topic_0000002055164050_p879205415388">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row57621553143812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18791454123819">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1179195483811">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p079954183820">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row127622053123813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p19791854163812">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p179454163814">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p979145423813">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_0000002374896573__en-us_topic_0000002055164050_row1076215303812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18791654193813">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p880154143814">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p180754183815">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row676213536380"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p188015544383">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p680654173815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p208013542382">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul11802054193818"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1380354183815"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p380165415389"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1380354183815"></a><a name="en-us_topic_0000002055164050_li1380354183815"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1380554183815"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1980654163815"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1380554183815"></a><a name="en-us_topic_0000002055164050_li1380554183815"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row17762353153817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1680185403820">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p180105443810">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1780105412383">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_0000002374896573__en-us_topic_0000002055164050_response_Pool"></a><a name="en-us_topic_0000002055164050_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row57631053113810"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p78055418383">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_0000002374896573__en-us_topic_0000002055164050_p780554133819">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_0000002374896573__en-us_topic_0000002055164050_p4801854163815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row6763253103820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18025413814">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1680195493816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p4802054193816">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row6763953153815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1380354203818">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p180145463816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p08065414386">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_VolumeRes"></a><a name="en-us_topic_0000002055164050_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 10 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row776411536386"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p38075419385">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_0000002374896573__en-us_topic_0000002055164050_p380954203816">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_0000002374896573__en-us_topic_0000002055164050_p1280954183817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1376435363819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p48025410388">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p2809548382">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p158095416388">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_0000002374896573__en-us_topic_0000002055164050_row6764175343816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1780454143811">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p14801854163815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p16801554143817">Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_i10801354183817">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul16800548386"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li580175423817"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1480165453812"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li580175423817"></a><a name="en-us_topic_0000002055164050_li580175423817"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b180135463812">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li580175493812"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p980105493819"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li580175493812"></a><a name="en-us_topic_0000002055164050_li580175493812"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b080454123816">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row17641453123818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p178035416388">mount_path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p98025483820">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1580195414384">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b7801554173816">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1076425315388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p08035415388">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p180155410385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1480954133814">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_ul168025410383"><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li178025419387"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p2801354183815"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li178025419387"></a><a name="en-us_topic_0000002055164050_li178025419387"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b9806540382">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1580354113820"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p980105414382"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_li1580354113820"></a><a name="en-us_topic_0000002055164050_li1580354113820"></a><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b128145473819">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b13811654163810">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row276485310382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1381145416383">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p188175414388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p481125415388">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b38165423811">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_0000002374896573__en-us_topic_0000002055164050_response_user"></a><a name="en-us_topic_0000002055164050_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_user" frame="border" border="1" rules="all"><caption><b>Table 11 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row5766125313810"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p481195473810">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_0000002374896573__en-us_topic_0000002055164050_p208155463816">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_0000002374896573__en-us_topic_0000002055164050_p1481185433813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row77662535381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p98195443819">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p381155412389"><a href="#EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_domain">domain</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p17818543387">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1576645303818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p208116547387">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p98135413384">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p881185412382">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row167660532387"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p581105413810">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1381125423811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p198175423812">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_domain"></a><a name="en-us_topic_0000002055164050_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_response_domain" frame="border" border="1" rules="all"><caption><b>Table 12 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row176775323812"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.12.2.4.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p0811054173819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.12.2.4.1.2"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p681125419384">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.12.2.4.1.3"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p14818540389">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row2076795319387"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.12.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p98195433820">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.12.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p198145417389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1181155413818">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row177678536381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.12.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p081754173813">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.12.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1481105413810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p13811654183819">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section148185417386"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_screen88155415381">GET https://{endpoint}/v1/{project_id}/notebooks</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section281454183817"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p208165417387"><strong id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_b1281654163813">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p48135403819">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_screen981454193819">{
"current" : 0,
"data" : [ {
"description" : "api-test",
"feature" : "DEFAULT",
"flavor" : "modelarts.vm.cpu.free",
"id" : "f9937afa-ca78-45b6-bc12-7ecf42553c48",
"image" : {
"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",
"type" : "BUILD_IN"
},
"lease" : {
"create_at" : 1638841805439,
"duration" : 3600000,
"enable" : true,
"update_at" : 1638841805439
},
"name" : "notebook_5ee4bf0e",
"status" : "CREATING",
"token" : "58ba50c6-e8ff-245c-4840-49e51aa70737",
"volume" : {
"category" : "EVS",
"ownership" : "MANAGED",
"mount_path" : "/home/ma-user/work/",
"capacity" : 50
},
"workspace_id" : "0"
}, {
"description" : "api-test",
"feature" : "NOTEBOOK",
"flavor" : "modelarts.vm.cpu.2u",
"id" : "f9937afa-4451-42db-a76b-72d624749f66",
"image" : {
"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",
"type" : "BUILD_IN"
},
"lease" : {
"create_at" : 1638841744515,
"duration" : 3600000,
"enable" : true,
"update_at" : 1638841744515
},
"name" : "notebooks_test",
"status" : "CREATING",
"token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022",
"volume" : {
"category" : "EVS",
"ownership" : "MANAGED",
"mount_path" : "/home/ma-user/work/",
"capacity" : 50
},
"workspace_id" : "0"
} ],
"pages" : 1,
"size" : 10,
"total" : 2
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section17821754153818"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row1077095313383"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p148211544382">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_0000002374896573__en-us_topic_0000002055164050_p168225483817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row17708531383"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p14827541384">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p78212542386">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row7770353173813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p11821154193813">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p482554103819">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row777095317381"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p282135423816">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p68215417382">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_row67701953173819"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p18255473815">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p1482954103815">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_section128215413811"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002374896573__en-us_topic_0000002055164050_p12821154173815">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