forked from docs/doc-exports
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Lai, Weijian <laiweijian4@huawei.com> Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
656 lines
63 KiB
HTML
656 lines
63 KiB
HTML
<a name="EN-US_TOPIC_0000001943967377"></a><a name="EN-US_TOPIC_0000001943967377"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details of a Notebook Instance</h1>
|
|
<div id="body0000001537833672"><div class="section" id="EN-US_TOPIC_0000001943967377__section1649992453317"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001943967377__p184998244339">This API is used to query details about a notebook instance, including its ID, name, flavor, image, status, and accessible URLs.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section249972417339"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000001943967377__p18500202463317">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section1650012244339"><h4 class="sectiontitle">Debugging</h4><p id="EN-US_TOPIC_0000001943967377__p1650015249337">You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section9501624153315"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001943967377__p175014246333">GET /v1/{project_id}/notebooks/{id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__table11503182423319" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row050212410338"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000001943967377__p850316242337">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000001943967377__p1550412483316">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000001943967377__p35051624153318">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000001943967377__p12505202423314">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row45021824103311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943967377__p3506824143312">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943967377__p10506132412333">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943967377__p12506122483314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943967377__p25077248334">Notebook instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row550212414333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001943967377__p105074243331">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001943967377__p050715242333">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001943967377__p20508224163315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001943967377__p4508102483317">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section1508324183316"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000001943967377__p25091124163317">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section1850952412331"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000001943967377__p851062473313"><strong id="EN-US_TOPIC_0000001943967377__b251012443312">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row2511132463310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.3.2.4.1.1"><p id="EN-US_TOPIC_0000001943967377__p1051413244331">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.3.2.4.1.2"><p id="EN-US_TOPIC_0000001943967377__p1951542413335">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.3.2.4.1.3"><p id="EN-US_TOPIC_0000001943967377__p35156240335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row8512124193315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p205155240333">action_progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p351652413333">Array of <a href="#EN-US_TOPIC_0000001943967377__response_JobProgress">JobProgress</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p75165245338">Instance initialization progress.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row205121324203317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p8516162493318">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p105179240332">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p551852412330">Instance description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row45120249334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p13518202483319">endpoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p251918243339">Array of <a href="#EN-US_TOPIC_0000001943967377__response_EndpointsRes">EndpointsRes</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p195196246337">Local IDE (such as PyCharm and vsCode) or SSH client for remotely accessing a notebook instance through SSH.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row14512132443318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1652072473317">fail_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p05201224173310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p5521624103316">Instance failure cause</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row55121242338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p052118241338">flavor</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p14522202417331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p8522162414334">Instance flavor</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row7512192411339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1652382443312">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p19523124163312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p352392420335">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row1951252415335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p20524824133318">image</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1452411249332"><a href="#EN-US_TOPIC_0000001943967377__response_Image">Image</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1525624183310">Instance image</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row4512102433313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p2525192443316">lease</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p6525324193311"><a href="#EN-US_TOPIC_0000001943967377__response_Lease">Lease</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1352612413337">Countdown to automatic instance stop.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row6513324143316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p6526112419331">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p552622417333">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p19527624203314">Instance name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row9513102417330"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1952712403318">pool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p45270246339"><a href="#EN-US_TOPIC_0000001943967377__response_Pool">Pool</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1452822418335">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_0000001943967377__row11513424113312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p10528112453320">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p452852483316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p152912412333">Instance status. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul1153018242334"><li id="EN-US_TOPIC_0000001943967377__li35301024173313"><p id="EN-US_TOPIC_0000001943967377__p15305248335"><a name="EN-US_TOPIC_0000001943967377__li35301024173313"></a><a name="li35301024173313"></a><strong id="EN-US_TOPIC_0000001943967377__b1531724163316">INIT</strong>: The instance is being initialized.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li953142418331"><p id="EN-US_TOPIC_0000001943967377__p18531202416335"><a name="EN-US_TOPIC_0000001943967377__li953142418331"></a><a name="li953142418331"></a><strong id="EN-US_TOPIC_0000001943967377__b175312245337">CREATING</strong>: The instance is being created.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1853232443318"><p id="EN-US_TOPIC_0000001943967377__p2532524173316"><a name="EN-US_TOPIC_0000001943967377__li1853232443318"></a><a name="li1853232443318"></a><strong id="EN-US_TOPIC_0000001943967377__b18532112420337">STARTING</strong>: The instance is starting.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1253211249334"><p id="EN-US_TOPIC_0000001943967377__p18532102412337"><a name="EN-US_TOPIC_0000001943967377__li1253211249334"></a><a name="li1253211249334"></a><strong id="EN-US_TOPIC_0000001943967377__b1953232463317">STOPPING</strong>: The instance is stopping.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1753272411333"><p id="EN-US_TOPIC_0000001943967377__p053342419337"><a name="EN-US_TOPIC_0000001943967377__li1753272411333"></a><a name="li1753272411333"></a><strong id="EN-US_TOPIC_0000001943967377__b2533624123314">DELETING</strong>: The instance is being deleted.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li65331724103315"><p id="EN-US_TOPIC_0000001943967377__p1653311246331"><a name="EN-US_TOPIC_0000001943967377__li65331724103315"></a><a name="li65331724103315"></a><strong id="EN-US_TOPIC_0000001943967377__b2053362414334">RUNNING</strong>: The instance is running.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li35338248335"><p id="EN-US_TOPIC_0000001943967377__p1453372463319"><a name="EN-US_TOPIC_0000001943967377__li35338248335"></a><a name="li35338248335"></a><strong id="EN-US_TOPIC_0000001943967377__b253472413317">STOPPED</strong>: The instance is stopped.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li5534924203312"><p id="EN-US_TOPIC_0000001943967377__p853462414333"><a name="EN-US_TOPIC_0000001943967377__li5534924203312"></a><a name="li5534924203312"></a><strong id="EN-US_TOPIC_0000001943967377__b11534424163310">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li205341124163320"><p id="EN-US_TOPIC_0000001943967377__p1753512411334"><a name="EN-US_TOPIC_0000001943967377__li205341124163320"></a><a name="li205341124163320"></a><strong id="EN-US_TOPIC_0000001943967377__b15357246338">CREATE_FAILED</strong>: Creating the instance failed.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li553542420330"><p id="EN-US_TOPIC_0000001943967377__p1153622410333"><a name="EN-US_TOPIC_0000001943967377__li553542420330"></a><a name="li553542420330"></a><strong id="EN-US_TOPIC_0000001943967377__b4536924203312">START_FAILED</strong>: Starting the instance failed.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li253622483311"><p id="EN-US_TOPIC_0000001943967377__p15536152403317"><a name="EN-US_TOPIC_0000001943967377__li253622483311"></a><a name="li253622483311"></a><strong id="EN-US_TOPIC_0000001943967377__b1353762410334">DELETE_FAILED</strong>: Deleting the instance failed.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li135371424173319"><p id="EN-US_TOPIC_0000001943967377__p19537192412338"><a name="EN-US_TOPIC_0000001943967377__li135371424173319"></a><a name="li135371424173319"></a><strong id="EN-US_TOPIC_0000001943967377__b153717248332">ERROR</strong>: An error occurred.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li753719247334"><p id="EN-US_TOPIC_0000001943967377__p5537224113311"><a name="EN-US_TOPIC_0000001943967377__li753719247334"></a><a name="li753719247334"></a><strong id="EN-US_TOPIC_0000001943967377__b15537112423314">DELETED</strong>: The instance has been deleted.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li5538192414334"><p id="EN-US_TOPIC_0000001943967377__p16538624133320"><a name="EN-US_TOPIC_0000001943967377__li5538192414334"></a><a name="li5538192414334"></a><strong id="EN-US_TOPIC_0000001943967377__b453862413316">FROZEN</strong>: The instance is frozen.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row1351318244338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p453810248336">token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p4538152416339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p353972415335">Token used for notebook authentication</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row55133242335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1539524183318">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p3540152413313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p105407243331">URL for accessing the notebook instance</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row1651392423317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1254072473319">volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p154192413335"><a href="#EN-US_TOPIC_0000001943967377__response_VolumeRes">VolumeRes</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p85413242339">Storage volume</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row1951310242332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p10541192410337">workspace_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1354272411332">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p135421324183311">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000001943967377__b15542182417332">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row20513162413331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p8543192411336">feature</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p15436246335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p654342453314">Instance type. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul4544172419334"><li id="EN-US_TOPIC_0000001943967377__li10544192418335"><p id="EN-US_TOPIC_0000001943967377__p8544724113313"><a name="EN-US_TOPIC_0000001943967377__li10544192418335"></a><a name="li10544192418335"></a><strong id="EN-US_TOPIC_0000001943967377__b19544102412332">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1544124113318"><p id="EN-US_TOPIC_0000001943967377__p1254452417338"><a name="EN-US_TOPIC_0000001943967377__li1544124113318"></a><a name="li1544124113318"></a><strong id="EN-US_TOPIC_0000001943967377__b16544142453311">NOTEBOOK</strong>: billed instance.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943967377__response_JobProgress"></a><a name="response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 3 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row75452024153315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.4.2.4.1.1"><p id="EN-US_TOPIC_0000001943967377__p11546724183310">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.4.2.4.1.2"><p id="EN-US_TOPIC_0000001943967377__p354716245334">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.4.2.4.1.3"><p id="EN-US_TOPIC_0000001943967377__p95471248339">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row7545132417333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p19548162417338">notebook_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p554812249335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p8549132413333">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row13545172413334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p105491024143318">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1855016247335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p165501245338">Job status in a specified step. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul1555032418339"><li id="EN-US_TOPIC_0000001943967377__li1555102453310"><p id="EN-US_TOPIC_0000001943967377__p55511224183314"><a name="EN-US_TOPIC_0000001943967377__li1555102453310"></a><a name="li1555102453310"></a><strong id="EN-US_TOPIC_0000001943967377__b2551124103317">WAITING</strong>: The job is awaiting.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li855116249331"><p id="EN-US_TOPIC_0000001943967377__p19551122418335"><a name="EN-US_TOPIC_0000001943967377__li855116249331"></a><a name="li855116249331"></a><strong id="EN-US_TOPIC_0000001943967377__b6551172413320">PROCESSING</strong>: The job is being processed.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li105511224113317"><p id="EN-US_TOPIC_0000001943967377__p355262463314"><a name="EN-US_TOPIC_0000001943967377__li105511224113317"></a><a name="li105511224113317"></a><strong id="EN-US_TOPIC_0000001943967377__b1555232473310">FAILED</strong>: The job failed.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li15552524113313"><p id="EN-US_TOPIC_0000001943967377__p1455215249332"><a name="EN-US_TOPIC_0000001943967377__li15552524113313"></a><a name="li15552524113313"></a><strong id="EN-US_TOPIC_0000001943967377__b11552122413318">COMPLETED</strong>: The job is complete.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row155461624123313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p4553162412331">step</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p10553324143316">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1355392453312">Job step. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul8554122453319"><li id="EN-US_TOPIC_0000001943967377__li8554524103313"><p id="EN-US_TOPIC_0000001943967377__p355492410336"><a name="EN-US_TOPIC_0000001943967377__li8554524103313"></a><a name="li8554524103313"></a><strong id="EN-US_TOPIC_0000001943967377__b555422414335">1</strong>: Prepare storage.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li195551324173319"><p id="EN-US_TOPIC_0000001943967377__p1255513242331"><a name="EN-US_TOPIC_0000001943967377__li195551324173319"></a><a name="li195551324173319"></a><strong id="EN-US_TOPIC_0000001943967377__b1555510246337">2</strong>: Prepare compute resources.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1455632416336"><p id="EN-US_TOPIC_0000001943967377__p19556152453313"><a name="EN-US_TOPIC_0000001943967377__li1455632416336"></a><a name="li1455632416336"></a><strong id="EN-US_TOPIC_0000001943967377__b9556122413336">3</strong>: Configure the network.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li12556182483318"><p id="EN-US_TOPIC_0000001943967377__p16557122413338"><a name="EN-US_TOPIC_0000001943967377__li12556182483318"></a><a name="li12556182483318"></a><strong id="EN-US_TOPIC_0000001943967377__b1055742413317">4</strong>: Initialize the instance.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row11546524123313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1055715248336">step_description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1055852433313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p15581124123313">Description of a step in a job.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943967377__response_EndpointsRes"></a><a name="response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 4 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row14559102433317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.5.2.4.1.1"><p id="EN-US_TOPIC_0000001943967377__p13560824103319">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.5.2.4.1.2"><p id="EN-US_TOPIC_0000001943967377__p4561192423316">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.5.2.4.1.3"><p id="EN-US_TOPIC_0000001943967377__p7561172433319">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row8559182453312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1556162419336">allowed_access_ips</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p13562824133318">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p456219249330">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_0000001943967377__row18559122416337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p6563182443318">dev_service</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p115631624163320">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p6564102413317">Supported service. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul456415241339"><li id="EN-US_TOPIC_0000001943967377__li3564112415333"><p id="EN-US_TOPIC_0000001943967377__p14564192403312"><a name="EN-US_TOPIC_0000001943967377__li3564112415333"></a><a name="li3564112415333"></a><strong id="EN-US_TOPIC_0000001943967377__b1256514243336">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li15651724113310"><p id="EN-US_TOPIC_0000001943967377__p15565192483316"><a name="EN-US_TOPIC_0000001943967377__li15651724113310"></a><a name="li15651724113310"></a><strong id="EN-US_TOPIC_0000001943967377__b1456513240339">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row555952433313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p9565152411339">ssh_keys</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p556542423318">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p05669242338">List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943967377__response_Image"></a><a name="response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__response_Image" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row356862420339"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.6.2.4.1.1"><p id="EN-US_TOPIC_0000001943967377__p6571024163311">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.6.2.4.1.2"><p id="EN-US_TOPIC_0000001943967377__p35711824133310">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.6.2.4.1.3"><p id="EN-US_TOPIC_0000001943967377__p0572224113319">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row185681524163316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1557212416336">arch</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p95732024183311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p5573122418333">Processor architecture supported by the image. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul175737247334"><li id="EN-US_TOPIC_0000001943967377__li1057392423317"><p id="EN-US_TOPIC_0000001943967377__p1573162413316"><a name="EN-US_TOPIC_0000001943967377__li1057392423317"></a><a name="li1057392423317"></a><strong id="EN-US_TOPIC_0000001943967377__b18574152413316">X86_64</strong>: x86 architecture</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1457452463314"><p id="EN-US_TOPIC_0000001943967377__p1557482403314"><a name="EN-US_TOPIC_0000001943967377__li1457452463314"></a><a name="li1457452463314"></a><strong id="EN-US_TOPIC_0000001943967377__b95746242338">AARCH64</strong>: Arm architecture</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row20568132493314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p557462433315">create_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p14575192403311">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p3575112413313">Specifies the time (UTC ms) when the image is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row456832418332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p557522413312">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p657642423312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p05761247337">Image description with a maximum of 512 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row2568624203317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p857672413310">dev_services</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p19577824123310">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1057772414339">Services supported by the image. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul757762423318"><li id="EN-US_TOPIC_0000001943967377__li1057711244335"><p id="EN-US_TOPIC_0000001943967377__p85771124143312"><a name="EN-US_TOPIC_0000001943967377__li1057711244335"></a><a name="li1057711244335"></a><strong id="EN-US_TOPIC_0000001943967377__b125781424103318">NOTEBOOK</strong>: You can access the notebook instance using HTTPS.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1157842493310"><p id="EN-US_TOPIC_0000001943967377__p1157811249337"><a name="EN-US_TOPIC_0000001943967377__li1157842493310"></a><a name="li1157842493310"></a><strong id="EN-US_TOPIC_0000001943967377__b195788245338">SSH</strong>: You can remotely access the notebook instance from a local IDE through SSH.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row7568824183312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p257842419330">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p2057912243330">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p357922473311">ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format.For details, see <a href="ListImage.html">Querying Supported Images</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row256892483318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1658014242336">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p058016244338">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p75807249335">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_0000001943967377__row1568122443311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p18581122443310">namespace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p4581724173315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p9582924113316">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000001943967377__b1358252493310">Organization Management</strong> page of the SWR console.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row115697245338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p17582024203319">origin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p15583142433310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1583182411331">Image source, which defaults to <strong id="EN-US_TOPIC_0000001943967377__b155831242335">CUSTOMIZE</strong>. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul9584112415330"><li id="EN-US_TOPIC_0000001943967377__li20584142423320"><p id="EN-US_TOPIC_0000001943967377__p158462418332"><a name="EN-US_TOPIC_0000001943967377__li20584142423320"></a><a name="li20584142423320"></a><strong id="EN-US_TOPIC_0000001943967377__b1058472413310">CUSTOMIZE</strong>: user-defined image</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li8584102473316"><p id="EN-US_TOPIC_0000001943967377__p19584124143315"><a name="EN-US_TOPIC_0000001943967377__li8584102473316"></a><a name="li8584102473316"></a><strong id="EN-US_TOPIC_0000001943967377__b158412493313">IMAGE_SAVE</strong>: image saved using a development environment instance</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row456917248339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p95859244334">resource_categories</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1585324113315">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p15585924133320">Flavors supported by the image. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul4586152415336"><li id="EN-US_TOPIC_0000001943967377__li4586162414337"><p id="EN-US_TOPIC_0000001943967377__p155861824103314"><a name="EN-US_TOPIC_0000001943967377__li4586162414337"></a><a name="li4586162414337"></a><strong id="EN-US_TOPIC_0000001943967377__b175861124203314">CPU</strong></p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li10586152416331"><p id="EN-US_TOPIC_0000001943967377__p14586102463319"><a name="EN-US_TOPIC_0000001943967377__li10586152416331"></a><a name="li10586152416331"></a><strong id="EN-US_TOPIC_0000001943967377__b155861024183311">GPU</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row256942413311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p135871224103318">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1158792463318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p25881024103319">Supported image types. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul958842414331"><li id="EN-US_TOPIC_0000001943967377__li10588824123311"><p id="EN-US_TOPIC_0000001943967377__p7588102417333"><a name="EN-US_TOPIC_0000001943967377__li10588824123311"></a><a name="li10588824123311"></a><strong id="EN-US_TOPIC_0000001943967377__b14588122414338">COMMON</strong>: common image</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li9588824153310"><p id="EN-US_TOPIC_0000001943967377__p13588824103313"><a name="EN-US_TOPIC_0000001943967377__li9588824153310"></a><a name="li9588824153310"></a><strong id="EN-US_TOPIC_0000001943967377__b1958972403310">INFERENCE</strong>: image used for inference</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li115891824183313"><p id="EN-US_TOPIC_0000001943967377__p058912473318"><a name="EN-US_TOPIC_0000001943967377__li115891824183313"></a><a name="li115891824183313"></a>TRAIN: image used for training</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1258918246331"><p id="EN-US_TOPIC_0000001943967377__p65898244333"><a name="EN-US_TOPIC_0000001943967377__li1258918246331"></a><a name="li1258918246331"></a>DEV: image used for development and debugging</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li18589182453312"><p id="EN-US_TOPIC_0000001943967377__p3590724133319"><a name="EN-US_TOPIC_0000001943967377__li18589182453312"></a><a name="li18589182453312"></a>UNKNOWN: image whose supported services are not specified</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row15691624183310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1359016243336">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p8590324203317">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p35911424183316">Image size, in unit of KB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row9569132423313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p11591142413315">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p12591162493317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p65921824123318">Image status. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul18592142418331"><li id="EN-US_TOPIC_0000001943967377__li115921124103320"><p id="EN-US_TOPIC_0000001943967377__p1959292418331"><a name="EN-US_TOPIC_0000001943967377__li115921124103320"></a><a name="li115921124103320"></a><strong id="EN-US_TOPIC_0000001943967377__b35921424163313">INIT</strong>: The image is being initialized.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1159252411337"><p id="EN-US_TOPIC_0000001943967377__p1059352493319"><a name="EN-US_TOPIC_0000001943967377__li1159252411337"></a><a name="li1159252411337"></a><strong id="EN-US_TOPIC_0000001943967377__b2593182419335">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1593202413335"><p id="EN-US_TOPIC_0000001943967377__p459392423314"><a name="EN-US_TOPIC_0000001943967377__li1593202413335"></a><a name="li1593202413335"></a><strong id="EN-US_TOPIC_0000001943967377__b2059362410337">CREATE_FAILED</strong>: Saving the image failed.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1459317243332"><p id="EN-US_TOPIC_0000001943967377__p659382418339"><a name="EN-US_TOPIC_0000001943967377__li1459317243332"></a><a name="li1459317243332"></a><strong id="EN-US_TOPIC_0000001943967377__b1559313246333">ERROR</strong>: An error occurs.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li1594824113312"><p id="EN-US_TOPIC_0000001943967377__p17594192423315"><a name="EN-US_TOPIC_0000001943967377__li1594824113312"></a><a name="li1594824113312"></a><strong id="EN-US_TOPIC_0000001943967377__b659462453315">DELETED</strong>: The image has been deleted.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li12594112416338"><p id="EN-US_TOPIC_0000001943967377__p115941924163314"><a name="EN-US_TOPIC_0000001943967377__li12594112416338"></a><a name="li12594112416338"></a><strong id="EN-US_TOPIC_0000001943967377__b16594132483310">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_0000001943967377__row2569192410332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1759412403311">status_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p135951724113318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p135953244337">Build information during image saving</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row195696245339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p10169162573317">support_res_categories</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1017018251339">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p151701425113316">Flavors supported by the image. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul1817082583312"><li id="EN-US_TOPIC_0000001943967377__li11709252332"><p id="EN-US_TOPIC_0000001943967377__p71701325203310"><a name="EN-US_TOPIC_0000001943967377__li11709252332"></a><a name="li11709252332"></a><strong id="EN-US_TOPIC_0000001943967377__b16170192523313">CPU</strong></p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li317022543315"><p id="EN-US_TOPIC_0000001943967377__p12170132516336"><a name="EN-US_TOPIC_0000001943967377__li317022543315"></a><a name="li317022543315"></a><strong id="EN-US_TOPIC_0000001943967377__b2170325173312">GPU</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row175706245330"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1017182513337">swr_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p17171525163313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p4171102503312">SWR image address</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row9570102433310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p9171425183312">tag</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p121711125193312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p6171625123319">Image tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row6570192473314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p4171142543318">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1717112533312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p151716250330">Image type. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul1617162563317"><li id="EN-US_TOPIC_0000001943967377__li117132512330"><p id="EN-US_TOPIC_0000001943967377__p111711025123315"><a name="EN-US_TOPIC_0000001943967377__li117132512330"></a><a name="li117132512330"></a><strong id="EN-US_TOPIC_0000001943967377__b161713255333">BUILD_IN</strong>: built-in system image</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li417252512331"><p id="EN-US_TOPIC_0000001943967377__p51721625133319"><a name="EN-US_TOPIC_0000001943967377__li417252512331"></a><a name="li417252512331"></a><strong id="EN-US_TOPIC_0000001943967377__b13172425183314">DEDICATED</strong>: private image</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row8570192413314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p121727256337">update_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p20172425133310">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p161721425163320">Specifies the time (UTC ms) when the image was last updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row45701424173314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p151727254338">visibility</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1172625203311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p20172325133313">Image visibility. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul1917242516331"><li id="EN-US_TOPIC_0000001943967377__li20172112520332"><p id="EN-US_TOPIC_0000001943967377__p1217202583310"><a name="EN-US_TOPIC_0000001943967377__li20172112520332"></a><a name="li20172112520332"></a><strong id="EN-US_TOPIC_0000001943967377__b16172172517334">PRIVATE</strong>: private image</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li2172192511338"><p id="EN-US_TOPIC_0000001943967377__p1017392513339"><a name="EN-US_TOPIC_0000001943967377__li2172192511338"></a><a name="li2172192511338"></a><strong id="EN-US_TOPIC_0000001943967377__b19173102518330">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row8570124163315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p17173925123310">workspace_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p01731625113315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p4173102513336">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000001943967377__b11173102523314">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943967377__response_Lease"></a><a name="response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__response_Lease" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row1661132416338"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.7.2.4.1.1"><p id="EN-US_TOPIC_0000001943967377__p817322519335">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.7.2.4.1.2"><p id="EN-US_TOPIC_0000001943967377__p9173325183313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.7.2.4.1.3"><p id="EN-US_TOPIC_0000001943967377__p6173725143318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row9611122411338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1217312523312">create_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1917422503319">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p3174425173312">Time (UTC) when the instance is created, accurate to millisecond.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row206114249333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p617452523313">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p0174172515336">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p81749255339">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_0000001943967377__row361222483319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p10174125103311">enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1517472516331">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1217492573316">Whether to enable auto stop of the instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row16124242335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p617462512332">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p111741025163316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1174112513334">Indicates the automatic stop type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row1261242414338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p19174192512333">update_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p31751425173311">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1917542553319">Time (UTC) when the instance is last updated (excluding the keepalive heartbeat time), accurate to millisecond.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943967377__response_Pool"></a><a name="response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__response_Pool" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row19617524153318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.8.2.4.1.1"><p id="EN-US_TOPIC_0000001943967377__p171751525143310">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.8.2.4.1.2"><p id="EN-US_TOPIC_0000001943967377__p1517592520339">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.8.2.4.1.3"><p id="EN-US_TOPIC_0000001943967377__p9176182516338">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row12617152412335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p151761625193314">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p161761625133314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p13176525153311">ID of a dedicated resource pool</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row19617152418332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p101761425183313">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p13176132523315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1176225173317">Name of a dedicated resource pool</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001943967377__response_VolumeRes"></a><a name="response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 8 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row3621202483315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.9.2.4.1.1"><p id="EN-US_TOPIC_0000001943967377__p15177525183313">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.9.2.4.1.2"><p id="EN-US_TOPIC_0000001943967377__p1617717250336">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.9.2.4.1.3"><p id="EN-US_TOPIC_0000001943967377__p717712252338">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row1662172415335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p41775252338">capacity</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p417792543319">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p71776257335">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_0000001943967377__row1262112473317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p817711252334">category</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p13177152503320">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p5177152513318">Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000001943967377__i5177122503314">User Guide</em>. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul15177125183319"><li id="EN-US_TOPIC_0000001943967377__li161771625133317"><p id="EN-US_TOPIC_0000001943967377__p417712253336"><a name="EN-US_TOPIC_0000001943967377__li161771625133317"></a><a name="li161771625133317"></a><strong id="EN-US_TOPIC_0000001943967377__b171772025163311">EFS</strong>: Scalable File Service, which is the default storage</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li19178182516334"><p id="EN-US_TOPIC_0000001943967377__p417812519334"><a name="EN-US_TOPIC_0000001943967377__li19178182516334"></a><a name="li19178182516334"></a><strong id="EN-US_TOPIC_0000001943967377__b1317811255336">EVS</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row762252417335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p8178125103316">mount_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1017818256339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p14178825113319">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000001943967377__b12178525113312">/home/ma-user/work/</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row136221624153314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p17178152512333">ownership</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p4178132523311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p1517882513332">Owner to which the resource belongs. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000001943967377__ul7178102553317"><li id="EN-US_TOPIC_0000001943967377__li617813251334"><p id="EN-US_TOPIC_0000001943967377__p317832513330"><a name="EN-US_TOPIC_0000001943967377__li617813251334"></a><a name="li617813251334"></a><strong id="EN-US_TOPIC_0000001943967377__b3178102513337">MANAGED</strong>: Resources are managed by service.</p>
|
|
</li><li id="EN-US_TOPIC_0000001943967377__li2178132511333"><p id="EN-US_TOPIC_0000001943967377__p41786256333"><a name="EN-US_TOPIC_0000001943967377__li2178132511333"></a><a name="li2178132511333"></a><strong id="EN-US_TOPIC_0000001943967377__b2178425113313">DEDICATED</strong>: Resources are managed by user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000001943967377__b18178122553312">EFS</strong>.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row3622102413336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1617892573317">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001943967377__p217942543313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001943967377__p917917252332">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000001943967377__b1817972511336">RESIZING</strong> during capacity expansion and does not affect the instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section4179132593311"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000001943967377__p517913258331">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section3179112563311"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000001943967377__p131798251335"><strong id="EN-US_TOPIC_0000001943967377__b111791252332">Status code: 200</strong></p>
|
|
<p id="EN-US_TOPIC_0000001943967377__p918020253337">OK</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001943967377__screen01808251337">{
|
|
"description" : "api-test",
|
|
"feature" : "NOTEBOOK",
|
|
"flavor" : "modelarts.vm.cpu.2u",
|
|
"id" : "f9937afa-631e-4a8f-a8f7-3b6c800585f0",
|
|
"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.1.B007_V2",
|
|
"type" : "BUILD_IN"
|
|
},
|
|
"lease" : {
|
|
"create_at" : 1638778344300,
|
|
"duration" : 3600000,
|
|
"enable" : true,
|
|
"update_at" : 1638778344300
|
|
},
|
|
"name" : "notebooks_test",
|
|
"status" : "CREATING",
|
|
"token" : "7b22482a-a4cb-4b46-e3b3-6a793a47967e",
|
|
"url" : "https://authoring-modelarts-xxxxx.com/f9937afa-631e-4a8f-a8f7-3b6c800585f0/lab",
|
|
"workspace_id" : "0"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section1718116252334"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001943967377__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001943967377__row19635152410330"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.9.2.1.3.1.1"><p id="EN-US_TOPIC_0000001943967377__p41828253337">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.9.2.1.3.1.2"><p id="EN-US_TOPIC_0000001943967377__p1518212253331">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001943967377__row4635142483314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001943967377__p1182525193317">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1218216254334">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row46353242334"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001943967377__p318210259332">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001943967377__p1218212512333">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row46351724113312"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001943967377__p11182325163319">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001943967377__p71821325163316">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001943967377__row66351242334"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.9.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001943967377__p121831725163315">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.9.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001943967377__p10183202519337">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001943967377__section14183122523317"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000001943967377__p71839256338">See <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="notebook.html">DevEnviron (New Version)</a></div>
|
|
</div>
|
|
</div>
|
|
|