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

959 lines
91 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002233726946"></a><a name="EN-US_TOPIC_0000002233726946"></a>
<h1 class="topictitle1">Updating a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002233726946__section1154873883315"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002233726946__p65491538133316">This API is used to update a notebook instance, including the name, description, specifications, and image ID. This API can be used only when the notebook instance is stopped.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726946__section1154923816331"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002233726946__p1654943843314">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726946__section14549173893315"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002233726946__p05498381338">PUT /v1/{project_id}/notebooks/{id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__table5550103833316" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row455043814335"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002233726946__p3550163815336">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_0000002233726946__p9550938133317">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_0000002233726946__p6551153818338">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_0000002233726946__p255115389338">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row175501238123311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1555133813332">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1655153833318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p2055120383337">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p1552103815339">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_0000002233726946__row25501638123313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p14552238143315">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_0000002233726946__p145528388337">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p16552113843318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p1855223833315">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_0000002233726946__section1255343814331"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_NotebookUpdateRequest" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row75539386331"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000002233726946__p1155414382333">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000002233726946__p755493819339">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000002233726946__p555493813333">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000002233726946__p1255553833313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row205535388337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1255553833317">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1255511383337">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p14555133853314">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p1555238163312">Instance description. The value can contain a maximum of 512 characters and cannot contain the following special characters: &amp;&lt;&gt;"/.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row12553113883310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p14555123818339">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p15555338183316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p16556163814334">Array of <a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_EndpointsReq">EndpointsReq</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p2556193823313">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_0000002233726946__row3553338163311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1955613853318">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p14556173811336">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p455617386334">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p15556838173312">Instance flavor. For details, see <a href="ShowSwitchableFlavors.html">Querying Flavors Available for a Notebook Instance</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row555412385333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p2556143819338">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1155653816333">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p155571538173318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p255713812334">Image ID. For details, see <a href="ListImage.html">Querying Supported Images</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row85541738183313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p655723814335">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p15557133816331">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p2557838193317">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p1055717380335">Instance name that can be updated, which contains a maximum of 128 characters, including letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row5554143812334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p6557153813315">storage_new_size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1557038143314">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p195585389337">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p1155893811337">EVS instance capacity that can be expanded, in GB. The maximum value is 4,096 GB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row155541038183319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1355815385338">hooks</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p16558133819339">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p135581738113312"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_CustomHooks">CustomHooks</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p4558738113312">The instance startup script can be updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_EndpointsReq"></a><a name="en-us_topic_0000002055322402_request_EndpointsReq"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_EndpointsReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>EndpointsReq</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row1155913389338"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000002233726946__p555911384339">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_0000002233726946__p6560638173314">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_0000002233726946__p155603389332">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_0000002233726946__p156093812333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row13559038123315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p456083893314">allowed_access_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1456073815338">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p7560193863317">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p75603383332">Public IP addresses that can remotely access the notebook instance. A maximum of five public IP addresses are supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row855973813332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p55602038113320">service</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p12560638183318">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p13560038133318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p6561103817338">Supported service. Possible values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul13561338123320"><li id="EN-US_TOPIC_0000002233726946__li1756119386334"><p id="EN-US_TOPIC_0000002233726946__p1056115388337"><a name="EN-US_TOPIC_0000002233726946__li1756119386334"></a><a name="li1756119386334"></a><strong id="EN-US_TOPIC_0000002233726946__b1956143863313">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li1556110383336"><p id="EN-US_TOPIC_0000002233726946__p12561138183318"><a name="EN-US_TOPIC_0000002233726946__li1556110383336"></a><a name="li1556110383336"></a><strong id="EN-US_TOPIC_0000002233726946__b1856116382333">SSH</strong>: You can remotely access notebook instances through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row16559153812331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p356103833314">key_pair_names</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p12561103814339">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p2561183812336">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p105611738123318">Name of the SSH key pair, which can be created and viewed on the <strong id="EN-US_TOPIC_0000002233726946__b1356120383333">Key Pair</strong> page of the Elastic Cloud Server (ECS) console.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_CustomHooks"></a><a name="en-us_topic_0000002055322402_request_CustomHooks"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_CustomHooks" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CustomHooks</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row1256273823310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000002233726946__p8562163823311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0000002233726946__p9562183833319">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0000002233726946__p145629383337">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0000002233726946__p1156223811333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row145621838163311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p11562838153312">container_hooks</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p35625386331">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p10563183817333"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_ContainerHooks">ContainerHooks</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p4563193810338">Container-related hook configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_ContainerHooks"></a><a name="en-us_topic_0000002055322402_request_ContainerHooks"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_ContainerHooks" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ContainerHooks</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row75632383336"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000002233726946__p45638386339">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.2"><p id="EN-US_TOPIC_0000002233726946__p17564838103311">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p id="EN-US_TOPIC_0000002233726946__p1556415389338">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.5.2.5.1.4"><p id="EN-US_TOPIC_0000002233726946__p1456473853316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row656343818339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1356413389334">post_start</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p85644384337">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p356419385337"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_Config">Config</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p1356463815338">Configure the script after the service is started.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1956312387332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p656417387335">pre_start</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p5564138103316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p10565143818330"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_Config">Config</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p16565123819334">Configure the script before starting the service.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_Config"></a><a name="en-us_topic_0000002055322402_request_Config"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_request_Config" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Config</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row18565538103312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="EN-US_TOPIC_0000002233726946__p19565143813317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.2"><p id="EN-US_TOPIC_0000002233726946__p1256612389336">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.3"><p id="EN-US_TOPIC_0000002233726946__p456663819336">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.6.2.5.1.4"><p id="EN-US_TOPIC_0000002233726946__p19566638203320">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row1356515384334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p195661238163315">script</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p356623843317">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p45661038173314">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p1256615388332">User-defined script content (Base64 encoding) or absolute script path.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row18565163853317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726946__p9566153893312">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726946__p6566138163318">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726946__p12566183818337">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726946__p6567123815332">Script type.</p>
<ul id="EN-US_TOPIC_0000002233726946__ul75672383331"><li id="EN-US_TOPIC_0000002233726946__li95675382336"><p id="EN-US_TOPIC_0000002233726946__p145674386332"><a name="EN-US_TOPIC_0000002233726946__li95675382336"></a><a name="li95675382336"></a><strong id="EN-US_TOPIC_0000002233726946__b185671438153318">COMMAND</strong>: The script content (Base64-encoded) must be specified.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li956783818331"><p id="EN-US_TOPIC_0000002233726946__p1756783833310"><a name="EN-US_TOPIC_0000002233726946__li956783818331"></a><a name="li956783818331"></a><strong id="EN-US_TOPIC_0000002233726946__b10567183833317">SCRIPT</strong> (default): The script path must be specified.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726946__section12567143853310"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002233726946__p85681389335"><strong id="EN-US_TOPIC_0000002233726946__b1356883812332">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row185691738163311"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p5572638183319">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_0000002233726946__p957283833319">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_0000002233726946__p85721338163313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row456953883318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p8573163820339">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_0000002233726946__p1057343819330">Array of <a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_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_0000002233726946__p1157314389339">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row105692387339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p65737388332">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p115731738113312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p1357411388330">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row17570838163312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1257418389339">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p5574203813333">Array of <a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_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_0000002233726946__p4574183818336">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_0000002233726946__row12570173810334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p65741238173313">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_0000002233726946__p2575183813311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p125757388336">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row145701938133317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p457515384334">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p14575038113317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p11575173863319">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1957043814337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p155755387336">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p557693818335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p95760383333">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row105702381338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1457663812336">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p19576538123320"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_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_0000002233726946__p1957683853310">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row195709389333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p557793893313">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p7577338113313"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_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_0000002233726946__p457733820339">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row105701938163315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p155771382337">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p257718381334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p757863816332">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row15701238173317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p65781038133315">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p13578173816339"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_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_0000002233726946__p1857803883314">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_0000002233726946__row1257063833316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p95781438163317">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p20579738133320">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p12579143833310">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul5579153863310"><li id="EN-US_TOPIC_0000002233726946__li1157953843317"><p id="EN-US_TOPIC_0000002233726946__p8579838113310"><a name="EN-US_TOPIC_0000002233726946__li1157953843317"></a><a name="li1157953843317"></a><strong id="EN-US_TOPIC_0000002233726946__b1757963814332">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li957912385330"><p id="EN-US_TOPIC_0000002233726946__p757914381337"><a name="EN-US_TOPIC_0000002233726946__li957912385330"></a><a name="li957912385330"></a><strong id="EN-US_TOPIC_0000002233726946__b16579163811330">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li20580193818338"><p id="EN-US_TOPIC_0000002233726946__p95801338203312"><a name="EN-US_TOPIC_0000002233726946__li20580193818338"></a><a name="li20580193818338"></a><strong id="EN-US_TOPIC_0000002233726946__b6580338153314">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li1458043810331"><p id="EN-US_TOPIC_0000002233726946__p165806386333"><a name="EN-US_TOPIC_0000002233726946__li1458043810331"></a><a name="li1458043810331"></a><strong id="EN-US_TOPIC_0000002233726946__b1958017385333">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li358013383337"><p id="EN-US_TOPIC_0000002233726946__p14580238123312"><a name="EN-US_TOPIC_0000002233726946__li358013383337"></a><a name="li358013383337"></a><strong id="EN-US_TOPIC_0000002233726946__b14580538193318">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li55801038143319"><p id="EN-US_TOPIC_0000002233726946__p8580113814330"><a name="EN-US_TOPIC_0000002233726946__li55801038143319"></a><a name="li55801038143319"></a><strong id="EN-US_TOPIC_0000002233726946__b95801338103319">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li165801938113312"><p id="EN-US_TOPIC_0000002233726946__p155813389336"><a name="EN-US_TOPIC_0000002233726946__li165801938113312"></a><a name="li165801938113312"></a><strong id="EN-US_TOPIC_0000002233726946__b205814383336">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li1558163817338"><p id="EN-US_TOPIC_0000002233726946__p1958153823316"><a name="EN-US_TOPIC_0000002233726946__li1558163817338"></a><a name="li1558163817338"></a><strong id="EN-US_TOPIC_0000002233726946__b45821738203310">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li155821338103316"><p id="EN-US_TOPIC_0000002233726946__p10582138113317"><a name="EN-US_TOPIC_0000002233726946__li155821338103316"></a><a name="li155821338103316"></a><strong id="EN-US_TOPIC_0000002233726946__b1758223873313">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li155821138113312"><p id="EN-US_TOPIC_0000002233726946__p1758203873311"><a name="EN-US_TOPIC_0000002233726946__li155821138113312"></a><a name="li155821138113312"></a><strong id="EN-US_TOPIC_0000002233726946__b1558218382335">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li458243819331"><p id="EN-US_TOPIC_0000002233726946__p25829384334"><a name="EN-US_TOPIC_0000002233726946__li458243819331"></a><a name="li458243819331"></a><strong id="EN-US_TOPIC_0000002233726946__b16582173833320">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li145822389338"><p id="EN-US_TOPIC_0000002233726946__p0582193818334"><a name="EN-US_TOPIC_0000002233726946__li145822389338"></a><a name="li145822389338"></a><strong id="EN-US_TOPIC_0000002233726946__b55828384335">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li1582338163315"><p id="EN-US_TOPIC_0000002233726946__p8582123883317"><a name="EN-US_TOPIC_0000002233726946__li1582338163315"></a><a name="li1582338163315"></a><strong id="EN-US_TOPIC_0000002233726946__b95828383334">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li258216386337"><p id="EN-US_TOPIC_0000002233726946__p19582638113313"><a name="EN-US_TOPIC_0000002233726946__li258216386337"></a><a name="li258216386337"></a><strong id="EN-US_TOPIC_0000002233726946__b1558343813336">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1357019389334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p10583103812338">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p12583103863311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p7583203893311">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1057123853312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p158433843314">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1158483843312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p45845385333">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row8571038173314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p11584338193312">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p195841138133314"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_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_0000002233726946__p205841838183317">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row35711938193318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p358403863310">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_0000002233726946__p758553820338">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p0585238163313">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726946__b1158553812333">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1057153817338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p85858385330">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p55857385338">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p15585203811333">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul13585133819336"><li id="EN-US_TOPIC_0000002233726946__li458533812336"><p id="EN-US_TOPIC_0000002233726946__p1358518389334"><a name="EN-US_TOPIC_0000002233726946__li458533812336"></a><a name="li458533812336"></a><strong id="EN-US_TOPIC_0000002233726946__b2585173813332">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li14585143863313"><p id="EN-US_TOPIC_0000002233726946__p11585153811339"><a name="EN-US_TOPIC_0000002233726946__li14585143863313"></a><a name="li14585143863313"></a><strong id="EN-US_TOPIC_0000002233726946__b1458513883311">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1257193853315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p45851388331">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_0000002233726946__p75862386336">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_0000002233726946__p15586143853314">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002233726946__p6586538153316">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726946__p25861938133318">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726946__p8586143819332">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row957133813318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1358603811334">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p158653873319"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_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_0000002233726946__p115862381337">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_JobProgress"></a><a name="en-us_topic_0000002055322402_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 8 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row1158713819332"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p1981103813316">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_0000002233726946__p18981173893315">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_0000002233726946__p17981143818335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row1458783817331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p798143873320">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_0000002233726946__p198114383339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p49818382333">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row858783813331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1998183853314">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p129811738183315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p13981138103311">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul7981113810334"><li id="EN-US_TOPIC_0000002233726946__li298113823315"><p id="EN-US_TOPIC_0000002233726946__p1698173803311"><a name="EN-US_TOPIC_0000002233726946__li298113823315"></a><a name="li298113823315"></a><strong id="EN-US_TOPIC_0000002233726946__b11981138133310">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li199815382339"><p id="EN-US_TOPIC_0000002233726946__p998173823314"><a name="EN-US_TOPIC_0000002233726946__li199815382339"></a><a name="li199815382339"></a><strong id="EN-US_TOPIC_0000002233726946__b17981338183317">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li14981203812335"><p id="EN-US_TOPIC_0000002233726946__p159811238123314"><a name="EN-US_TOPIC_0000002233726946__li14981203812335"></a><a name="li14981203812335"></a><strong id="EN-US_TOPIC_0000002233726946__b398153820338">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li11981153873310"><p id="EN-US_TOPIC_0000002233726946__p18981123843318"><a name="EN-US_TOPIC_0000002233726946__li11981153873310"></a><a name="li11981153873310"></a><strong id="EN-US_TOPIC_0000002233726946__b11982113843313">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row6587938173315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p11982438163312">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p2982438183317">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p098263812332">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul19982338153313"><li id="EN-US_TOPIC_0000002233726946__li15982193893313"><p id="EN-US_TOPIC_0000002233726946__p119822389336"><a name="EN-US_TOPIC_0000002233726946__li15982193893313"></a><a name="li15982193893313"></a><strong id="EN-US_TOPIC_0000002233726946__b14982153818331">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li5982123812331"><p id="EN-US_TOPIC_0000002233726946__p17982538113313"><a name="EN-US_TOPIC_0000002233726946__li5982123812331"></a><a name="li5982123812331"></a><strong id="EN-US_TOPIC_0000002233726946__b198223833318">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li1198211385339"><p id="EN-US_TOPIC_0000002233726946__p149821138113310"><a name="EN-US_TOPIC_0000002233726946__li1198211385339"></a><a name="li1198211385339"></a><strong id="EN-US_TOPIC_0000002233726946__b18982133833315">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li39821838123317"><p id="EN-US_TOPIC_0000002233726946__p7982133817332"><a name="EN-US_TOPIC_0000002233726946__li39821838123317"></a><a name="li39821838123317"></a><strong id="EN-US_TOPIC_0000002233726946__b7982193812339">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row6587638203316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p59821738133311">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_0000002233726946__p4982238173318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p1598212381330">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_EndpointsRes"></a><a name="en-us_topic_0000002055322402_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 9 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row55929381336"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p99827386339">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_0000002233726946__p298253813318">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_0000002233726946__p15982163818337">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row14592838163317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p14982838153316">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_0000002233726946__p39823389337">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_0000002233726946__p15982538133310">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_0000002233726946__row1759215382331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p20982438183315">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_0000002233726946__p598243815339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p29821538183317">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul8982103863316"><li id="EN-US_TOPIC_0000002233726946__li13982193813335"><p id="EN-US_TOPIC_0000002233726946__p998213812337"><a name="EN-US_TOPIC_0000002233726946__li13982193813335"></a><a name="li13982193813335"></a><strong id="EN-US_TOPIC_0000002233726946__b109821388331">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li10982173803314"><p id="EN-US_TOPIC_0000002233726946__p139821838113311"><a name="EN-US_TOPIC_0000002233726946__li10982173803314"></a><a name="li10982173803314"></a><strong id="EN-US_TOPIC_0000002233726946__b698215383331">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1259283843314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1598283813339">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_0000002233726946__p798211384336">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_0000002233726946__p7982103863319">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_0000002233726946__row205925388338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p398373811333">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p16983938183314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p998393803314">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul129831538203310"><li id="EN-US_TOPIC_0000002233726946__li198323818337"><p id="EN-US_TOPIC_0000002233726946__p19837381334"><a name="EN-US_TOPIC_0000002233726946__li198323818337"></a><a name="li198323818337"></a><strong id="EN-US_TOPIC_0000002233726946__b39834387330">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li6983938143317"><p id="EN-US_TOPIC_0000002233726946__p1498393811333"><a name="EN-US_TOPIC_0000002233726946__li6983938143317"></a><a name="li6983938143317"></a><strong id="EN-US_TOPIC_0000002233726946__b12983183853314">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row059233803317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p169831338193316">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p198303813318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p8983138103319">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_Image"></a><a name="en-us_topic_0000002055322402_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_Image" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row195956386335"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p1998313813334">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_0000002233726946__p179831438203317">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_0000002233726946__p9983938113317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row145954388335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p398317386339">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p398313389331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p9983103815339">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul698314383336"><li id="EN-US_TOPIC_0000002233726946__li1983138103319"><p id="EN-US_TOPIC_0000002233726946__p898314382337"><a name="EN-US_TOPIC_0000002233726946__li1983138103319"></a><a name="li1983138103319"></a><strong id="EN-US_TOPIC_0000002233726946__b99831338173312">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002233726946__li698333853318"><p id="EN-US_TOPIC_0000002233726946__p09834385330"><a name="EN-US_TOPIC_0000002233726946__li698333853318"></a><a name="li698333853318"></a><strong id="EN-US_TOPIC_0000002233726946__b19983143873319">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1259553810339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p198303813310">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_0000002233726946__p159831338113315">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p29837384331">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row105951738193319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1098393873315">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p189838389332">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p198414386338">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1759520388336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1598411380336">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_0000002233726946__p6984538163311">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_0000002233726946__p1098413388337">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul1984183873318"><li id="EN-US_TOPIC_0000002233726946__li1898453817333"><p id="EN-US_TOPIC_0000002233726946__p1998418387331"><a name="EN-US_TOPIC_0000002233726946__li1898453817333"></a><a name="li1898453817333"></a><strong id="EN-US_TOPIC_0000002233726946__b69841383334">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li8984938143311"><p id="EN-US_TOPIC_0000002233726946__p1698453893313"><a name="EN-US_TOPIC_0000002233726946__li8984938143311"></a><a name="li8984938143311"></a><strong id="EN-US_TOPIC_0000002233726946__b998483873311">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_0000002233726946__row2595163823310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1898417386331">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p898417387336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p129841238133318">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_0000002233726946__row159523814332"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p4984163820333">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p198483803313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p1898483816337">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_0000002233726946__row9595193813320"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1698463853315">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1298453819336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p1398411389334">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002233726946__b19984173813335">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row159513883311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1798416385337">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1798473813315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p1498412384334">Image source, which defaults to <strong id="EN-US_TOPIC_0000002233726946__b9984103812332">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul79848387332"><li id="EN-US_TOPIC_0000002233726946__li16984173818339"><p id="EN-US_TOPIC_0000002233726946__p7984638103313"><a name="EN-US_TOPIC_0000002233726946__li16984173818339"></a><a name="li16984173818339"></a><strong id="EN-US_TOPIC_0000002233726946__b18984838163316">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002233726946__li79846388338"><p id="EN-US_TOPIC_0000002233726946__p79849383339"><a name="EN-US_TOPIC_0000002233726946__li79846388338"></a><a name="li79846388338"></a><strong id="EN-US_TOPIC_0000002233726946__b69841938163319">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row19596143813316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1598443813333">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_0000002233726946__p69841338193320">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_0000002233726946__p11984203873314">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul1798453811337"><li id="EN-US_TOPIC_0000002233726946__li1598413382336"><p id="EN-US_TOPIC_0000002233726946__p1198417385339"><a name="EN-US_TOPIC_0000002233726946__li1598413382336"></a><a name="li1598413382336"></a><strong id="EN-US_TOPIC_0000002233726946__b2098463820333">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726946__li11984143803317"><p id="EN-US_TOPIC_0000002233726946__p13984838183314"><a name="EN-US_TOPIC_0000002233726946__li11984143803317"></a><a name="li11984143803317"></a><strong id="EN-US_TOPIC_0000002233726946__b1984113811334">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row195961438173312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p2098416386339">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_0000002233726946__p898414382334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p59848380335">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul17984183893318"><li id="EN-US_TOPIC_0000002233726946__li2984113873320"><p id="EN-US_TOPIC_0000002233726946__p1984138173310"><a name="EN-US_TOPIC_0000002233726946__li2984113873320"></a><a name="li2984113873320"></a><strong id="EN-US_TOPIC_0000002233726946__b898419389338">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002233726946__li8984163819335"><p id="EN-US_TOPIC_0000002233726946__p5984143810334"><a name="EN-US_TOPIC_0000002233726946__li8984163819335"></a><a name="li8984163819335"></a><strong id="EN-US_TOPIC_0000002233726946__b5984123811332">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002233726946__li13984123813334"><p id="EN-US_TOPIC_0000002233726946__p14984838103318"><a name="EN-US_TOPIC_0000002233726946__li13984123813334"></a><a name="li13984123813334"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002233726946__li16984133813334"><p id="EN-US_TOPIC_0000002233726946__p139841438133312"><a name="EN-US_TOPIC_0000002233726946__li16984133813334"></a><a name="li16984133813334"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002233726946__li2985173883320"><p id="EN-US_TOPIC_0000002233726946__p1098511382333"><a name="EN-US_TOPIC_0000002233726946__li2985173883320"></a><a name="li2985173883320"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1159653816338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p149858384339">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p19851638173312">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p598583863312">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row459614387331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p20985103823318">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1498583818330">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p2985113803318">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul59850388331"><li id="EN-US_TOPIC_0000002233726946__li1498583853314"><p id="EN-US_TOPIC_0000002233726946__p1298543814330"><a name="EN-US_TOPIC_0000002233726946__li1498583853314"></a><a name="li1498583853314"></a><strong id="EN-US_TOPIC_0000002233726946__b189851538183313">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li18985113823311"><p id="EN-US_TOPIC_0000002233726946__p398513812332"><a name="EN-US_TOPIC_0000002233726946__li18985113823311"></a><a name="li18985113823311"></a><strong id="EN-US_TOPIC_0000002233726946__b498511384335">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li7985203820332"><p id="EN-US_TOPIC_0000002233726946__p898583819331"><a name="EN-US_TOPIC_0000002233726946__li7985203820332"></a><a name="li7985203820332"></a><strong id="EN-US_TOPIC_0000002233726946__b11985183815330">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li698513811334"><p id="EN-US_TOPIC_0000002233726946__p898543873317"><a name="EN-US_TOPIC_0000002233726946__li698513811334"></a><a name="li698513811334"></a><strong id="EN-US_TOPIC_0000002233726946__b19851338133316">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li89851638123310"><p id="EN-US_TOPIC_0000002233726946__p8985133883315"><a name="EN-US_TOPIC_0000002233726946__li89851638123310"></a><a name="li89851638123310"></a><strong id="EN-US_TOPIC_0000002233726946__b179857386334">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li9985163813317"><p id="EN-US_TOPIC_0000002233726946__p17985133814337"><a name="EN-US_TOPIC_0000002233726946__li9985163813317"></a><a name="li9985163813317"></a><strong id="EN-US_TOPIC_0000002233726946__b169851338133312">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_0000002233726946__row1059613843311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p20985103820333">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_0000002233726946__p59851386332">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p1698593863319">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row13596173873312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p79851638163310">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_0000002233726946__p209853380336">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_0000002233726946__p3985838143319">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul7985173813335"><li id="EN-US_TOPIC_0000002233726946__li1398553820334"><p id="EN-US_TOPIC_0000002233726946__p14985193819339"><a name="EN-US_TOPIC_0000002233726946__li1398553820334"></a><a name="li1398553820334"></a><strong id="EN-US_TOPIC_0000002233726946__b898517386339">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726946__li19985173823319"><p id="EN-US_TOPIC_0000002233726946__p18985238143310"><a name="EN-US_TOPIC_0000002233726946__li19985173823319"></a><a name="li19985173823319"></a><strong id="EN-US_TOPIC_0000002233726946__b18985163883313">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row459611384333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p5985203819337">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_0000002233726946__p3985183820333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p129851238183313">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1259693820334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p119851388337">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p17985238103315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p6985163833311">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row17596173893313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p59855387330">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p8985438133310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p0985103812334">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul13985133813331"><li id="EN-US_TOPIC_0000002233726946__li3985238163310"><p id="EN-US_TOPIC_0000002233726946__p1098543813313"><a name="EN-US_TOPIC_0000002233726946__li3985238163310"></a><a name="li3985238163310"></a><strong id="EN-US_TOPIC_0000002233726946__b18985173823318">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002233726946__li19985113823311"><p id="EN-US_TOPIC_0000002233726946__p149851138113316"><a name="EN-US_TOPIC_0000002233726946__li19985113823311"></a><a name="li19985113823311"></a><strong id="EN-US_TOPIC_0000002233726946__b598523814337">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row4596138133317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p698683873317">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_0000002233726946__p1898673813315">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p12986143820332">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row10596238133319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p3986143817336">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1998643816334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p5986143814337">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul1498613382338"><li id="EN-US_TOPIC_0000002233726946__li1298614380335"><p id="EN-US_TOPIC_0000002233726946__p189861938143317"><a name="EN-US_TOPIC_0000002233726946__li1298614380335"></a><a name="li1298614380335"></a><strong id="EN-US_TOPIC_0000002233726946__b0986193823315">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002233726946__li15986113818330"><p id="EN-US_TOPIC_0000002233726946__p169861238123319"><a name="EN-US_TOPIC_0000002233726946__li15986113818330"></a><a name="li15986113818330"></a><strong id="EN-US_TOPIC_0000002233726946__b19986338113318">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row859619388335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p398618387332">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_0000002233726946__p798623893312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p29862038203316">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726946__b1498611383335">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1596103815334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p19861138123320">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_0000002233726946__p1498693823317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p17986163893312">Image resource type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_Lease"></a><a name="en-us_topic_0000002055322402_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row16608173816334"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p1598618382337">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_0000002233726946__p17986538193311">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_0000002233726946__p1298673812338">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row11608538173312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p69861638193314">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_0000002233726946__p798673813339">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p598620382337">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row15608938183317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p13986738113315">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p298603818334">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p598618382335">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_0000002233726946__row15609138123310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p298663810337">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p7986133833318">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p109879381333">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1960993810337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p1698793823316">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p8987113863316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p16987193817335">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002233726946__ul1798763813313"><li id="EN-US_TOPIC_0000002233726946__li16987183863310"><p id="EN-US_TOPIC_0000002233726946__p4987173873317"><a name="EN-US_TOPIC_0000002233726946__li16987183863310"></a><a name="li16987183863310"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li89871538183312"><p id="EN-US_TOPIC_0000002233726946__p7987538113314"><a name="EN-US_TOPIC_0000002233726946__li89871538183312"></a><a name="li89871538183312"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1609938103316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p11987938153310">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_0000002233726946__p109871238183315">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p2987438143319">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_0000002233726946__en-us_topic_0000002055322402_response_Pool"></a><a name="en-us_topic_0000002055322402_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row9610203843317"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p49871382338">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_0000002233726946__p1998783815334">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_0000002233726946__p11987193893318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row12610938113313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p99874383332">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1898718382334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p20987193873313">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1361143810339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p89871738113319">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1598713813317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p6987153817334">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_VolumeRes"></a><a name="en-us_topic_0000002055322402_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 13 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row17612438143315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p89871389335">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_0000002233726946__p13987193815336">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_0000002233726946__p3987173873311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row186121538173314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p16987238103314">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p698712384331">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p0987123816334">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_0000002233726946__row06121338203316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p159878389336">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p998717382335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p19871138163318">Supported storage types. For details about the differences between the storage types, see"Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002233726946__i17987038123314">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul109871438173312"><li id="EN-US_TOPIC_0000002233726946__li99875380331"><p id="EN-US_TOPIC_0000002233726946__p5987113811335"><a name="EN-US_TOPIC_0000002233726946__li99875380331"></a><a name="li99875380331"></a><strong id="EN-US_TOPIC_0000002233726946__b59871038153310">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002233726946__li11988143811338"><p id="EN-US_TOPIC_0000002233726946__p1798813389330"><a name="EN-US_TOPIC_0000002233726946__li11988143811338"></a><a name="li11988143811338"></a><strong id="EN-US_TOPIC_0000002233726946__b16988183812330">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row661217388330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p998816384332">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_0000002233726946__p3988123893319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p7988738163310">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002233726946__b798814389335">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1061220381337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p149881038113310">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p17988103823319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p1298873814332">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726946__ul098883813338"><li id="EN-US_TOPIC_0000002233726946__li89881038123316"><p id="EN-US_TOPIC_0000002233726946__p2988738123313"><a name="EN-US_TOPIC_0000002233726946__li89881038123316"></a><a name="li89881038123316"></a><strong id="EN-US_TOPIC_0000002233726946__b1198816389337">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002233726946__li1298814388338"><p id="EN-US_TOPIC_0000002233726946__p209888382339"><a name="EN-US_TOPIC_0000002233726946__li1298814388338"></a><a name="li1298814388338"></a><strong id="EN-US_TOPIC_0000002233726946__b1598893813313">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002233726946__b1098812385338">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row1612133811335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p10988183819335">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p189887383336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p19988183818335">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002233726946__b18988173843315">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_0000002233726946__en-us_topic_0000002055322402_response_user"></a><a name="en-us_topic_0000002055322402_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_user" frame="border" border="1" rules="all"><caption><b>Table 14 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row16151938123318"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p7988163893316">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_0000002233726946__p8988163833311">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_0000002233726946__p149882382333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row1661573883310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p4988193883315">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p119881738133317"><a href="#EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_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_0000002233726946__p2988138123312">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row86151138113317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p16988163873311">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p14988133883313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p15988103883314">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row146151538153316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p4988173813317">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p1598812384333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p598833818333">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_domain"></a><a name="en-us_topic_0000002055322402_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_response_domain" frame="border" border="1" rules="all"><caption><b>Table 15 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row961663817333"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002233726946__p39888388338">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_0000002233726946__p6988133843312">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_0000002233726946__p15988438123310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row161643812337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p14988103863311">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p169892389334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p1798918388336">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row16616938173316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726946__p10989183843312">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726946__p17989183843312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726946__p12989238183311">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726946__section29891238183313"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002233726946__screen79891338133319">{
"description" : "update"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726946__section998933873318"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002233726946__p1898953853315"><strong id="EN-US_TOPIC_0000002233726946__b898912382333">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002233726946__p89891538183315">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002233726946__screen09896384335">{
"description" : "test",
"flavor" : "modelarts.vm.cpu.8u",
"name" : "notebook-1111",
"endpoints" : [ {
"allowed_access_ips" : [ "1.1.1.1" ]
} ]
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726946__section1989638163316"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726946__en-us_topic_0000002055322402_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002233726946__row12618203818336"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002233726946__p698943893311">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_0000002233726946__p1098993813314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726946__row14618338193310"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726946__p39891638173314">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726946__p10989163811338">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row9618143883317"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726946__p7989123813315">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726946__p13989193843313">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row19618038113311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726946__p298993833312">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726946__p498913818333">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row86181738103310"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726946__p19896381339">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726946__p14989238103313">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726946__row36181338123317"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726946__p15989238143310">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726946__p12989163815332">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726946__section7989538123319"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002233726946__p13989238153313">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