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

770 lines
73 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002233726930"></a><a name="EN-US_TOPIC_0000002233726930"></a>
<h1 class="topictitle1">Stopping a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002233726930__section148351157203618"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002233726930__p583519576368">This API is used to stop a notebook instance.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726930__section483510576367"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002233726930__p1835195715363">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726930__section583645712362"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002233726930__p168361457143615">POST /v1/{project_id}/notebooks/{id}/stop</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__table7837165710368" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row16836757163610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002233726930__p15837185719369">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_0000002233726930__p1983775733617">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_0000002233726930__p1183725723610">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_0000002233726930__p1583805773618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row1483620572360"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726930__p13838145717367">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726930__p2083865713611">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726930__p4838115753617">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726930__p128389576362">Notebook instance ID, which can be obtained by calling the API for querying the notebook instance list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row128368577368"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726930__p0838457113615">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_0000002233726930__p1383895793619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726930__p128384577369">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726930__p58391557183615">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_0000002233726930__section5839757113615"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002233726930__p48391257193617">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726930__section188392573365"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002233726930__p883935743616"><strong id="EN-US_TOPIC_0000002233726930__b15839195793611">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_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_0000002233726930__row48405576367"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p1884216574364">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_0000002233726930__p184205773610">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_0000002233726930__p1184214577368">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row4840205733613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p6842257113613">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p58421957113612">Array of <a href="#EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_JobProgress">JobProgress</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p198424579362">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row12840105783616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p084305710368">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p17843165719365">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p19843457143613">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1884085718367"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p19843357163614">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p178431574362">Array of <a href="#EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_EndpointsRes">EndpointsRes</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p884318575363">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_0000002233726930__row684014575368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p5843657133615">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p12844195763614">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p684411571364">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1184035713611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p08445571369">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p17844125716365">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p8844185773619">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row384013578369"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p9844125783613">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p584420578363">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p1084411575366">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1840157133619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p178457578364">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1284510571369"><a href="#EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_Image">Image</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p5845145743610">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1684035753617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p6845195773614">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p984517578364"><a href="#EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_Lease">Lease</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p1384565753610">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row984025714364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p19846357203613">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1384617571368">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p11846105723616">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row19841175718368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p785917577367">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p78607571364"><a href="#EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_Pool">Pool</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p2086012577365">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_0000002233726930__row9841757193611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p9860957173610">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p12861185710363">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p6861155712367">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul19861557153618"><li id="EN-US_TOPIC_0000002233726930__li10861125703613"><p id="EN-US_TOPIC_0000002233726930__p108611457103616"><a name="EN-US_TOPIC_0000002233726930__li10861125703613"></a><a name="li10861125703613"></a><strong id="EN-US_TOPIC_0000002233726930__b118676573368">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li38671457193614"><p id="EN-US_TOPIC_0000002233726930__p13867155793611"><a name="EN-US_TOPIC_0000002233726930__li38671457193614"></a><a name="li38671457193614"></a><strong id="EN-US_TOPIC_0000002233726930__b6867357113616">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li58671657143613"><p id="EN-US_TOPIC_0000002233726930__p1986785711364"><a name="EN-US_TOPIC_0000002233726930__li58671657143613"></a><a name="li58671657143613"></a><strong id="EN-US_TOPIC_0000002233726930__b886705713614">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li12868145719364"><p id="EN-US_TOPIC_0000002233726930__p108681857173619"><a name="EN-US_TOPIC_0000002233726930__li12868145719364"></a><a name="li12868145719364"></a><strong id="EN-US_TOPIC_0000002233726930__b10868657183611">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li18868205712367"><p id="EN-US_TOPIC_0000002233726930__p13868457103619"><a name="EN-US_TOPIC_0000002233726930__li18868205712367"></a><a name="li18868205712367"></a><strong id="EN-US_TOPIC_0000002233726930__b3868175710363">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li886855716363"><p id="EN-US_TOPIC_0000002233726930__p786810572365"><a name="EN-US_TOPIC_0000002233726930__li886855716363"></a><a name="li886855716363"></a><strong id="EN-US_TOPIC_0000002233726930__b086818573362">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li14868155714364"><p id="EN-US_TOPIC_0000002233726930__p1486865713363"><a name="EN-US_TOPIC_0000002233726930__li14868155714364"></a><a name="li14868155714364"></a><strong id="EN-US_TOPIC_0000002233726930__b18874155733615">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li2874357153618"><p id="EN-US_TOPIC_0000002233726930__p12874115714367"><a name="EN-US_TOPIC_0000002233726930__li2874357153618"></a><a name="li2874357153618"></a><strong id="EN-US_TOPIC_0000002233726930__b58748571369">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li087485753614"><p id="EN-US_TOPIC_0000002233726930__p11874135783619"><a name="EN-US_TOPIC_0000002233726930__li087485753614"></a><a name="li087485753614"></a><strong id="EN-US_TOPIC_0000002233726930__b1687495714363">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li148753579365"><p id="EN-US_TOPIC_0000002233726930__p17875057123615"><a name="EN-US_TOPIC_0000002233726930__li148753579365"></a><a name="li148753579365"></a><strong id="EN-US_TOPIC_0000002233726930__b128750571369">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li28751357183618"><p id="EN-US_TOPIC_0000002233726930__p1387585712364"><a name="EN-US_TOPIC_0000002233726930__li28751357183618"></a><a name="li28751357183618"></a><strong id="EN-US_TOPIC_0000002233726930__b20875857103613">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li78759572366"><p id="EN-US_TOPIC_0000002233726930__p1687535743612"><a name="EN-US_TOPIC_0000002233726930__li78759572366"></a><a name="li78759572366"></a><strong id="EN-US_TOPIC_0000002233726930__b787575715363">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li3875175793612"><p id="EN-US_TOPIC_0000002233726930__p8876457203615"><a name="EN-US_TOPIC_0000002233726930__li3875175793612"></a><a name="li3875175793612"></a><strong id="EN-US_TOPIC_0000002233726930__b1887675714366">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li20881155713368"><p id="EN-US_TOPIC_0000002233726930__p1788195763614"><a name="EN-US_TOPIC_0000002233726930__li20881155713368"></a><a name="li20881155713368"></a><strong id="EN-US_TOPIC_0000002233726930__b188195743617">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row4841195793612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1888219574368">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p18822576361">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p10882165710366">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row178411357143616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p7882205723619">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p138835578365">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p198831957113618">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row13841125715361"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p788545753610">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1888685733614"><a href="#EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_VolumeRes">VolumeRes</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p78865577365">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row108411573368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p5887195753615">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p5887155711361">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p168871571368">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726930__b10887257183612">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row4841857153612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p98871857183616">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p11888125714361">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p68887577360">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul128881257133611"><li id="EN-US_TOPIC_0000002233726930__li1288805753620"><p id="EN-US_TOPIC_0000002233726930__p788813570368"><a name="EN-US_TOPIC_0000002233726930__li1288805753620"></a><a name="li1288805753620"></a><strong id="EN-US_TOPIC_0000002233726930__b198891557193617">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li12889657153619"><p id="EN-US_TOPIC_0000002233726930__p18889185710364"><a name="EN-US_TOPIC_0000002233726930__li12889657153619"></a><a name="li12889657153619"></a><strong id="EN-US_TOPIC_0000002233726930__b20889457113610">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row18841145710368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p3889257103619">billing_items</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p58893577366">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p1788935713611">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002233726930__p13889135783618">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726930__p19912857123615">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726930__p16912185753610">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row15841657143613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p191325712362">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1991313572366"><a href="#EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_user">user</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p1391355715365">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_JobProgress"></a><a name="en-us_topic_0000002055322414_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 3 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row1191414579364"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p1491575710361">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_0000002233726930__p0916157173614">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_0000002233726930__p5916165723618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row8914195710364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p16916155710366">notebook_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p199167577363">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p4917155793618">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row2914155718361"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p391745763615">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p491735710365">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p3917155710360">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul691725715363"><li id="EN-US_TOPIC_0000002233726930__li2917957173611"><p id="EN-US_TOPIC_0000002233726930__p14918165719365"><a name="EN-US_TOPIC_0000002233726930__li2917957173611"></a><a name="li2917957173611"></a><strong id="EN-US_TOPIC_0000002233726930__b1291875717365">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li13918175716364"><p id="EN-US_TOPIC_0000002233726930__p1291810576360"><a name="EN-US_TOPIC_0000002233726930__li13918175716364"></a><a name="li13918175716364"></a><strong id="EN-US_TOPIC_0000002233726930__b19181657133619">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li3918105716369"><p id="EN-US_TOPIC_0000002233726930__p13918165773615"><a name="EN-US_TOPIC_0000002233726930__li3918105716369"></a><a name="li3918105716369"></a><strong id="EN-US_TOPIC_0000002233726930__b149182574368">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li691818572360"><p id="EN-US_TOPIC_0000002233726930__p11918115716369"><a name="EN-US_TOPIC_0000002233726930__li691818572360"></a><a name="li691818572360"></a><strong id="EN-US_TOPIC_0000002233726930__b5918115723615">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row11914165718364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1191835718360">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p189191057103611">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p20919185720367">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul791955713361"><li id="EN-US_TOPIC_0000002233726930__li11919135753616"><p id="EN-US_TOPIC_0000002233726930__p12919115713361"><a name="EN-US_TOPIC_0000002233726930__li11919135753616"></a><a name="li11919135753616"></a><strong id="EN-US_TOPIC_0000002233726930__b1991955711366">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li9919057133617"><p id="EN-US_TOPIC_0000002233726930__p39191957173614"><a name="EN-US_TOPIC_0000002233726930__li9919057133617"></a><a name="li9919057133617"></a><strong id="EN-US_TOPIC_0000002233726930__b129193573369">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li99198571364"><p id="EN-US_TOPIC_0000002233726930__p991955703613"><a name="EN-US_TOPIC_0000002233726930__li99198571364"></a><a name="li99198571364"></a><strong id="EN-US_TOPIC_0000002233726930__b12919145743619">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li17919135753611"><p id="EN-US_TOPIC_0000002233726930__p1291965773614"><a name="EN-US_TOPIC_0000002233726930__li17919135753611"></a><a name="li17919135753611"></a><strong id="EN-US_TOPIC_0000002233726930__b59191257203611">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row8915205716361"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p8919557143618">step_description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1492015712363">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p189201857173619">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_EndpointsRes"></a><a name="en-us_topic_0000002055322414_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 4 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row09201557123610"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p1921195733616">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_0000002233726930__p19211957173615">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_0000002233726930__p1592135703619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row3920157113615"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p129211957133616">allowed_access_ips</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p17921757193617">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p092116579364">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_0000002233726930__row992095713364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p13921205718360">dev_service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p792165703618">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p792112577366">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul3922457133613"><li id="EN-US_TOPIC_0000002233726930__li12922145753615"><p id="EN-US_TOPIC_0000002233726930__p19922135710364"><a name="EN-US_TOPIC_0000002233726930__li12922145753615"></a><a name="li12922145753615"></a><strong id="EN-US_TOPIC_0000002233726930__b129224573363">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li1892265753612"><p id="EN-US_TOPIC_0000002233726930__p9922257183612"><a name="EN-US_TOPIC_0000002233726930__li1892265753612"></a><a name="li1892265753612"></a><strong id="EN-US_TOPIC_0000002233726930__b199224575364">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row29201157163613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p179226577364">ssh_keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p6922155753613">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p192285793610">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_0000002233726930__row1392015783612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p192265773611">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p9922205783617">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p0922135710364">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul12922105713610"><li id="EN-US_TOPIC_0000002233726930__li792345713615"><p id="EN-US_TOPIC_0000002233726930__p1923757163612"><a name="EN-US_TOPIC_0000002233726930__li792345713615"></a><a name="li792345713615"></a><strong id="EN-US_TOPIC_0000002233726930__b1292385714367">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li2923175793618"><p id="EN-US_TOPIC_0000002233726930__p1692317570364"><a name="EN-US_TOPIC_0000002233726930__li2923175793618"></a><a name="li2923175793618"></a><strong id="EN-US_TOPIC_0000002233726930__b1292345710363">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row17920175716365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p5923135718364">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p8923155793620">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p8923115713620">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_Image"></a><a name="en-us_topic_0000002055322414_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_Image" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row2092485718363"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p1792612571363">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_0000002233726930__p2926185703614">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_0000002233726930__p49261575364">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row159247575367"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p18926145712365">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p10927125711360">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p4927157193614">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul2092713575365"><li id="EN-US_TOPIC_0000002233726930__li9927105719362"><p id="EN-US_TOPIC_0000002233726930__p39279574367"><a name="EN-US_TOPIC_0000002233726930__li9927105719362"></a><a name="li9927105719362"></a><strong id="EN-US_TOPIC_0000002233726930__b159271578366">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002233726930__li992715572369"><p id="EN-US_TOPIC_0000002233726930__p7927957123613"><a name="EN-US_TOPIC_0000002233726930__li992715572369"></a><a name="li992715572369"></a><strong id="EN-US_TOPIC_0000002233726930__b19927457133610">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1992511572369"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p792717578361">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p159272574367">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p99287577360">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row39251657103619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p149285575362">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p592895713612">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p2928457173615">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row09251357113618"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p592815710362">dev_services</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1992895773617">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_0000002233726930__p18928165733612">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul09281057143619"><li id="EN-US_TOPIC_0000002233726930__li792818577369"><p id="EN-US_TOPIC_0000002233726930__p09280574364"><a name="EN-US_TOPIC_0000002233726930__li792818577369"></a><a name="li792818577369"></a><strong id="EN-US_TOPIC_0000002233726930__b199281357173617">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li3928135753614"><p id="EN-US_TOPIC_0000002233726930__p1192805711361"><a name="EN-US_TOPIC_0000002233726930__li3928135753614"></a><a name="li3928135753614"></a><strong id="EN-US_TOPIC_0000002233726930__b8929185723613">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_0000002233726930__row1992515753613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p109299578363">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p9929457203612">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p2092995713614">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_0000002233726930__row19251557143615"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p6929175716365">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p13929135717361">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p119291657103611">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_0000002233726930__row59259571369"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p19929105713363">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1992965713616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p5929115711367">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002233726930__b192965713367">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1292585715363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p11929457133619">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p10930657163612">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p1793020579361">Image source, which defaults to <strong id="EN-US_TOPIC_0000002233726930__b5930125716369">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul1493085753619"><li id="EN-US_TOPIC_0000002233726930__li15930195717363"><p id="EN-US_TOPIC_0000002233726930__p09302577361"><a name="EN-US_TOPIC_0000002233726930__li15930195717363"></a><a name="li15930195717363"></a><strong id="EN-US_TOPIC_0000002233726930__b9930145710366">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002233726930__li11930105793613"><p id="EN-US_TOPIC_0000002233726930__p18930135743615"><a name="EN-US_TOPIC_0000002233726930__li11930105793613"></a><a name="li11930105793613"></a><strong id="EN-US_TOPIC_0000002233726930__b1093075753613">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row292535763614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p3930155712368">resource_categories</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p493016579365">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_0000002233726930__p793065715366">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul293035733613"><li id="EN-US_TOPIC_0000002233726930__li20931957153619"><p id="EN-US_TOPIC_0000002233726930__p1493105717361"><a name="EN-US_TOPIC_0000002233726930__li20931957153619"></a><a name="li20931957153619"></a><strong id="EN-US_TOPIC_0000002233726930__b19311657163617">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726930__li15931257143613"><p id="EN-US_TOPIC_0000002233726930__p149311457143612"><a name="EN-US_TOPIC_0000002233726930__li15931257143613"></a><a name="li15931257143613"></a><strong id="EN-US_TOPIC_0000002233726930__b13931135719364">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row892516576365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p13931115783610">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1193195753620">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p193114574367">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul1931165713365"><li id="EN-US_TOPIC_0000002233726930__li1693115711365"><p id="EN-US_TOPIC_0000002233726930__p893117579362"><a name="EN-US_TOPIC_0000002233726930__li1693115711365"></a><a name="li1693115711365"></a><strong id="EN-US_TOPIC_0000002233726930__b1593195763619">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002233726930__li593117574361"><p id="EN-US_TOPIC_0000002233726930__p149316574363"><a name="EN-US_TOPIC_0000002233726930__li593117574361"></a><a name="li593117574361"></a><strong id="EN-US_TOPIC_0000002233726930__b893165713368">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002233726930__li1931125714363"><p id="EN-US_TOPIC_0000002233726930__p493113575361"><a name="EN-US_TOPIC_0000002233726930__li1931125714363"></a><a name="li1931125714363"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002233726930__li27011589366"><p id="EN-US_TOPIC_0000002233726930__p7716580363"><a name="EN-US_TOPIC_0000002233726930__li27011589366"></a><a name="li27011589366"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002233726930__li171185843617"><p id="EN-US_TOPIC_0000002233726930__p071145843617"><a name="EN-US_TOPIC_0000002233726930__li171185843617"></a><a name="li171185843617"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1992518575363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p271165833618">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p57165819363">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p77175815361">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row792545714362"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p271158153613">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p77115588363">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p1571205815369">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul371258103613"><li id="EN-US_TOPIC_0000002233726930__li2071858103617"><p id="EN-US_TOPIC_0000002233726930__p1711858153610"><a name="EN-US_TOPIC_0000002233726930__li2071858103617"></a><a name="li2071858103617"></a><strong id="EN-US_TOPIC_0000002233726930__b171358143616">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li1711258143617"><p id="EN-US_TOPIC_0000002233726930__p2711758103613"><a name="EN-US_TOPIC_0000002233726930__li1711258143617"></a><a name="li1711258143617"></a><strong id="EN-US_TOPIC_0000002233726930__b167195883615">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li071158193619"><p id="EN-US_TOPIC_0000002233726930__p187155815367"><a name="EN-US_TOPIC_0000002233726930__li071158193619"></a><a name="li071158193619"></a><strong id="EN-US_TOPIC_0000002233726930__b4711658193610">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li37175893611"><p id="EN-US_TOPIC_0000002233726930__p107115813619"><a name="EN-US_TOPIC_0000002233726930__li37175893611"></a><a name="li37175893611"></a><strong id="EN-US_TOPIC_0000002233726930__b671135813613">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li157175823611"><p id="EN-US_TOPIC_0000002233726930__p67155816361"><a name="EN-US_TOPIC_0000002233726930__li157175823611"></a><a name="li157175823611"></a><strong id="EN-US_TOPIC_0000002233726930__b137145818369">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li4719583361"><p id="EN-US_TOPIC_0000002233726930__p1671195812367"><a name="EN-US_TOPIC_0000002233726930__li4719583361"></a><a name="li4719583361"></a><strong id="EN-US_TOPIC_0000002233726930__b177195811367">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_0000002233726930__row6925457153610"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1711058103614">status_message</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p47135873610">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p2719584368">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row199259579360"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p9711958193618">support_res_categories</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p471115819367">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_0000002233726930__p871115813360">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul1371135818365"><li id="EN-US_TOPIC_0000002233726930__li2718581365"><p id="EN-US_TOPIC_0000002233726930__p17195823611"><a name="EN-US_TOPIC_0000002233726930__li2718581365"></a><a name="li2718581365"></a><strong id="EN-US_TOPIC_0000002233726930__b147165813618">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726930__li1471115811364"><p id="EN-US_TOPIC_0000002233726930__p137110585362"><a name="EN-US_TOPIC_0000002233726930__li1471115811364"></a><a name="li1471115811364"></a><strong id="EN-US_TOPIC_0000002233726930__b1671558103618">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row179256579364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p187175813613">swr_path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1472458143616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p11723584369">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row199251957143617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1272175817367">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p10723585368">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p1972115883617">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row19925125733618"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1572145853610">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1872155893616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p3725583360">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul4721558173611"><li id="EN-US_TOPIC_0000002233726930__li1172125816361"><p id="EN-US_TOPIC_0000002233726930__p17218586369"><a name="EN-US_TOPIC_0000002233726930__li1172125816361"></a><a name="li1172125816361"></a><strong id="EN-US_TOPIC_0000002233726930__b1672458153619">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002233726930__li7721258123611"><p id="EN-US_TOPIC_0000002233726930__p47235883618"><a name="EN-US_TOPIC_0000002233726930__li7721258123611"></a><a name="li7721258123611"></a><strong id="EN-US_TOPIC_0000002233726930__b1272125803614">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row89251357103616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p107218586366">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p8721558133616">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p67217588367">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row109251577363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1972165815368">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1072115812365">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p187285833614">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul137255817367"><li id="EN-US_TOPIC_0000002233726930__li147210584366"><p id="EN-US_TOPIC_0000002233726930__p572205813615"><a name="EN-US_TOPIC_0000002233726930__li147210584366"></a><a name="li147210584366"></a><strong id="EN-US_TOPIC_0000002233726930__b107215863611">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002233726930__li27265863613"><p id="EN-US_TOPIC_0000002233726930__p1072358123611"><a name="EN-US_TOPIC_0000002233726930__li27265863613"></a><a name="li27265863613"></a><strong id="EN-US_TOPIC_0000002233726930__b17217586366">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row29251357173617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p157235863620">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p17721589363">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p07265833611">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726930__b972258203611">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row12926195717368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1572165893616">flavor_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1721658143618">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p18721258133618">Image resource type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_Lease"></a><a name="en-us_topic_0000002055322414_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row13937105743616"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p18734584366">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_0000002233726930__p197385893610">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_0000002233726930__p187315813369">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row199374575364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p47355823613">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_0000002233726930__p173165817362">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p19731558133616">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row10937105720362"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1273105893614">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p19731358193615">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p12731958153616">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_0000002233726930__row6937157123620"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p6731958193615">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p19731158123613">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p19731058133611">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row11937125713610"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p77345818364">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p97312588367">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p19736584369">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002233726930__ul17315883620"><li id="EN-US_TOPIC_0000002233726930__li15731058183614"><p id="EN-US_TOPIC_0000002233726930__p1973125815369"><a name="EN-US_TOPIC_0000002233726930__li15731058183614"></a><a name="li15731058183614"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li473105819361"><p id="EN-US_TOPIC_0000002233726930__p973105815369"><a name="EN-US_TOPIC_0000002233726930__li473105819361"></a><a name="li473105819361"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row7937457163617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p273165816364">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_0000002233726930__p1073658163613">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p27345893618">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_0000002233726930__en-us_topic_0000002055322414_response_Pool"></a><a name="en-us_topic_0000002055322414_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row1593915723618"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p17318580368">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_0000002233726930__p20731558183613">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_0000002233726930__p8734580363">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row3939457153620"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p18731158193613">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1073105811365">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p27317581366">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row2939165718368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p773125812364">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p207375893613">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p19731158123612">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_VolumeRes"></a><a name="en-us_topic_0000002055322414_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 8 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row2940557123620"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p1273958103618">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_0000002233726930__p12741958163619">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_0000002233726930__p1874175817364">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row89409577365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1474145803617">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p137445815360">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p17744585362">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_0000002233726930__row1594005763618"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p11741958113618">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1074858143618">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p4742058123612">Supported storage types. For details about the differences between the storage types, see"Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002233726930__i1674165818363">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul1674205810366"><li id="EN-US_TOPIC_0000002233726930__li1374158143614"><p id="EN-US_TOPIC_0000002233726930__p67425811367"><a name="EN-US_TOPIC_0000002233726930__li1374158143614"></a><a name="li1374158143614"></a><strong id="EN-US_TOPIC_0000002233726930__b1474058183615">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002233726930__li1374185817369"><p id="EN-US_TOPIC_0000002233726930__p18741458173614"><a name="EN-US_TOPIC_0000002233726930__li1374185817369"></a><a name="li1374185817369"></a><strong id="EN-US_TOPIC_0000002233726930__b1574658193610">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row10940185720363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p174458203611">mount_path</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1374175819367">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p157412581369">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002233726930__b1674115803612">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1940757123614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p5743589365">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p15740588369">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p13747585361">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726930__ul774145873613"><li id="EN-US_TOPIC_0000002233726930__li5748588366"><p id="EN-US_TOPIC_0000002233726930__p57455873614"><a name="EN-US_TOPIC_0000002233726930__li5748588366"></a><a name="li5748588366"></a><strong id="EN-US_TOPIC_0000002233726930__b07414582369">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002233726930__li197455819368"><p id="EN-US_TOPIC_0000002233726930__p16741258163614"><a name="EN-US_TOPIC_0000002233726930__li197455819368"></a><a name="li197455819368"></a><strong id="EN-US_TOPIC_0000002233726930__b167425813610">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002233726930__b14747587365">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row7940175773613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p37455810360">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p27455813618">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p374205813363">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002233726930__b1674125813361">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_0000002233726930__en-us_topic_0000002055322414_response_user"></a><a name="en-us_topic_0000002055322414_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_user" frame="border" border="1" rules="all"><caption><b>Table 9 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row20943657193612"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p874175883610">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_0000002233726930__p1741158123612">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_0000002233726930__p147465811366">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row1194315711364"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p147445811364">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p107475893614"><a href="#EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_domain">domain</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p474205853613">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row794315773619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p0741358173613">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p47455883612">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p10741058193611">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row9943165716363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p774058163615">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1175145843613">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p137505811365">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_domain"></a><a name="en-us_topic_0000002055322414_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_response_domain" frame="border" border="1" rules="all"><caption><b>Table 10 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row17946205717364"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002233726930__p177545863611">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_0000002233726930__p117525812360">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_0000002233726930__p9759589365">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row2946957143619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p6751458113617">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p12754581362">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p17555818368">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row159461457193614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1075125883610">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1475858183615">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726930__p77513582364">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726930__section1875105812368"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002233726930__screen157510585367">POST https://{endpoint}/v1/{project_id}/notebooks/{id}/stop</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726930__section67585863613"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002233726930__p2075958113614"><strong id="EN-US_TOPIC_0000002233726930__b147518582364">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002233726930__p1975105863613">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002233726930__screen07515873619">{
"description" : "api-test",
"feature" : "NOTEBOOK",
"flavor" : "modelarts.vm.cpu.2u",
"id" : "f9937afa-4451-42db-a76b-72d624749f66",
"image" : {
"description" : "description",
"id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name" : "notebook2.0-mul-kernel-cpu-cp36",
"swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
"tag" : "3.3.2-release_v1",
"type" : "BUILD_IN"
},
"lease" : {
"create_at" : 1638841744515,
"duration" : 5313106,
"enable" : true,
"update_at" : 1638843457621
},
"name" : "notebooks_test",
"status" : "STOPPING",
"token" : "7bddd8ff-8a0d-e063-3107-c70a862832de",
"url" : "https://authoring-modelarts-xxxxx.xxxxx.com/f9937afa-4451-42db-a76b-72d624749f66/lab",
"volume" : {
"category" : "EFS",
"ownership" : "MANAGED",
"mount_path" : "/home/ma-user/work/",
"capacity" : 50
},
"workspace_id" : "0"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726930__section13761958133615"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726930__en-us_topic_0000002055322414_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002233726930__row14949157123614"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002233726930__p2762058133613">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_0000002233726930__p176135883618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726930__row109495574362"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726930__p1476658153615">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726930__p976185843616">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1794995711366"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726930__p9761558183618">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726930__p127619582368">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row094955710366"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726930__p14766583363">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726930__p87615582361">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row199491757193611"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726930__p87615823612">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726930__p10761558113614">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726930__row1594925718368"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726930__p376105813617">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726930__p1276105810364">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726930__section676135812366"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002233726930__p107625863619">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