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

955 lines
91 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000002233726926"></a><a name="EN-US_TOPIC_0000002233726926"></a>
<h1 class="topictitle1">Querying Notebook Instances</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002233726926__section1887853763316"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002233726926__p28784373333">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_0000002233726926__section14878637103311"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002233726926__p14878173793318">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726926__section20878143714335"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002233726926__p20878203717333">GET /v1/{project_id}/notebooks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726926__table387973711332" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726926__row188781837113320"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002233726926__p208792374334">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_0000002233726926__p2879113715334">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_0000002233726926__p287923718335">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_0000002233726926__p168791370338">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row88791037113316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1879163712331">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_0000002233726926__p1387953793315">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1987918371330">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p4880113773315">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_0000002233726926__table1881163743312" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726926__row58801037153315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000002233726926__p488263715334">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_0000002233726926__p788223743318">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_0000002233726926__p1188215379333">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_0000002233726926__p788273714334">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row4881113753316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1488233773318">feature</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726926__p988220371336">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p28821137143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p2088243713316">Instance type. The default value is <strong id="EN-US_TOPIC_0000002233726926__b198828377332">NOTEBOOK</strong>. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul788233783319"><li id="EN-US_TOPIC_0000002233726926__li1188223733314"><p id="EN-US_TOPIC_0000002233726926__p1288233763311"><a name="EN-US_TOPIC_0000002233726926__li1188223733314"></a><a name="li1188223733314"></a><strong id="EN-US_TOPIC_0000002233726926__b5883133719339">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li388314372335"><p id="EN-US_TOPIC_0000002233726926__p1788383710338"><a name="EN-US_TOPIC_0000002233726926__li388314372335"></a><a name="li388314372335"></a><strong id="EN-US_TOPIC_0000002233726926__b108837374335">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row2881103718338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p28831437103320">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726926__p13883203763310">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p17883183715336">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p0883143713336">Number of records on each page. The default value is <strong id="EN-US_TOPIC_0000002233726926__b488363718339">10</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row68811437123315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p118831837123316">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726926__p188343773316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p888314377330">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p388313378333">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_0000002233726926__row1788193715334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p18841337143317">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_0000002233726926__p6884143763317">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p6884133716333">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p48841375331">ID of a dedicated resource pool.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row688114372338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p28840379335">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726926__p78840377334">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p118841237193316">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p18884183723318">Start offset of the records on each page. The default value is <strong id="EN-US_TOPIC_0000002233726926__b13884183733315">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row198819371339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p16884183716333">owner</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726926__p6886437183320">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1886837113319">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p1988653743318">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_0000002233726926__row3881183719332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p38861337153312">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_0000002233726926__p68861537133312">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1188673793317">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p11886337203320">Sorting mode. The options are <strong id="EN-US_TOPIC_0000002233726926__b1788603723319">ASC</strong> (ascending order) and <strong id="EN-US_TOPIC_0000002233726926__b988614379334">DESC</strong> (descending order). The default value is <strong id="EN-US_TOPIC_0000002233726926__b3886123713315">DESC</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row118812037153317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p5886173753312">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_0000002233726926__p888733716331">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1788763783316">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p1588743715335">Sorting fields. Separate multiple fields with commas (,).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1881103712333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p788711379332">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1288763763310">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p168871837163312">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p118871137103312">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul15887143743317"><li id="EN-US_TOPIC_0000002233726926__li18887137113313"><p id="EN-US_TOPIC_0000002233726926__p88879375332"><a name="EN-US_TOPIC_0000002233726926__li18887137113313"></a><a name="li18887137113313"></a><strong id="EN-US_TOPIC_0000002233726926__b98871737123318">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li38872374339"><p id="EN-US_TOPIC_0000002233726926__p688713717334"><a name="EN-US_TOPIC_0000002233726926__li38872374339"></a><a name="li38872374339"></a><strong id="EN-US_TOPIC_0000002233726926__b388811373338">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1688833753318"><p id="EN-US_TOPIC_0000002233726926__p178881237203316"><a name="EN-US_TOPIC_0000002233726926__li1688833753318"></a><a name="li1688833753318"></a><strong id="EN-US_TOPIC_0000002233726926__b8888173719335">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1188893720332"><p id="EN-US_TOPIC_0000002233726926__p1788817370332"><a name="EN-US_TOPIC_0000002233726926__li1188893720332"></a><a name="li1188893720332"></a><strong id="EN-US_TOPIC_0000002233726926__b17888937173311">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1788818379331"><p id="EN-US_TOPIC_0000002233726926__p1788823753312"><a name="EN-US_TOPIC_0000002233726926__li1788818379331"></a><a name="li1788818379331"></a><strong id="EN-US_TOPIC_0000002233726926__b1888173733319">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1688843703317"><p id="EN-US_TOPIC_0000002233726926__p208881937193316"><a name="EN-US_TOPIC_0000002233726926__li1688843703317"></a><a name="li1688843703317"></a><strong id="EN-US_TOPIC_0000002233726926__b6888163716331">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1688813715339"><p id="EN-US_TOPIC_0000002233726926__p14888637133310"><a name="EN-US_TOPIC_0000002233726926__li1688813715339"></a><a name="li1688813715339"></a><strong id="EN-US_TOPIC_0000002233726926__b13889103793312">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li15889193703318"><p id="EN-US_TOPIC_0000002233726926__p888903717330"><a name="EN-US_TOPIC_0000002233726926__li15889193703318"></a><a name="li15889193703318"></a><strong id="EN-US_TOPIC_0000002233726926__b1188953712339">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li158896379330"><p id="EN-US_TOPIC_0000002233726926__p1288918373337"><a name="EN-US_TOPIC_0000002233726926__li158896379330"></a><a name="li158896379330"></a><strong id="EN-US_TOPIC_0000002233726926__b08891437183318">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li16889537113311"><p id="EN-US_TOPIC_0000002233726926__p688963713334"><a name="EN-US_TOPIC_0000002233726926__li16889537113311"></a><a name="li16889537113311"></a><strong id="EN-US_TOPIC_0000002233726926__b1088973773316">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li88891137113316"><p id="EN-US_TOPIC_0000002233726926__p2889133720333"><a name="EN-US_TOPIC_0000002233726926__li88891137113316"></a><a name="li88891137113316"></a><strong id="EN-US_TOPIC_0000002233726926__b17889113719330">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li388933719331"><p id="EN-US_TOPIC_0000002233726926__p3889103717330"><a name="EN-US_TOPIC_0000002233726926__li388933719331"></a><a name="li388933719331"></a><strong id="EN-US_TOPIC_0000002233726926__b2889143710333">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1888943723319"><p id="EN-US_TOPIC_0000002233726926__p1889193718337"><a name="EN-US_TOPIC_0000002233726926__li1888943723319"></a><a name="li1888943723319"></a><strong id="EN-US_TOPIC_0000002233726926__b208898376333">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1288918378334"><p id="EN-US_TOPIC_0000002233726926__p4890537133311"><a name="EN-US_TOPIC_0000002233726926__li1288918378334"></a><a name="li1288918378334"></a><strong id="EN-US_TOPIC_0000002233726926__b18901037163316">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row6881163716338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726926__p989014374332">workspaceId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1389013714337">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726926__p2890173723317">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726926__p789093793314">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_0000002233726926__section2890183713330"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002233726926__p189063714337">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726926__section4891143717335"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002233726926__p489153743311"><strong id="EN-US_TOPIC_0000002233726926__b1289113720333">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726926__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_0000002233726926__row8891193743317"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p168921937123315">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_0000002233726926__p11892437133313">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_0000002233726926__p589210371337">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row198911337103316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p148923379335">current</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p88921137183310">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p2892737103316">Current page</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row18914377335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p7893133715339">data</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p3893193719337">Array of <a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p58931837173317">Data</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row28911937113314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1589363783319">pages</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p4893203720338">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1189313773314">Total pages</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row189173753313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p208931737203319">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p28938371333">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p0893163714335">Number of records on each page</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1489233733316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p208948377339">total</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p12894637173316">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p13894123718331">Total records</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726926__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_0000002233726926__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_0000002233726926__row15894113733316"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p16896337133318">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_0000002233726926__p88961379337">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_0000002233726926__p9897537153312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row7895237163313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p289714376338">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_0000002233726926__p15897337143312">Array of <a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p198975375339">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row48952371333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p8897103713334">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p98978378331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p2089753743312">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1589510377335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p138971837103314">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p789883763312">Array of <a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p789817372333">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_0000002233726926__row19895837203314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p17898153783318">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_0000002233726926__p18898163743313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p108981037133318">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row7895937123316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p08981737183312">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p48981937133315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1789893718338">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row11895153783318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p38991637123313">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p208993373336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p2899133710336">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row989523743311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p389918376336">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p108991137163312"><a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p889943719337">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row9895123763319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p78991537193316">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p14899143718335"><a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p1189914378334">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row18895163793310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p15900103723312">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p159001937193318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p19900163753318">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1789583710338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p890019373330">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p16900183723314"><a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p1090073713316">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_0000002233726926__row5895103743314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p13902837143314">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p7902103773314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p79025378333">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul2090219375334"><li id="EN-US_TOPIC_0000002233726926__li17902237193313"><p id="EN-US_TOPIC_0000002233726926__p39029377337"><a name="EN-US_TOPIC_0000002233726926__li17902237193313"></a><a name="li17902237193313"></a><strong id="EN-US_TOPIC_0000002233726926__b1090217377335">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li990210375331"><p id="EN-US_TOPIC_0000002233726926__p14902637103310"><a name="EN-US_TOPIC_0000002233726926__li990210375331"></a><a name="li990210375331"></a><strong id="EN-US_TOPIC_0000002233726926__b17902133743318">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li79021137103320"><p id="EN-US_TOPIC_0000002233726926__p1890219376336"><a name="EN-US_TOPIC_0000002233726926__li79021137103320"></a><a name="li79021137103320"></a><strong id="EN-US_TOPIC_0000002233726926__b1890393711331">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li490313753310"><p id="EN-US_TOPIC_0000002233726926__p1390383733318"><a name="EN-US_TOPIC_0000002233726926__li490313753310"></a><a name="li490313753310"></a><strong id="EN-US_TOPIC_0000002233726926__b18903103718337">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li2090343717333"><p id="EN-US_TOPIC_0000002233726926__p199031937193313"><a name="EN-US_TOPIC_0000002233726926__li2090343717333"></a><a name="li2090343717333"></a><strong id="EN-US_TOPIC_0000002233726926__b20903103753318">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1090393743312"><p id="EN-US_TOPIC_0000002233726926__p1290393763318"><a name="EN-US_TOPIC_0000002233726926__li1090393743312"></a><a name="li1090393743312"></a><strong id="EN-US_TOPIC_0000002233726926__b1790333723318">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li119031537163319"><p id="EN-US_TOPIC_0000002233726926__p490353719333"><a name="EN-US_TOPIC_0000002233726926__li119031537163319"></a><a name="li119031537163319"></a><strong id="EN-US_TOPIC_0000002233726926__b2090315372335">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li7903203717330"><p id="EN-US_TOPIC_0000002233726926__p390320375331"><a name="EN-US_TOPIC_0000002233726926__li7903203717330"></a><a name="li7903203717330"></a><strong id="EN-US_TOPIC_0000002233726926__b1190363793320">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li890373711337"><p id="EN-US_TOPIC_0000002233726926__p29031374336"><a name="EN-US_TOPIC_0000002233726926__li890373711337"></a><a name="li890373711337"></a><strong id="EN-US_TOPIC_0000002233726926__b190333714333">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li12903237183310"><p id="EN-US_TOPIC_0000002233726926__p1390333710334"><a name="EN-US_TOPIC_0000002233726926__li12903237183310"></a><a name="li12903237183310"></a><strong id="EN-US_TOPIC_0000002233726926__b19904143713320">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li189042378336"><p id="EN-US_TOPIC_0000002233726926__p16904113783320"><a name="EN-US_TOPIC_0000002233726926__li189042378336"></a><a name="li189042378336"></a><strong id="EN-US_TOPIC_0000002233726926__b199045375338">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li8904133753319"><p id="EN-US_TOPIC_0000002233726926__p17904137163310"><a name="EN-US_TOPIC_0000002233726926__li8904133753319"></a><a name="li8904133753319"></a><strong id="EN-US_TOPIC_0000002233726926__b159041737123316">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1190413723319"><p id="EN-US_TOPIC_0000002233726926__p1890443723317"><a name="EN-US_TOPIC_0000002233726926__li1190413723319"></a><a name="li1190413723319"></a><strong id="EN-US_TOPIC_0000002233726926__b990453720339">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li8904037123314"><p id="EN-US_TOPIC_0000002233726926__p690413763319"><a name="EN-US_TOPIC_0000002233726926__li8904037123314"></a><a name="li8904037123314"></a><strong id="EN-US_TOPIC_0000002233726926__b490483763319">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row189553763316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p190463715337">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p14904937183318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p89051237193313">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row17895193720338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p109051370334">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1905153718332">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p139051937193316">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row18895163753310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p39058371333">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1790553753312"><a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p1905163723315">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row9895123743313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p790573718334">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_0000002233726926__p3905937153314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1190517372338">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726926__b1890653711332">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1789673743318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p12906137193315">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1290663723311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p149061437183317">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul14906133743316"><li id="EN-US_TOPIC_0000002233726926__li15906183715338"><p id="EN-US_TOPIC_0000002233726926__p15906173717337"><a name="EN-US_TOPIC_0000002233726926__li15906183715338"></a><a name="li15906183715338"></a><strong id="EN-US_TOPIC_0000002233726926__b1990693710331">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1390615373334"><p id="EN-US_TOPIC_0000002233726926__p12906143713334"><a name="EN-US_TOPIC_0000002233726926__li1390615373334"></a><a name="li1390615373334"></a><strong id="EN-US_TOPIC_0000002233726926__b590617373333">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row58969376331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p2906103773317">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_0000002233726926__p18906737173317">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_0000002233726926__p1990793712339">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002233726926__p8907437173313">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726926__p1490753733316">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726926__p39077379334">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row7896737143312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p5907143715333">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p590733710330"><a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p1190703713336">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726926__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_0000002233726926__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_0000002233726926__row199081537163310"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p090853711335">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_0000002233726926__p7908163773314">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_0000002233726926__p69081237113319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row8908143743316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p49096377331">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_0000002233726926__p1790915378336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p20909133743318">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1390820375334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1790923733316">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p790912377339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p190993763316">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul1090913712335"><li id="EN-US_TOPIC_0000002233726926__li4909437193316"><p id="EN-US_TOPIC_0000002233726926__p119091937133315"><a name="EN-US_TOPIC_0000002233726926__li4909437193316"></a><a name="li4909437193316"></a><strong id="EN-US_TOPIC_0000002233726926__b11909113719337">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li3909337143315"><p id="EN-US_TOPIC_0000002233726926__p1690963723315"><a name="EN-US_TOPIC_0000002233726926__li3909337143315"></a><a name="li3909337143315"></a><strong id="EN-US_TOPIC_0000002233726926__b6909837133313">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li149093371336"><p id="EN-US_TOPIC_0000002233726926__p890913711337"><a name="EN-US_TOPIC_0000002233726926__li149093371336"></a><a name="li149093371336"></a><strong id="EN-US_TOPIC_0000002233726926__b14910113723316">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li2910153743318"><p id="EN-US_TOPIC_0000002233726926__p0910137133315"><a name="EN-US_TOPIC_0000002233726926__li2910153743318"></a><a name="li2910153743318"></a><strong id="EN-US_TOPIC_0000002233726926__b5910143743318">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row149081337193310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p12910937153311">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1591016370335">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p12424103883312">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul19424133843317"><li id="EN-US_TOPIC_0000002233726926__li7424938103320"><p id="EN-US_TOPIC_0000002233726926__p1942453833314"><a name="EN-US_TOPIC_0000002233726926__li7424938103320"></a><a name="li7424938103320"></a><strong id="EN-US_TOPIC_0000002233726926__b34241138103312">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li184241238153314"><p id="EN-US_TOPIC_0000002233726926__p184241338103320"><a name="EN-US_TOPIC_0000002233726926__li184241238153314"></a><a name="li184241238153314"></a><strong id="EN-US_TOPIC_0000002233726926__b1142413853312">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li17424938153316"><p id="EN-US_TOPIC_0000002233726926__p342417382331"><a name="EN-US_TOPIC_0000002233726926__li17424938153316"></a><a name="li17424938153316"></a><strong id="EN-US_TOPIC_0000002233726926__b11424938113318">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li64241938133312"><p id="EN-US_TOPIC_0000002233726926__p8424103853313"><a name="EN-US_TOPIC_0000002233726926__li64241938133312"></a><a name="li64241938133312"></a><strong id="EN-US_TOPIC_0000002233726926__b134241138113316">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row590863773318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p10424438153314">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_0000002233726926__p15424193803310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p342483815331">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726926__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_0000002233726926__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_0000002233726926__row391293711332"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p24253389336">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_0000002233726926__p164251438133316">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_0000002233726926__p54251538133312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row8913837123316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p15425143813339">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_0000002233726926__p16425143803313">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_0000002233726926__p142519383332">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_0000002233726926__row159138376334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p10425153803314">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_0000002233726926__p10425338183311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p3425133803315">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul184252038173319"><li id="EN-US_TOPIC_0000002233726926__li1425153810338"><p id="EN-US_TOPIC_0000002233726926__p942543811336"><a name="EN-US_TOPIC_0000002233726926__li1425153810338"></a><a name="li1425153810338"></a><strong id="EN-US_TOPIC_0000002233726926__b94251238113311">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1942523833312"><p id="EN-US_TOPIC_0000002233726926__p164258386338"><a name="EN-US_TOPIC_0000002233726926__li1942523833312"></a><a name="li1942523833312"></a><strong id="EN-US_TOPIC_0000002233726926__b9425938153312">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row169131437103316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p44251838183318">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_0000002233726926__p12425183843313">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_0000002233726926__p194251238193313">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_0000002233726926__row89131437123311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1742543803317">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1742513386337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p16425538163313">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul144252038103316"><li id="EN-US_TOPIC_0000002233726926__li1642514386334"><p id="EN-US_TOPIC_0000002233726926__p942516382332"><a name="EN-US_TOPIC_0000002233726926__li1642514386334"></a><a name="li1642514386334"></a><strong id="EN-US_TOPIC_0000002233726926__b44254383339">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li15425183816334"><p id="EN-US_TOPIC_0000002233726926__p7425103803318"><a name="EN-US_TOPIC_0000002233726926__li15425183816334"></a><a name="li15425183816334"></a><strong id="EN-US_TOPIC_0000002233726926__b242511381337">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row991323713319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p2042503873311">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p442553803311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p442533812333">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726926__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_0000002233726926__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_0000002233726926__row49161137123313"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p5426113810338">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_0000002233726926__p542617381331">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_0000002233726926__p74262387335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row109166371331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1742673873314">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p14426123819333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1442643811331">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul242614382337"><li id="EN-US_TOPIC_0000002233726926__li1342633816333"><p id="EN-US_TOPIC_0000002233726926__p17426153819339"><a name="EN-US_TOPIC_0000002233726926__li1342633816333"></a><a name="li1342633816333"></a><strong id="EN-US_TOPIC_0000002233726926__b142615384339">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1342617387330"><p id="EN-US_TOPIC_0000002233726926__p1942693815332"><a name="EN-US_TOPIC_0000002233726926__li1342617387330"></a><a name="li1342617387330"></a><strong id="EN-US_TOPIC_0000002233726926__b742643816339">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row11916143773316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p19426203813333">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_0000002233726926__p1842633833315">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p7426133814335">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row17916637163319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p34261438113314">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1342643812334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p842614386337">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1691610373336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p742613833314">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_0000002233726926__p64261438153314">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_0000002233726926__p94261338123314">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul1742613383334"><li id="EN-US_TOPIC_0000002233726926__li44261138123316"><p id="EN-US_TOPIC_0000002233726926__p1842633819335"><a name="EN-US_TOPIC_0000002233726926__li44261138123316"></a><a name="li44261138123316"></a><strong id="EN-US_TOPIC_0000002233726926__b4426193818332">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li34269381333"><p id="EN-US_TOPIC_0000002233726926__p134261389338"><a name="EN-US_TOPIC_0000002233726926__li34269381333"></a><a name="li34269381333"></a><strong id="EN-US_TOPIC_0000002233726926__b13426143803318">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_0000002233726926__row691683743310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p10427103853314">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p8427193811337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p8427163814333">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_0000002233726926__row1391613372337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p14271738103314">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p14427238143318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p7427133815330">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_0000002233726926__row1491793719336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p184276387334">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p13427113818331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p144271138103311">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002233726926__b1042773813339">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row159171037183318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1542712383334">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p204277381331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1242719385337">Image source, which defaults to <strong id="EN-US_TOPIC_0000002233726926__b942773863314">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul18427193812339"><li id="EN-US_TOPIC_0000002233726926__li12427173814334"><p id="EN-US_TOPIC_0000002233726926__p0427193883314"><a name="EN-US_TOPIC_0000002233726926__li12427173814334"></a><a name="li12427173814334"></a><strong id="EN-US_TOPIC_0000002233726926__b4427438123311">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002233726926__li742713843313"><p id="EN-US_TOPIC_0000002233726926__p5427183803310"><a name="EN-US_TOPIC_0000002233726926__li742713843313"></a><a name="li742713843313"></a><strong id="EN-US_TOPIC_0000002233726926__b19427123812334">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row291793711337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p442763833318">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_0000002233726926__p74271738133311">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_0000002233726926__p11427183811333">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul0427738193317"><li id="EN-US_TOPIC_0000002233726926__li942723813312"><p id="EN-US_TOPIC_0000002233726926__p13427143843312"><a name="EN-US_TOPIC_0000002233726926__li942723813312"></a><a name="li942723813312"></a><strong id="EN-US_TOPIC_0000002233726926__b19427173812331">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726926__li842743813319"><p id="EN-US_TOPIC_0000002233726926__p342718382330"><a name="EN-US_TOPIC_0000002233726926__li842743813319"></a><a name="li842743813319"></a><strong id="EN-US_TOPIC_0000002233726926__b1142763823314">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row109172037123315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1542716387339">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_0000002233726926__p194271438113319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1442703863317">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul1642843817337"><li id="EN-US_TOPIC_0000002233726926__li1142803843320"><p id="EN-US_TOPIC_0000002233726926__p74281638183315"><a name="EN-US_TOPIC_0000002233726926__li1142803843320"></a><a name="li1142803843320"></a><strong id="EN-US_TOPIC_0000002233726926__b18428238183316">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002233726926__li942803833319"><p id="EN-US_TOPIC_0000002233726926__p1342813833314"><a name="EN-US_TOPIC_0000002233726926__li942803833319"></a><a name="li942803833319"></a><strong id="EN-US_TOPIC_0000002233726926__b24281238173318">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002233726926__li104281438153319"><p id="EN-US_TOPIC_0000002233726926__p4428163815339"><a name="EN-US_TOPIC_0000002233726926__li104281438153319"></a><a name="li104281438153319"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002233726926__li7428193811333"><p id="EN-US_TOPIC_0000002233726926__p1842863863315"><a name="EN-US_TOPIC_0000002233726926__li7428193811333"></a><a name="li7428193811333"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002233726926__li124287383332"><p id="EN-US_TOPIC_0000002233726926__p174287385332"><a name="EN-US_TOPIC_0000002233726926__li124287383332"></a><a name="li124287383332"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1391793793316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1042843893317">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p94285381331">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p64281638143312">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row18917173717337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1428133893312">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p84281938173318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p3428133810339">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul74281238173319"><li id="EN-US_TOPIC_0000002233726926__li342873817331"><p id="EN-US_TOPIC_0000002233726926__p34281538173317"><a name="EN-US_TOPIC_0000002233726926__li342873817331"></a><a name="li342873817331"></a><strong id="EN-US_TOPIC_0000002233726926__b64298380339">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li642983883312"><p id="EN-US_TOPIC_0000002233726926__p1842923813314"><a name="EN-US_TOPIC_0000002233726926__li642983883312"></a><a name="li642983883312"></a><strong id="EN-US_TOPIC_0000002233726926__b194297387338">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li164298383337"><p id="EN-US_TOPIC_0000002233726926__p14291382333"><a name="EN-US_TOPIC_0000002233726926__li164298383337"></a><a name="li164298383337"></a><strong id="EN-US_TOPIC_0000002233726926__b134291438123318">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li64291338113315"><p id="EN-US_TOPIC_0000002233726926__p442913813315"><a name="EN-US_TOPIC_0000002233726926__li64291338113315"></a><a name="li64291338113315"></a><strong id="EN-US_TOPIC_0000002233726926__b242916387332">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li64291838163315"><p id="EN-US_TOPIC_0000002233726926__p5429193803320"><a name="EN-US_TOPIC_0000002233726926__li64291838163315"></a><a name="li64291838163315"></a><strong id="EN-US_TOPIC_0000002233726926__b154297388333">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li1842993853320"><p id="EN-US_TOPIC_0000002233726926__p134295389338"><a name="EN-US_TOPIC_0000002233726926__li1842993853320"></a><a name="li1842993853320"></a><strong id="EN-US_TOPIC_0000002233726926__b16429838163312">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_0000002233726926__row16917113733311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p24291389335">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_0000002233726926__p9429138173314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p19429193813334">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row17917937103320"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p0429938203318">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_0000002233726926__p1429103814339">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_0000002233726926__p3429143803319">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul1542915387330"><li id="EN-US_TOPIC_0000002233726926__li64291038133310"><p id="EN-US_TOPIC_0000002233726926__p542916389334"><a name="EN-US_TOPIC_0000002233726926__li64291038133310"></a><a name="li64291038133310"></a><strong id="EN-US_TOPIC_0000002233726926__b184291538193316">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726926__li6429438123318"><p id="EN-US_TOPIC_0000002233726926__p12429183813336"><a name="EN-US_TOPIC_0000002233726926__li6429438123318"></a><a name="li6429438123318"></a><strong id="EN-US_TOPIC_0000002233726926__b2429138193314">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row9917173712337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p184291382335">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_0000002233726926__p13429838193315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1342918387339">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row19180377331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1429163812335">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1342933823311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p14430173853317">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1591863716332"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p2430103817333">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1943018385335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p7430123816331">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul16430163810334"><li id="EN-US_TOPIC_0000002233726926__li184309389336"><p id="EN-US_TOPIC_0000002233726926__p12430143812332"><a name="EN-US_TOPIC_0000002233726926__li184309389336"></a><a name="li184309389336"></a><strong id="EN-US_TOPIC_0000002233726926__b13430338163314">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002233726926__li15430193815330"><p id="EN-US_TOPIC_0000002233726926__p84309383335"><a name="EN-US_TOPIC_0000002233726926__li15430193815330"></a><a name="li15430193815330"></a><strong id="EN-US_TOPIC_0000002233726926__b5430153873312">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row13918123723320"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p114301338153312">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_0000002233726926__p114301738193315">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1943012386337">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row5918737143319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p84309388333">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1443003812334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p2430143873310">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul1143023893315"><li id="EN-US_TOPIC_0000002233726926__li104301138153310"><p id="EN-US_TOPIC_0000002233726926__p184301938123316"><a name="EN-US_TOPIC_0000002233726926__li104301138153310"></a><a name="li104301138153310"></a><strong id="EN-US_TOPIC_0000002233726926__b2430113843318">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002233726926__li54301938163315"><p id="EN-US_TOPIC_0000002233726926__p04301038183313"><a name="EN-US_TOPIC_0000002233726926__li54301938163315"></a><a name="li54301938163315"></a><strong id="EN-US_TOPIC_0000002233726926__b11430193815331">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row139182379337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p19430838103310">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_0000002233726926__p1543083815333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p3430143811333">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726926__b1343063843311">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row991813370334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p154301387332">flavor_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1443013843311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1043023814333">Image resource type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726926__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_0000002233726926__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_0000002233726926__row292863716338"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p1143123811333">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_0000002233726926__p18431183811334">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_0000002233726926__p114311038193311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row1492813773311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p843113818336">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_0000002233726926__p184311381334">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p20431183893310">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1392818376332"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p10431638103313">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p2431123813313">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1343143818337">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_0000002233726926__row492873743316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1643123813312">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1843116389333">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1743116389336">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row10928337113311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p54311838193316">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p13431153817335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p11431123883312">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002233726926__ul164318383334"><li id="EN-US_TOPIC_0000002233726926__li2431153803318"><p id="EN-US_TOPIC_0000002233726926__p2043112382333"><a name="EN-US_TOPIC_0000002233726926__li2431153803318"></a><a name="li2431153803318"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li8431838143313"><p id="EN-US_TOPIC_0000002233726926__p84311138183314"><a name="EN-US_TOPIC_0000002233726926__li8431838143313"></a><a name="li8431838143313"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row10929203714333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p124310388334">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_0000002233726926__p194311388338">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1643111382334">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_0000002233726926__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_0000002233726926__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_0000002233726926__row1693116377338"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p1143103813338">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_0000002233726926__p2043123814338">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_0000002233726926__p1943111383331">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row169311637193316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1043116383339">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p343143815333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1643163863311">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1993163723317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p15431153883311">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p6431238153311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p943173833310">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726926__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_0000002233726926__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_0000002233726926__row893220374339"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p34321538153310">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_0000002233726926__p1043253812335">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_0000002233726926__p134321438143312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row16932637163319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1743223811339">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1443283812337">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p2043273810336">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_0000002233726926__row59328376330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p144321938163314">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p15432183853316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p243214386336">Supported storage types. For details about the differences between the storage types, see"Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002233726926__i1432438163315">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul94327388335"><li id="EN-US_TOPIC_0000002233726926__li1432538113316"><p id="EN-US_TOPIC_0000002233726926__p1343203816339"><a name="EN-US_TOPIC_0000002233726926__li1432538113316"></a><a name="li1432538113316"></a><strong id="EN-US_TOPIC_0000002233726926__b19432138123317">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002233726926__li343283873310"><p id="EN-US_TOPIC_0000002233726926__p1143233810333"><a name="EN-US_TOPIC_0000002233726926__li343283873310"></a><a name="li343283873310"></a><strong id="EN-US_TOPIC_0000002233726926__b184322383331">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1993215370339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p1043243819332">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_0000002233726926__p1043223818334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p3432123893310">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002233726926__b743293810334">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row17932133793319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p13432838123312">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p643293811337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1243243819331">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726926__ul4432193815336"><li id="EN-US_TOPIC_0000002233726926__li44329380335"><p id="EN-US_TOPIC_0000002233726926__p16432203813339"><a name="EN-US_TOPIC_0000002233726926__li44329380335"></a><a name="li44329380335"></a><strong id="EN-US_TOPIC_0000002233726926__b12432133883311">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002233726926__li343243833311"><p id="EN-US_TOPIC_0000002233726926__p343219389331"><a name="EN-US_TOPIC_0000002233726926__li343243833311"></a><a name="li343243833311"></a><strong id="EN-US_TOPIC_0000002233726926__b3432153873314">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002233726926__b5432163893317">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row3932143763316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p15432538203316">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p9432738173318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p13432538183313">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002233726926__b143253820332">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_0000002233726926__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_0000002233726926__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_0000002233726926__row16935237103315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p54324384332">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_0000002233726926__p143293818334">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_0000002233726926__p44323387332">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row1893513733315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p043203843311">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p643216383332"><a href="#EN-US_TOPIC_0000002233726926__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_0000002233726926__p143218384335">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1935123711330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p943283817337">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p15432938163312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p7432153816332">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1393516374339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p34331038103311">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p643393819332">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p1433638143315">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726926__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_0000002233726926__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_0000002233726926__row793723710338"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.12.2.4.1.1"><p id="EN-US_TOPIC_0000002233726926__p18433138153314">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_0000002233726926__p5433238133311">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_0000002233726926__p17433203833318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row159371037123312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.12.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p19433183819335">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.12.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p13433173873315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p144331438143316">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row193715376338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.12.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726926__p2433038203320">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.12.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726926__p1843363812338">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726926__p3433538203318">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726926__section4433538143318"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002233726926__screen1043318387338">GET https://{endpoint}/v1/{project_id}/notebooks</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726926__section4433438153316"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002233726926__p543353813312"><strong id="EN-US_TOPIC_0000002233726926__b194331038203319">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002233726926__p11433183883314">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002233726926__screen134333385333">{
"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_0000002233726926__section343423812333"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726926__en-us_topic_0000002055164050_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002233726926__row1694563763316"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002233726926__p13434123816338">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_0000002233726926__p1543473813336">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726926__row894514376337"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726926__p54341238193311">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726926__p743433853318">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row8945193733311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726926__p54344387339">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726926__p2434153816335">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row1194543723311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726926__p543463843316">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726926__p15434173814334">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726926__row13945637183319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726926__p19434133819339">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726926__p204341538113314">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726926__section1643443803315"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002233726926__p184341038113315">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