yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
78d5ebfce83bc710b05fb0adb3f7afc83565640f
doc-exports/docs/modelarts/api-ref/UpdateNotebook.html
Wuwan, Qi 78d5ebfce8 ModelArts API 25.3.0 20250710 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2025-07-28 12:24:54 +00:00

952 lines
113 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002374896605"></a><a name="EN-US_TOPIC_0000002374896605"></a>
<h1 class="topictitle1">Updating a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_section11963105312381"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p9963165373819">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_0000002374896605__en-us_topic_0000002055322402_section29631553193818"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p69631053113817">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_section149638530385"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1496311539381">PUT /v1/{project_id}/notebooks/{id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_table996413532388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row796335393816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1796495311388">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_0000002374896605__en-us_topic_0000002055322402_p2964853133814">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_0000002374896605__en-us_topic_0000002055322402_p16964135353816">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_0000002374896605__en-us_topic_0000002055322402_p18964125373811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row15963253133815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p9964453193816">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p396465314383">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p9964145316382">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p29641353183817">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_0000002374896605__en-us_topic_0000002055322402_row139631653123814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p196445393817">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_0000002374896605__en-us_topic_0000002055322402_p9964125363820">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1696415536386">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p8965135333814">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_0000002374896605__en-us_topic_0000002055322402_section1896518535386"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row1896512539380"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p189661153123811">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_0000002374896605__en-us_topic_0000002055322402_p796613533388">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_0000002374896605__en-us_topic_0000002055322402_p2096695317386">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_0000002374896605__en-us_topic_0000002055322402_p119661253103811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1296516531382"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p69667538386">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p18966253193815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p196625323817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p796695312388">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_0000002374896605__en-us_topic_0000002055322402_row196595312384"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p13966553133817">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p996617536389">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p199668537381">Array of <a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p119671253123811">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_0000002374896605__en-us_topic_0000002055322402_row1696517535386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p199671753153818">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3967135318388">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p7967553173810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p4967145318387">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_0000002374896605__en-us_topic_0000002055322402_row096575313810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p4967145373816">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_0000002374896605__en-us_topic_0000002055322402_p196765343817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p8967205315385">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p396765373810">Image ID. For details, see <a href="ListImage.html">Querying Supported Images</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row209651953133810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p396795310381">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p199674530381">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1996745353814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p696795314381">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_0000002374896605__en-us_topic_0000002055322402_row096513534385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p139681653113812">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_0000002374896605__en-us_topic_0000002055322402_p139681653143815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p4968253143812">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1496855393817">EVS instance capacity that can be expanded, in GB. The maximum value is 4,096 GB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row9965953103811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p89682533383">hooks</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p13968653103820">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p139681253113812"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p11968175333820">The instance startup script can be updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row15968105383815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p49691553113818">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_0000002374896605__en-us_topic_0000002055322402_p1496910534383">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_0000002374896605__en-us_topic_0000002055322402_p09691553143819">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_0000002374896605__en-us_topic_0000002055322402_p996915315383">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row109688534381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p696925323814">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_0000002374896605__en-us_topic_0000002055322402_p17969953113810">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p159697531389">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_0000002374896605__en-us_topic_0000002055322402_p13969175319382">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_0000002374896605__en-us_topic_0000002055322402_row496813534385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p89693536386">service</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p5969125315386">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19969155383811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p189701853113820">Supported service. Possible values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul1197045353814"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1697015313817"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p12970153183812"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1697015313817"></a><a name="en-us_topic_0000002055322402_li1697015313817"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b119706536382">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li3970195393814"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p897065311385"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li3970195393814"></a><a name="en-us_topic_0000002055322402_li3970195393814"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b19707535383">SSH</strong>: You can remotely access notebook instances through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row12968145310386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p597019538383">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_0000002374896605__en-us_topic_0000002055322402_p18970653193815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p69703530380">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_0000002374896605__en-us_topic_0000002055322402_p13970145317381">Name of the SSH key pair, which can be created and viewed on the <strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b149701453133812">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_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row1970353183811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1397105313385">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_0000002374896605__en-us_topic_0000002055322402_p4971753203813">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_0000002374896605__en-us_topic_0000002055322402_p12971175323818">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_0000002374896605__en-us_topic_0000002055322402_p11971153183820">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1197013539386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p7971105373811">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_0000002374896605__en-us_topic_0000002055322402_p49712531380">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15971125323819"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p1697118539380">Container-related hook configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row89711153113811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p897225319386">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_0000002374896605__en-us_topic_0000002055322402_p1897245363819">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_0000002374896605__en-us_topic_0000002055322402_p1497235317382">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_0000002374896605__en-us_topic_0000002055322402_p8972953153814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1597112535381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p79721053173820">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_0000002374896605__en-us_topic_0000002055322402_p6972145303818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p2972105353819"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p1997218534383">Configure the script after the service is started.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1397125317386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1897235320380">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_0000002374896605__en-us_topic_0000002055322402_p1397265363817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p297216531381"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p199731453123810">Configure the script before starting the service.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row199737531389"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p8973135311382">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_0000002374896605__en-us_topic_0000002055322402_p1797311539386">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_0000002374896605__en-us_topic_0000002055322402_p209731253193811">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_0000002374896605__en-us_topic_0000002055322402_p149731053173810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1497365383815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p16973155312383">script</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1973135323813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p097415315382">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p097417534386">User-defined script content (Base64 encoding) or absolute script path.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1497315373817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p159741253143811">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1697418535384">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1497495317384">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p11974195320383">Script type.</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul497465311380"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li12974953153812"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3974135311388"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li12974953153812"></a><a name="en-us_topic_0000002055322402_li12974953153812"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b10974653123814">COMMAND</strong>: The script content (Base64-encoded) must be specified.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li597445310387"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p597455333819"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li597445310387"></a><a name="en-us_topic_0000002055322402_li597445310387"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b097413535384">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_0000002374896605__en-us_topic_0000002055322402_section1697475312384"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19974185353810"><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b139741653133814">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row18975105311382"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p9976185383819">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_0000002374896605__en-us_topic_0000002055322402_p897695343816">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_0000002374896605__en-us_topic_0000002055322402_p1997605343810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1297585333810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1297618538385">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_0000002374896605__en-us_topic_0000002055322402_p497625393812">Array of <a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p4976145313382">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1897516532380"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p39774534380">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p797725314387">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p18977953143815">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row097555333811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19771753183820">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p6977195319381">Array of <a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p179771153113812">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_0000002374896605__en-us_topic_0000002055322402_row149751253173818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p18977185323820">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_0000002374896605__en-us_topic_0000002055322402_p29771953163812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p397795317382">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1197512539382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3977195315389">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p897775343817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p897755313815">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row14975653173815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p109772053193813">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p18977165316385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p17977175343817">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row89751553143819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p897812532387">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1897815314383"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p397815533388">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row19751953113810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p2978195383814">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p89781453103817"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p597895343814">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row39753533388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p197811532381">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p18978105323817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1297814536380">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row8975195313811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p197825320387">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1397815535386"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p16978175303811">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_0000002374896605__en-us_topic_0000002055322402_row49750538388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p139781053173817">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p797845323819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p7979125315382">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul49791853143819"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li49792532382"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p797985343820"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li49792532382"></a><a name="en-us_topic_0000002055322402_li49792532382"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b9979135323816">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li149791753183816"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p59792530383"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li149791753183816"></a><a name="en-us_topic_0000002055322402_li149791753183816"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b29791953193816">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li149791553203813"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19979753163813"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li149791553203813"></a><a name="en-us_topic_0000002055322402_li149791553203813"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b8979153173819">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li129793531389"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p897935317382"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li129793531389"></a><a name="en-us_topic_0000002055322402_li129793531389"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1697935316381">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li197918532385"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3979145310389"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li197918532385"></a><a name="en-us_topic_0000002055322402_li197918532385"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b139791053173814">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1497965383817"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p2979105312380"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1497965383817"></a><a name="en-us_topic_0000002055322402_li1497965383817"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b149796536383">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li797915314381"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p39799530382"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li797915314381"></a><a name="en-us_topic_0000002055322402_li797915314381"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b169791753103815">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li19791536382"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p16979653143811"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li19791536382"></a><a name="en-us_topic_0000002055322402_li19791536382"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1997905311382">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li149795538388"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p8979115333810"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li149795538388"></a><a name="en-us_topic_0000002055322402_li149795538388"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b14979105333814">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li169791353113813"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p149792538388"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li169791353113813"></a><a name="en-us_topic_0000002055322402_li169791353113813"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1979753183810">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li8980155333815"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1198055320380"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li8980155333815"></a><a name="en-us_topic_0000002055322402_li8980155333815"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b15980155320385">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li129801853133810"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p29804537383"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li129801853133810"></a><a name="en-us_topic_0000002055322402_li129801853133810"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b9980153173813">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li4980653203816"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p29802530382"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li4980653203816"></a><a name="en-us_topic_0000002055322402_li4980653203816"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b15980753163817">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1798065343814"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3980125318384"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1798065343814"></a><a name="en-us_topic_0000002055322402_li1798065343814"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b11980125319389">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1997535353820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1598013539383">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1898017531387">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p169801653193812">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row09751653133813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p398012533386">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p39802534382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1798095316385">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row59763531381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p11980125313382">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p39807536389"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p3981175316382">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row8976165314381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15981175317388">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_0000002374896605__en-us_topic_0000002055322402_p169810536383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p14981135343817">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b129815530384">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row14976175393811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p11981653153814">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p109815533382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1598165311388">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul69819534388"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li11981125353813"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p998165311388"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li11981125353813"></a><a name="en-us_topic_0000002055322402_li11981125353813"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b2981553183811">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li99811153143817"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p698115333814"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li99811153143817"></a><a name="en-us_topic_0000002055322402_li99811153143817"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b11981175317387">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row997685373819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p16981155393817">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_0000002374896605__en-us_topic_0000002055322402_p6981125333817">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_0000002374896605__en-us_topic_0000002055322402_p1198105333812">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p998125312383">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1698135383815">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3982165320384">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row11976353173811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p18982165313811">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p11982153113813"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p1198285313818">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row18982125373814"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p164999547387">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_0000002374896605__en-us_topic_0000002055322402_p13499954123817">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_0000002374896605__en-us_topic_0000002055322402_p1649917545389">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row198265353817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p104991254123811">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_0000002374896605__en-us_topic_0000002055322402_p154991454103815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p134991754143819">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row598255353811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p7499145483815">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p17499105453812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p24995549387">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul74991254193810"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li18499135418385"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p249910540384"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li18499135418385"></a><a name="en-us_topic_0000002055322402_li18499135418385"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b20499135483810">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li16499205411383"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1499115413810"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li16499205411383"></a><a name="en-us_topic_0000002055322402_li16499205411383"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1849975415386">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li12499054153815"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p185001054103813"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li12499054153815"></a><a name="en-us_topic_0000002055322402_li12499054153815"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b17500105419381">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li750017546387"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p550025416386"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li750017546387"></a><a name="en-us_topic_0000002055322402_li750017546387"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b650065418382">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row7982175333819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15001754103812">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p250055453811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19500115413815">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul1450019544387"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1650017548389"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1850015412386"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1650017548389"></a><a name="en-us_topic_0000002055322402_li1650017548389"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1450095463816">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1350014546387"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p9500185415387"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1350014546387"></a><a name="en-us_topic_0000002055322402_li1350014546387"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b2500205417383">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li750065410389"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p20500165483816"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li750065410389"></a><a name="en-us_topic_0000002055322402_li750065410389"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1150014540386">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li185001054203817"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p55001554113817"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li185001054203817"></a><a name="en-us_topic_0000002055322402_li185001054203817"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b25004541386">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row2098215315384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p6500135414388">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_0000002374896605__en-us_topic_0000002055322402_p8500105423810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p150015543383">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row698511532380"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1650016542380">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_0000002374896605__en-us_topic_0000002055322402_p14500205420388">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_0000002374896605__en-us_topic_0000002055322402_p950075423819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row16985175393814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p4500145418384">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_0000002374896605__en-us_topic_0000002055322402_p15500135418383">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_0000002374896605__en-us_topic_0000002055322402_p450025463812">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_0000002374896605__en-us_topic_0000002055322402_row79851853193817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p9500145415384">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_0000002374896605__en-us_topic_0000002055322402_p11500154173812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p195001054143817">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul8500165493816"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li17500154193815"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1350075443817"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li17500154193815"></a><a name="en-us_topic_0000002055322402_li17500154193815"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b750085415383">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li550085414388"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p4500654113818"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li550085414388"></a><a name="en-us_topic_0000002055322402_li550085414388"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b10500054203817">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row12985205311384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p12500125415381">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_0000002374896605__en-us_topic_0000002055322402_p15001154173817">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_0000002374896605__en-us_topic_0000002055322402_p16500205416386">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_0000002374896605__en-us_topic_0000002055322402_row19985105318387"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p350095419384">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1250095413389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1550015547387">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul145019542381"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1250115417388"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p17501754113820"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1250115417388"></a><a name="en-us_topic_0000002055322402_li1250115417388"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b14501125463812">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550105433819"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1501165413815"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550105433819"></a><a name="en-us_topic_0000002055322402_li1550105433819"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1850118542381">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row129861053183817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p650175413817">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p12501185412389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p5501115411383">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row169881953123816"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p9501105418382">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_0000002374896605__en-us_topic_0000002055322402_p3501205420381">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_0000002374896605__en-us_topic_0000002055322402_p25011547382">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row69881153163811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1250111543384">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1350165403811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19501145433810">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul12501125463819"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li13501254123818"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p65011354133815"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li13501254123818"></a><a name="en-us_topic_0000002055322402_li13501254123818"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b850112546389">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li20501185410388"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p125011546381"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li20501185410388"></a><a name="en-us_topic_0000002055322402_li20501185410388"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1350116549381">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1898812531388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p14501165443812">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_0000002374896605__en-us_topic_0000002055322402_p3501115416383">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p0501105443819">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row19887530383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p115018541381">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p195011354163818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p6501195412383">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1398819537384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p0501115410384">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_0000002374896605__en-us_topic_0000002055322402_p195011542382">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_0000002374896605__en-us_topic_0000002055322402_p8501145412382">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul6501145418386"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li17501554153812"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3501354183817"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li17501554153812"></a><a name="en-us_topic_0000002055322402_li17501554153812"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b105011154123810">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550113545389"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p185010546387"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550113545389"></a><a name="en-us_topic_0000002055322402_li1550113545389"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b150135413815">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_0000002374896605__en-us_topic_0000002055322402_row2098885316385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1501954163815">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p17501135483817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1550175411388">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_0000002374896605__en-us_topic_0000002055322402_row79881453163812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p175011054193818">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p205021154113816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p65021540383">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_0000002374896605__en-us_topic_0000002055322402_row3988175313814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p2502954203815">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p175026541388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1502854113811">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b185029545385">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row19988553183818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p75024548389">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19502115433816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p195022054103817">Image source, which defaults to <strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b16502454193819">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul5502354153812"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li650215414383"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p195020544383"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li650215414383"></a><a name="en-us_topic_0000002055322402_li650215414383"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b17502354133811">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li15502854113812"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p135021054133812"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li15502854113812"></a><a name="en-us_topic_0000002055322402_li15502854113812"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1550225416384">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row898875315381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p450217543381">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_0000002374896605__en-us_topic_0000002055322402_p550215545387">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_0000002374896605__en-us_topic_0000002055322402_p9502185403812">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul1150275433817"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li13502154173816"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3502125403810"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li13502154173816"></a><a name="en-us_topic_0000002055322402_li13502154173816"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b205021654123814">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1950211547386"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p2502205410385"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1950211547386"></a><a name="en-us_topic_0000002055322402_li1950211547386"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1750213549385">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row198817532383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p650235433812">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_0000002374896605__en-us_topic_0000002055322402_p350235414383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15502175415384">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul550216548387"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li195021547381"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p175024546387"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li195021547381"></a><a name="en-us_topic_0000002055322402_li195021547381"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b12502125414389">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li14502125410389"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15029549389"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li14502125410389"></a><a name="en-us_topic_0000002055322402_li14502125410389"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b155027546385">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550285410388"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p450225415388"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550285410388"></a><a name="en-us_topic_0000002055322402_li1550285410388"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li6502175493813"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p550210542383"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li6502175493813"></a><a name="en-us_topic_0000002055322402_li6502175493813"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550211543383"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p05021254153812"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550211543383"></a><a name="en-us_topic_0000002055322402_li1550211543383"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row189881053153817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p18502105414385">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19502054153820">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p850295403811">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row2098835383819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p25021354193819">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p250216542385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1450216544388">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul14502854163820"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1150215493810"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p185021554133812"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1150215493810"></a><a name="en-us_topic_0000002055322402_li1150215493810"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b165025547388">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1050235415386"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p125021054163814"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1050235415386"></a><a name="en-us_topic_0000002055322402_li1050235415386"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b12502135416386">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li9502125453818"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1850275420380"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li9502125453818"></a><a name="en-us_topic_0000002055322402_li9502125453818"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1050245483816">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li950215414387"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1550215545383"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li950215414387"></a><a name="en-us_topic_0000002055322402_li950215414387"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b850225413812">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550214547385"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p17502185493817"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1550214547385"></a><a name="en-us_topic_0000002055322402_li1550214547385"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1050219548383">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1503854183818"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p6503155419389"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1503854183818"></a><a name="en-us_topic_0000002055322402_li1503854183818"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b16503954153814">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_0000002374896605__en-us_topic_0000002055322402_row1098895323816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p185030547384">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_0000002374896605__en-us_topic_0000002055322402_p145036542385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p13503354183813">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row79881053193817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p25031354203813">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_0000002374896605__en-us_topic_0000002055322402_p1550325463819">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_0000002374896605__en-us_topic_0000002055322402_p25031954103811">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul85031354153813"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li2503105433812"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p750355420389"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li2503105433812"></a><a name="en-us_topic_0000002055322402_li2503105433812"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b35033545389">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li18503354123820"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1150319540381"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li18503354123820"></a><a name="en-us_topic_0000002055322402_li18503354123820"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1050316546383">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row5988145313814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p2050365403819">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_0000002374896605__en-us_topic_0000002055322402_p4503105411384">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p125031854143819">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1798813530382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p7503175443813">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3503165420387">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p7503105410380">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row16988653183812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p7503165410388">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p17503354103815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p250335418389">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul1350325417388"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li350319544389"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1750305416385"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li350319544389"></a><a name="en-us_topic_0000002055322402_li350319544389"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1150305493813">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1450314543380"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p65036548389"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1450314543380"></a><a name="en-us_topic_0000002055322402_li1450314543380"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1150313543387">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row11988195317385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p16503105411389">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_0000002374896605__en-us_topic_0000002055322402_p1350319543388">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1350345443816">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row898805313382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p650305463810">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1150375418381">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p10503254123812">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul2050318549387"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li6503354173814"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p4503954193813"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li6503354173814"></a><a name="en-us_topic_0000002055322402_li6503354173814"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b14503854123817">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li45031654113815"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p18503175414387"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li45031654113815"></a><a name="en-us_topic_0000002055322402_li45031654113815"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b105031545385">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row11989553153813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p150325483811">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_0000002374896605__en-us_topic_0000002055322402_p1250375453814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p8503145413383">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b550315473820">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row1999375343816"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p205041654153818">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_0000002374896605__en-us_topic_0000002055322402_p175044547384">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_0000002374896605__en-us_topic_0000002055322402_p8504175417385">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row799318532382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p55041954163810">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_0000002374896605__en-us_topic_0000002055322402_p65045543385">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p9504854133812">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row159932534381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p850445423812">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p95041654103813">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p14504125453819">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_0000002374896605__en-us_topic_0000002055322402_row19993145318385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1050414543381">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1750417548389">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1950435417381">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row12993553173817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p25041354143814">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p550419547380">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p550425403813">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul15504145463817"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li450435493811"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p75041544386"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li450435493811"></a><a name="en-us_topic_0000002055322402_li450435493811"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li125041454113818"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p85047542384"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li125041454113818"></a><a name="en-us_topic_0000002055322402_li125041454113818"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row8993185313811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19504754133818">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_0000002374896605__en-us_topic_0000002055322402_p17504105413816">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p95041548385">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_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row129953537387"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p185046541383">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_0000002374896605__en-us_topic_0000002055322402_p18504105416381">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_0000002374896605__en-us_topic_0000002055322402_p115045547384">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row899535317380"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15504175433812">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p145041154113815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p125041354103810">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row999519532388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p75043547389">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p05048545383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15504205414381">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row7996205320388"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1850485414383">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_0000002374896605__en-us_topic_0000002055322402_p75041354103816">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_0000002374896605__en-us_topic_0000002055322402_p135041454143817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1899685315383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p4505125483812">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1650511547383">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p95058548382">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_0000002374896605__en-us_topic_0000002055322402_row99961953153812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p650545410383">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p11505195412385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p12505165413813">Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_i145051054143813">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul18505185473818"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1505135463811"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1550505463818"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li1505135463811"></a><a name="en-us_topic_0000002055322402_li1505135463811"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b1050585483815">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li3505115413810"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p125053546388"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li3505115413810"></a><a name="en-us_topic_0000002055322402_li3505115413810"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b145055541388">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row2099665343819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p6505185453818">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_0000002374896605__en-us_topic_0000002055322402_p10505145473811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p250515541381">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b2050595419381">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1899613538386"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p950595413386">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p16505115423817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p17505554123817">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_ul17505195453814"><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li950512541389"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p550575413816"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li950512541389"></a><a name="en-us_topic_0000002055322402_li950512541389"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b165055544386">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li175054541383"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p10505854163814"><a name="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_li175054541383"></a><a name="en-us_topic_0000002055322402_li175054541383"></a><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b18505125417380">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b145051854113818">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row1399695353814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p4505175463813">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15505195423812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p0505185433818">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b45051454163813">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_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row1199711537386"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p165051254193810">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_0000002374896605__en-us_topic_0000002055322402_p1350555411388">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_0000002374896605__en-us_topic_0000002055322402_p1150555419382">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row11997953113811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p13505354103815">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p19505125419383"><a href="#EN-US_TOPIC_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_p05051854183812">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row79973530380"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p150525410384">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p16505205463812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1250595419388">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row199971753113812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1050585411386">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p75053543388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p150535463815">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374896605__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_0000002374896605__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_0000002374896605__en-us_topic_0000002055322402_row1199855314382"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1850545463818">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_0000002374896605__en-us_topic_0000002055322402_p450575443817">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_0000002374896605__en-us_topic_0000002055322402_p650505419385">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row99981453163811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1750635418382">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1150695423816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p950613546386">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row6998653153810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p115066548386">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1750614544383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p250635443816">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_section750625433817"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_screen19506105443820">{
"description" : "update"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_section950612543389"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p5506254113816"><strong id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_b0506854153812">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p105061454183818">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_screen45064543380">{
"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_0000002374896605__en-us_topic_0000002055322402_section350618549381"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row702542381"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p150615473815">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_0000002374896605__en-us_topic_0000002055322402_p175061854153815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row120145493813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1150645420385">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p150655443818">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row30145423814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p1350615544382">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p115061454123811">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row13075443813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p11506154203818">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p650635418381">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row13025463812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p15506195419382">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p3506115417389">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_row70854173810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p14506125423813">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p8506195415388">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_section7506115410388"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002374896605__en-us_topic_0000002055322402_p5506205483810">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