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

1129 lines
108 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002268726213"></a><a name="EN-US_TOPIC_0000002268726213"></a>
<h1 class="topictitle1">Creating a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002268726213__section1376319370335"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002268726213__p1764153793317">You can create a notebook instance based on the specified instance specifications, AI engine images, and storage parameters. You can access the notebook instance through the web page or SSH client.</p>
<p id="EN-US_TOPIC_0000002268726213__p12764153712336">Calling this API is an asynchronous operation. You can obtain the status of a notebook instance by calling the API for querying notebook instance details.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002268726213__section1876418375334"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002268726213__p976473743318">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002268726213__section0764173719334"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002268726213__p11764437143315">POST /v1/{project_id}/notebooks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__table376513372332" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row576543723319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002268726213__p1576510379339">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_0000002268726213__p20765123719334">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_0000002268726213__p1776633773319">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_0000002268726213__p12766193715333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row27651337133313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1276612379331">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_0000002268726213__p127661137143319">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p77661537183314">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p107662374336">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_0000002268726213__section476783717333"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_NotebookCreateRequest" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row8767193723311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000002268726213__p476913773320">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_0000002268726213__p20769337183310">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_0000002268726213__p107691537123318">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_0000002268726213__p1376963714333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row1276863783318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p176912376334">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p11769203783317">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p677016375334">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p6770193713313">Instance description. The value contains a maximum of 512 characters and cannot contain the following characters: &amp;&lt;&gt;"'/.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row137683372335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p9770143743318">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p20770113723318">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p10770737173319">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p677053711334">Running duration starting from the current time. It is recommended that this attribute be configured in leaseReq. If this attribute has a value, the value of leaseReq is ignored and the automatic instance stop type is scheduled stop. Unit: ms.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row07681537143318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p977033743320">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p3771037103318">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p2771937193310">Array of <a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p477143718334">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_0000002268726213__row15768113711337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1477113377334">feature</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1777123733314">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p27711372339">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p1771183718334">Instance type. The default value is <strong id="EN-US_TOPIC_0000002268726213__b157711837123312">NOTEBOOK</strong>. Options:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul12771133718338"><li id="EN-US_TOPIC_0000002268726213__li19771137123316"><p id="EN-US_TOPIC_0000002268726213__p107711337113310"><a name="EN-US_TOPIC_0000002268726213__li19771137123316"></a><a name="li19771137123316"></a><strong id="EN-US_TOPIC_0000002268726213__b10771637123313">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li18771737123315"><p id="EN-US_TOPIC_0000002268726213__p27711937133313"><a name="EN-US_TOPIC_0000002268726213__li18771737123315"></a><a name="li18771737123315"></a><strong id="EN-US_TOPIC_0000002268726213__b1877119373330">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row27681037123313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1877293713319">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1777223773311">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p07727372330">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p187721937193313">Instance flavor. The following flavors are for reference only. Obtain the flavors displayed on the console in the target region.</p>
<ul id="EN-US_TOPIC_0000002268726213__ul1677210375333"><li id="EN-US_TOPIC_0000002268726213__li1772837193318"><p id="EN-US_TOPIC_0000002268726213__p197721737153313"><a name="EN-US_TOPIC_0000002268726213__li1772837193318"></a><a name="li1772837193318"></a><strong id="EN-US_TOPIC_0000002268726213__b677213378335">modelarts.vm.cpu.2u</strong>: General-purpose Intel CPU flavor, ideal for rapid data exploration and experiments</p>
</li><li id="EN-US_TOPIC_0000002268726213__li9772153715338"><p id="EN-US_TOPIC_0000002268726213__p877203773315"><a name="EN-US_TOPIC_0000002268726213__li9772153715338"></a><a name="li9772153715338"></a><strong id="EN-US_TOPIC_0000002268726213__b677253733317">modelarts.vm.cpu.8u</strong>: General computing-plus Intel CPU flavors, ideal for compute-intensive applications</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1876883717332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p13772143783310">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_0000002268726213__p377243710338">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p18772173712332">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p177315379331">Specifies the image ID of the notebook instance to be created. The image ID is in the Universally Unique Identifier (UUID) format. You can obtain the image ID by calling the ListImage.xml interface.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row197681237133313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p147731337153314">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p2773143713331">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p977373719335">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p9773137193314">Instance name, which contains a maximum of 128 characters, including letters, digits, hyphens (-), and underscores (_). Instance names can be duplicate.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row176843783319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p137733377338">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p97737370332">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p18773133711336">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p477315372335">ID of a dedicated resource pool, for example, <strong id="EN-US_TOPIC_0000002268726213__b16773103710339">pool41664192</strong>. This parameter is mandatory if a dedicated resource pool needs to be specified for creating an instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row147681537123314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p11773537153319">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p7774937163315">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p15774237113315"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_VolumeReq">VolumeReq</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_0000002268726213__p37747371333">Storage volume.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row8768143733314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p137743370331">workspace_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p6774337153314">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p5774237113313">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p977403723311">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002268726213__b37741337193310">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row67681537153315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1777415376339">hooks</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p67741375336">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p97741837203314"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p47751637153319">Customized startup script hook configuration.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row9768203714333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1477519375332">lease</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p167758374334">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p157751037153312"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_LeaseReq">LeaseReq</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_0000002268726213__p9775173718335">Instance lease configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_EndpointsReq"></a><a name="en-us_topic_0000002055322398_request_EndpointsReq"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_EndpointsReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>EndpointsReq</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row1977573743315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000002268726213__p15776113711332">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_0000002268726213__p67761437113315">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_0000002268726213__p197768379339">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_0000002268726213__p5776337173311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row5775737133314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p277683753312">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_0000002268726213__p3776103720330">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p7776163713316">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_0000002268726213__p277616370336">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_0000002268726213__row127751937173316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p13777143763315">service</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p10777037103312">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p207772372330">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p15777143723314">Supported service. Possible values are as follows:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul67771337123312"><li id="EN-US_TOPIC_0000002268726213__li2777637113317"><p id="EN-US_TOPIC_0000002268726213__p1477763733317"><a name="EN-US_TOPIC_0000002268726213__li2777637113317"></a><a name="li2777637113317"></a><strong id="EN-US_TOPIC_0000002268726213__b16777183713316">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li18777437203311"><p id="EN-US_TOPIC_0000002268726213__p77771237163311"><a name="EN-US_TOPIC_0000002268726213__li18777437203311"></a><a name="li18777437203311"></a><strong id="EN-US_TOPIC_0000002268726213__b17777123710333">SSH</strong>: You can remotely access notebook instances through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1775937133313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p15777437113310">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_0000002268726213__p2777113713313">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p4777637103319">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_0000002268726213__p167781137193317">Name of the SSH key pair, which can be created and viewed on the <strong id="EN-US_TOPIC_0000002268726213__b1377873733313">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_0000002268726213__en-us_topic_0000002055322398_request_VolumeReq"></a><a name="en-us_topic_0000002055322398_request_VolumeReq"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_VolumeReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>VolumeReq</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row3778133717337"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000002268726213__p207802376337">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_0000002268726213__p578018378335">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_0000002268726213__p978063713330">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_0000002268726213__p16780337133310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row1977953713312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p107801837113319">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1778043711336">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p97801737143317">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p378003793318">Storage capacity. The default value is 5 GB for EVS. The maximum value is 4096 GB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row10779123712334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p8780637163312">category</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1778063717332">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p14780193719331">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p0781203710331">Supported storage types. For details about the differences between the storage types, see"Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002268726213__i1778153793312">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul187815373338"><li id="EN-US_TOPIC_0000002268726213__li578143717335"><p id="EN-US_TOPIC_0000002268726213__p2781143711330"><a name="EN-US_TOPIC_0000002268726213__li578143717335"></a><a name="li578143717335"></a><strong id="EN-US_TOPIC_0000002268726213__b97811437103310">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002268726213__li177811337193311"><p id="EN-US_TOPIC_0000002268726213__p578123773319"><a name="EN-US_TOPIC_0000002268726213__li177811337193311"></a><a name="li177811337193311"></a><strong id="EN-US_TOPIC_0000002268726213__b478123763320">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row177943733310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p378113763310">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p5781103793313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p137811637203315">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p1878119371338">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul67814372333"><li id="EN-US_TOPIC_0000002268726213__li0781173718332"><p id="EN-US_TOPIC_0000002268726213__p678173763318"><a name="EN-US_TOPIC_0000002268726213__li0781173718332"></a><a name="li0781173718332"></a><strong id="EN-US_TOPIC_0000002268726213__b278253711339">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li1378203719333"><p id="EN-US_TOPIC_0000002268726213__p5782113723318"><a name="EN-US_TOPIC_0000002268726213__li1378203719333"></a><a name="li1378203719333"></a><strong id="EN-US_TOPIC_0000002268726213__b17782237183312">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002268726213__b1878213723320">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row37791637173312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p15782173723314">uri</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p07821737133316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p47821237143316">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p37827372334">Disk URI of the EFS. This parameter is mandatory only when the instance category is <strong id="EN-US_TOPIC_0000002268726213__b197822037153320">EFS</strong> and the ownership is <strong id="EN-US_TOPIC_0000002268726213__b13782113773320">DEDICATED</strong>.</p>
<p id="EN-US_TOPIC_0000002268726213__p127828377338">Log in to the SFS console. In the file system list, click the file system name to go to the file system details page. The shared path is the value of this parameter.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row13779103783314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p11782113743316">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p2782163713311">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p127831537133313">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p678393717335">Disk ID of the EFS. This parameter is mandatory only when the instance category is <strong id="EN-US_TOPIC_0000002268726213__b1178311373331">EFS</strong> and the ownership is <strong id="EN-US_TOPIC_0000002268726213__b14783113723310">DEDICATED</strong>. This parameter is mandatory.</p>
<p id="EN-US_TOPIC_0000002268726213__p778333793311">To obtain the parameter value, log in to the SFS console. In the file system list, click the file system name to go to the file system details page. <strong id="EN-US_TOPIC_0000002268726213__b678323710334">ID</strong> is the value of this parameter.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_CustomHooks"></a><a name="en-us_topic_0000002055322398_request_CustomHooks"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_CustomHooks" frame="border" border="1" rules="all"><caption><b>Table 5 </b>CustomHooks</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row1578363718336"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000002268726213__p278463703311">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_0000002268726213__p4784037173316">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_0000002268726213__p19784123718331">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_0000002268726213__p107841637123317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row1278314375335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p127841137113311">container_hooks</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1578463710331">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p078411379333"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_ContainerHooks">ContainerHooks</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_0000002268726213__p278414373332">Container-related hook configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_ContainerHooks"></a><a name="en-us_topic_0000002055322398_request_ContainerHooks"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_ContainerHooks" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ContainerHooks</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row20785143723320"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="EN-US_TOPIC_0000002268726213__p197859376331">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_0000002268726213__p1378553712332">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_0000002268726213__p137851137133314">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_0000002268726213__p7786937133317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row2078593711333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p5786143718331">post_start</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p378616370337">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p47878373332"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_Config">Config</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p1978773733313">Configure the script after the service is started.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row15785337183315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p4787837153316">pre_start</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p14788163723316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p6788937183313"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_Config">Config</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p177881637193318">Configure the script before starting the service.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_Config"></a><a name="en-us_topic_0000002055322398_request_Config"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_Config" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Config</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row0788143714333"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.1"><p id="EN-US_TOPIC_0000002268726213__p157891437193318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.2"><p id="EN-US_TOPIC_0000002268726213__p878914377331">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.3"><p id="EN-US_TOPIC_0000002268726213__p2789143719332">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.7.2.5.1.4"><p id="EN-US_TOPIC_0000002268726213__p3789193713339">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row1378833713312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1378903718332">script</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1278913377333">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p16789203743315">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p15789193763315">User-defined script content (Base64 encoding) or absolute script path.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1878823717339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p07901379338">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p2790193743311">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p11790737183320">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p18790113733317">Script type.</p>
<ul id="EN-US_TOPIC_0000002268726213__ul117908374335"><li id="EN-US_TOPIC_0000002268726213__li5790153711339"><p id="EN-US_TOPIC_0000002268726213__p179017378339"><a name="EN-US_TOPIC_0000002268726213__li5790153711339"></a><a name="li5790153711339"></a><strong id="EN-US_TOPIC_0000002268726213__b15790133711334">COMMAND</strong>: The script content (Base64-encoded) must be specified.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li17902037183314"><p id="EN-US_TOPIC_0000002268726213__p20790203717335"><a name="EN-US_TOPIC_0000002268726213__li17902037183314"></a><a name="li17902037183314"></a><strong id="EN-US_TOPIC_0000002268726213__b1879010379332">SCRIPT</strong> (default): The script path must be specified.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_LeaseReq"></a><a name="en-us_topic_0000002055322398_request_LeaseReq"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_request_LeaseReq" frame="border" border="1" rules="all"><caption><b>Table 8 </b>LeaseReq</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row379073763320"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.1"><p id="EN-US_TOPIC_0000002268726213__p1279113713331">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.2"><p id="EN-US_TOPIC_0000002268726213__p147911137183310">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.3"><p id="EN-US_TOPIC_0000002268726213__p14791163733317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.8.2.5.1.4"><p id="EN-US_TOPIC_0000002268726213__p1479143783317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row8790133713336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p19791153753313">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p179110370339">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p6792937123314">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.8.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p1792837123314">Indicates the running duration starting from the current time. After the running duration expires, the system automatically stops. Unit: ms.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row10791183753319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.1 "><p id="EN-US_TOPIC_0000002268726213__p197921237123315">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.2 "><p id="EN-US_TOPIC_0000002268726213__p12792123713330">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.3 "><p id="EN-US_TOPIC_0000002268726213__p779213783318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.8.2.5.1.4 "><p id="EN-US_TOPIC_0000002268726213__p2079223715334">Automatic stop type. The default value is timing.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002268726213__section779243713315"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002268726213__p07921937183318"><strong id="EN-US_TOPIC_0000002268726213__b19793137173312">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row17931137143313"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p1679553718337">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_0000002268726213__p207959375334">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_0000002268726213__p1679583711334">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row2793537153312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p11795237143313">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_0000002268726213__p137956377336">Array of <a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p14796143753314">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row20793123793314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p379653793318">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1879619374332">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p679673783312">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row579363716330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p167961737133312">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p117962372331">Array of <a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p121291938193316">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_0000002268726213__row1479412379337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p31291638133313">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_0000002268726213__p20129133823315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1512913813338">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1379493723312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p51291938113315">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p141292038143316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p9129133810332">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1279419376338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p17129138133312">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p2129153819333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p512983893314">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row12794153711339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p7129113843312">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p01298381332"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p51298381332">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row16794637163313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p31291384334">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p15129193816333"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p312933843312">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1794123733317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p18129738123314">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p11129138103317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1912993863319">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row7794037103313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p6129183817334">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p12129113813334"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p212911388335">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_0000002268726213__row17941137143310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p612920384330">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p12129538133312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p111297385336">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul191291138113313"><li id="EN-US_TOPIC_0000002268726213__li2129153816335"><p id="EN-US_TOPIC_0000002268726213__p912918381331"><a name="EN-US_TOPIC_0000002268726213__li2129153816335"></a><a name="li2129153816335"></a><strong id="EN-US_TOPIC_0000002268726213__b412963853312">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li91301938183311"><p id="EN-US_TOPIC_0000002268726213__p1313073863318"><a name="EN-US_TOPIC_0000002268726213__li91301938183311"></a><a name="li91301938183311"></a><strong id="EN-US_TOPIC_0000002268726213__b1130133815333">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li6130193823316"><p id="EN-US_TOPIC_0000002268726213__p213033815336"><a name="EN-US_TOPIC_0000002268726213__li6130193823316"></a><a name="li6130193823316"></a><strong id="EN-US_TOPIC_0000002268726213__b71301438183314">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li17130113819333"><p id="EN-US_TOPIC_0000002268726213__p1613013816331"><a name="EN-US_TOPIC_0000002268726213__li17130113819333"></a><a name="li17130113819333"></a><strong id="EN-US_TOPIC_0000002268726213__b1513011389334">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li16130103812337"><p id="EN-US_TOPIC_0000002268726213__p11130193815339"><a name="EN-US_TOPIC_0000002268726213__li16130103812337"></a><a name="li16130103812337"></a><strong id="EN-US_TOPIC_0000002268726213__b1213093833310">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li12130838153313"><p id="EN-US_TOPIC_0000002268726213__p91303388338"><a name="EN-US_TOPIC_0000002268726213__li12130838153313"></a><a name="li12130838153313"></a><strong id="EN-US_TOPIC_0000002268726213__b113016388337">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li19130183818339"><p id="EN-US_TOPIC_0000002268726213__p413014381333"><a name="EN-US_TOPIC_0000002268726213__li19130183818339"></a><a name="li19130183818339"></a><strong id="EN-US_TOPIC_0000002268726213__b121301838183314">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li16130173873315"><p id="EN-US_TOPIC_0000002268726213__p41305389337"><a name="EN-US_TOPIC_0000002268726213__li16130173873315"></a><a name="li16130173873315"></a><strong id="EN-US_TOPIC_0000002268726213__b1130338113319">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li5130838163312"><p id="EN-US_TOPIC_0000002268726213__p3130173823312"><a name="EN-US_TOPIC_0000002268726213__li5130838163312"></a><a name="li5130838163312"></a><strong id="EN-US_TOPIC_0000002268726213__b7130133803315">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li8130153810337"><p id="EN-US_TOPIC_0000002268726213__p013020389335"><a name="EN-US_TOPIC_0000002268726213__li8130153810337"></a><a name="li8130153810337"></a><strong id="EN-US_TOPIC_0000002268726213__b12130038143315">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li51301738193319"><p id="EN-US_TOPIC_0000002268726213__p1713015384332"><a name="EN-US_TOPIC_0000002268726213__li51301738193319"></a><a name="li51301738193319"></a><strong id="EN-US_TOPIC_0000002268726213__b613013812332">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li1713019386336"><p id="EN-US_TOPIC_0000002268726213__p41301838123313"><a name="EN-US_TOPIC_0000002268726213__li1713019386336"></a><a name="li1713019386336"></a><strong id="EN-US_TOPIC_0000002268726213__b9130113873312">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li13130193818331"><p id="EN-US_TOPIC_0000002268726213__p1113093816338"><a name="EN-US_TOPIC_0000002268726213__li13130193818331"></a><a name="li13130193818331"></a><strong id="EN-US_TOPIC_0000002268726213__b4130133873314">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li113019386332"><p id="EN-US_TOPIC_0000002268726213__p19130638203316"><a name="EN-US_TOPIC_0000002268726213__li113019386332"></a><a name="li113019386332"></a><strong id="EN-US_TOPIC_0000002268726213__b6130203818336">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row97941737163317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p0130113853313">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p18130438193313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p101305389331">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row479443710331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p613019388333">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p31301838203316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p5130123813313">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row197941237143310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p3130938113316">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1713063823312"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p10130203812335">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row11794153783312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1213053814334">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_0000002268726213__p7130238193316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p9130183893312">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002268726213__b10130113813317">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row8794937123314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p9130113813333">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p121301638133319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p151306382339">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul1313083818332"><li id="EN-US_TOPIC_0000002268726213__li1613073843316"><p id="EN-US_TOPIC_0000002268726213__p14130838173319"><a name="EN-US_TOPIC_0000002268726213__li1613073843316"></a><a name="li1613073843316"></a><strong id="EN-US_TOPIC_0000002268726213__b16130153873318">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li1113183843316"><p id="EN-US_TOPIC_0000002268726213__p31313386333"><a name="EN-US_TOPIC_0000002268726213__li1113183843316"></a><a name="li1113183843316"></a><strong id="EN-US_TOPIC_0000002268726213__b1213123813315">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row12794103717331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p513183863312">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_0000002268726213__p8131838113311">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_0000002268726213__p9131538173312">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002268726213__p81316382338">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002268726213__p61311238173311">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002268726213__p8131133816336">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row18794173763312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p413173813333">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p01311238203316"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p9131173883319">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_JobProgress"></a><a name="en-us_topic_0000002055322398_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 10 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row9803113711337"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p41311838183311">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_0000002268726213__p1513111386339">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_0000002268726213__p19131113810337">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row98032037183313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p113153815336">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_0000002268726213__p613119380331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p15131338133312">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row188033379337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p14131123823316">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1813123873311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p813115382339">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul131311438123315"><li id="EN-US_TOPIC_0000002268726213__li913153823312"><p id="EN-US_TOPIC_0000002268726213__p8131163818337"><a name="EN-US_TOPIC_0000002268726213__li913153823312"></a><a name="li913153823312"></a><strong id="EN-US_TOPIC_0000002268726213__b1113163873320">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li1313133815334"><p id="EN-US_TOPIC_0000002268726213__p513193811337"><a name="EN-US_TOPIC_0000002268726213__li1313133815334"></a><a name="li1313133815334"></a><strong id="EN-US_TOPIC_0000002268726213__b1113103833317">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li6131123863315"><p id="EN-US_TOPIC_0000002268726213__p9131173873311"><a name="EN-US_TOPIC_0000002268726213__li6131123863315"></a><a name="li6131123863315"></a><strong id="EN-US_TOPIC_0000002268726213__b181311738173312">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li11131183816339"><p id="EN-US_TOPIC_0000002268726213__p91311638173311"><a name="EN-US_TOPIC_0000002268726213__li11131183816339"></a><a name="li11131183816339"></a><strong id="EN-US_TOPIC_0000002268726213__b161317385336">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row3803937133313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1131163843319">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p513123812331">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p18131133853314">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul513123893320"><li id="EN-US_TOPIC_0000002268726213__li413183873318"><p id="EN-US_TOPIC_0000002268726213__p313110381336"><a name="EN-US_TOPIC_0000002268726213__li413183873318"></a><a name="li413183873318"></a><strong id="EN-US_TOPIC_0000002268726213__b1713120385339">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li7131143820332"><p id="EN-US_TOPIC_0000002268726213__p61312389337"><a name="EN-US_TOPIC_0000002268726213__li7131143820332"></a><a name="li7131143820332"></a><strong id="EN-US_TOPIC_0000002268726213__b713163823320">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li1913114386337"><p id="EN-US_TOPIC_0000002268726213__p713173803319"><a name="EN-US_TOPIC_0000002268726213__li1913114386337"></a><a name="li1913114386337"></a><strong id="EN-US_TOPIC_0000002268726213__b51311338143312">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li1613163814335"><p id="EN-US_TOPIC_0000002268726213__p20132143819331"><a name="EN-US_TOPIC_0000002268726213__li1613163814335"></a><a name="li1613163814335"></a><strong id="EN-US_TOPIC_0000002268726213__b1013253823318">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row080323733317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p12132123812337">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_0000002268726213__p3132238193320">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p4132238103314">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_EndpointsRes"></a><a name="en-us_topic_0000002055322398_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 11 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row1780563711335"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p19132938163320">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_0000002268726213__p7132738193318">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_0000002268726213__p2132438153318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row1180553743317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p13132338173313">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_0000002268726213__p3132173814332">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_0000002268726213__p1132738143314">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_0000002268726213__row17805123783310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p13132638193312">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_0000002268726213__p4132113810335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p111329389339">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul17132173816337"><li id="EN-US_TOPIC_0000002268726213__li12132183810335"><p id="EN-US_TOPIC_0000002268726213__p20132193883319"><a name="EN-US_TOPIC_0000002268726213__li12132183810335"></a><a name="li12132183810335"></a><strong id="EN-US_TOPIC_0000002268726213__b113283814339">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li19132183820332"><p id="EN-US_TOPIC_0000002268726213__p171321138173311"><a name="EN-US_TOPIC_0000002268726213__li19132183820332"></a><a name="li19132183820332"></a><strong id="EN-US_TOPIC_0000002268726213__b71321038133315">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row78051237103318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p101321383332">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_0000002268726213__p111323382339">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_0000002268726213__p191326387331">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_0000002268726213__row1680618370335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p113253883313">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1113243820339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p8132133813332">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul101329382332"><li id="EN-US_TOPIC_0000002268726213__li181321382338"><p id="EN-US_TOPIC_0000002268726213__p1313253813312"><a name="EN-US_TOPIC_0000002268726213__li181321382338"></a><a name="li181321382338"></a><strong id="EN-US_TOPIC_0000002268726213__b51321138193316">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li10132338163312"><p id="EN-US_TOPIC_0000002268726213__p213217381334"><a name="EN-US_TOPIC_0000002268726213__li10132338163312"></a><a name="li10132338163312"></a><strong id="EN-US_TOPIC_0000002268726213__b1713213853315">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1180633793314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p613233817333">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p151321438133314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1913263814333">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_Image"></a><a name="en-us_topic_0000002055322398_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_Image" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row4808143723310"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p2133183863315">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_0000002268726213__p18133163873318">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_0000002268726213__p91331038173310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row14808737183315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p12133123873313">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p5133193817339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p17133138133318">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul1013303818338"><li id="EN-US_TOPIC_0000002268726213__li8133163873319"><p id="EN-US_TOPIC_0000002268726213__p9133438123312"><a name="EN-US_TOPIC_0000002268726213__li8133163873319"></a><a name="li8133163873319"></a><strong id="EN-US_TOPIC_0000002268726213__b101331838113319">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002268726213__li4133143823310"><p id="EN-US_TOPIC_0000002268726213__p613383823318"><a name="EN-US_TOPIC_0000002268726213__li4133143823310"></a><a name="li4133143823310"></a><strong id="EN-US_TOPIC_0000002268726213__b6133103853313">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row98081837103319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p16133133819335">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_0000002268726213__p14133113843313">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p121331738113313">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row14808193720339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p181331038193311">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1913343863316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p71334383336">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row780815376334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p11133738123317">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_0000002268726213__p91331938113312">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_0000002268726213__p9133103823316">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul191331338103318"><li id="EN-US_TOPIC_0000002268726213__li913343810331"><p id="EN-US_TOPIC_0000002268726213__p151336386333"><a name="EN-US_TOPIC_0000002268726213__li913343810331"></a><a name="li913343810331"></a><strong id="EN-US_TOPIC_0000002268726213__b191330385338">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li17133163818332"><p id="EN-US_TOPIC_0000002268726213__p21331338193313"><a name="EN-US_TOPIC_0000002268726213__li17133163818332"></a><a name="li17133163818332"></a><strong id="EN-US_TOPIC_0000002268726213__b713317388339">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_0000002268726213__row580823719338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1513315385337">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p101333386335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p111334382333">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_0000002268726213__row12808153733319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p10133153816334">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p11331338183314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p4133838113310">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_0000002268726213__row88081937193316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1513319384339">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p8133153812334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p171331538163313">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002268726213__b141331638143315">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row980819375331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1813314388334">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p3133163817334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p513313817337">Image source, which defaults to <strong id="EN-US_TOPIC_0000002268726213__b1133103813310">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul1513313883318"><li id="EN-US_TOPIC_0000002268726213__li813316387332"><p id="EN-US_TOPIC_0000002268726213__p11332381337"><a name="EN-US_TOPIC_0000002268726213__li813316387332"></a><a name="li813316387332"></a><strong id="EN-US_TOPIC_0000002268726213__b9133638123310">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002268726213__li121338386331"><p id="EN-US_TOPIC_0000002268726213__p6133123883317"><a name="EN-US_TOPIC_0000002268726213__li121338386331"></a><a name="li121338386331"></a><strong id="EN-US_TOPIC_0000002268726213__b4133143811332">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row0808153793319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p12133123883315">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_0000002268726213__p1213416381333">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_0000002268726213__p1813412388334">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul51341038173314"><li id="EN-US_TOPIC_0000002268726213__li20134138173319"><p id="EN-US_TOPIC_0000002268726213__p2013413388331"><a name="EN-US_TOPIC_0000002268726213__li20134138173319"></a><a name="li20134138173319"></a><strong id="EN-US_TOPIC_0000002268726213__b201348389337">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002268726213__li5134153818337"><p id="EN-US_TOPIC_0000002268726213__p19134193803320"><a name="EN-US_TOPIC_0000002268726213__li5134153818337"></a><a name="li5134153818337"></a><strong id="EN-US_TOPIC_0000002268726213__b181341838143312">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row680918372339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p91341338123312">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_0000002268726213__p161341338143310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p121341538153312">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul151341038133312"><li id="EN-US_TOPIC_0000002268726213__li713483812337"><p id="EN-US_TOPIC_0000002268726213__p1134183883310"><a name="EN-US_TOPIC_0000002268726213__li713483812337"></a><a name="li713483812337"></a><strong id="EN-US_TOPIC_0000002268726213__b1413463816338">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002268726213__li7134193814338"><p id="EN-US_TOPIC_0000002268726213__p20134113893315"><a name="EN-US_TOPIC_0000002268726213__li7134193814338"></a><a name="li7134193814338"></a><strong id="EN-US_TOPIC_0000002268726213__b161341388337">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002268726213__li3134163853318"><p id="EN-US_TOPIC_0000002268726213__p14134193810335"><a name="EN-US_TOPIC_0000002268726213__li3134163853318"></a><a name="li3134163853318"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002268726213__li14134193843318"><p id="EN-US_TOPIC_0000002268726213__p4134153853311"><a name="EN-US_TOPIC_0000002268726213__li14134193843318"></a><a name="li14134193843318"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002268726213__li413411381336"><p id="EN-US_TOPIC_0000002268726213__p20134153819337"><a name="EN-US_TOPIC_0000002268726213__li413411381336"></a><a name="li413411381336"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row780933717333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p5134638153313">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p17134538173311">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p613403810335">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row178093375335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p3134738133312">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p15134113863319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1313419383337">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul181341038163319"><li id="EN-US_TOPIC_0000002268726213__li31341382338"><p id="EN-US_TOPIC_0000002268726213__p1713410387334"><a name="EN-US_TOPIC_0000002268726213__li31341382338"></a><a name="li31341382338"></a><strong id="EN-US_TOPIC_0000002268726213__b1013473816337">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li9134113823314"><p id="EN-US_TOPIC_0000002268726213__p141342389333"><a name="EN-US_TOPIC_0000002268726213__li9134113823314"></a><a name="li9134113823314"></a><strong id="EN-US_TOPIC_0000002268726213__b61341538123319">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li3134183810330"><p id="EN-US_TOPIC_0000002268726213__p1413413381337"><a name="EN-US_TOPIC_0000002268726213__li3134183810330"></a><a name="li3134183810330"></a><strong id="EN-US_TOPIC_0000002268726213__b11134123813337">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li713473863311"><p id="EN-US_TOPIC_0000002268726213__p111342382335"><a name="EN-US_TOPIC_0000002268726213__li713473863311"></a><a name="li713473863311"></a><strong id="EN-US_TOPIC_0000002268726213__b191341938183316">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li813453823316"><p id="EN-US_TOPIC_0000002268726213__p713473816336"><a name="EN-US_TOPIC_0000002268726213__li813453823316"></a><a name="li813453823316"></a><strong id="EN-US_TOPIC_0000002268726213__b113433811333">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li1213473893317"><p id="EN-US_TOPIC_0000002268726213__p413423818336"><a name="EN-US_TOPIC_0000002268726213__li1213473893317"></a><a name="li1213473893317"></a><strong id="EN-US_TOPIC_0000002268726213__b1613483883319">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_0000002268726213__row48091379337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1813417385336">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_0000002268726213__p17134133813337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p9134113843311">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row980913376333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1813423813330">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_0000002268726213__p1413483811335">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_0000002268726213__p1913483833311">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul181341638173316"><li id="EN-US_TOPIC_0000002268726213__li713443813320"><p id="EN-US_TOPIC_0000002268726213__p1413420388335"><a name="EN-US_TOPIC_0000002268726213__li713443813320"></a><a name="li713443813320"></a><strong id="EN-US_TOPIC_0000002268726213__b2134133812335">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002268726213__li141340389331"><p id="EN-US_TOPIC_0000002268726213__p12135163817338"><a name="EN-US_TOPIC_0000002268726213__li141340389331"></a><a name="li141340389331"></a><strong id="EN-US_TOPIC_0000002268726213__b1913573814338">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row680973793318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p11135113812335">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_0000002268726213__p15135143873314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1313513813335">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row9809537173319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p71351538173316">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p613518383338">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p101351438123312">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1680917377337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p3135123817331">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p14135338163310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1713553815335">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul19135133819333"><li id="EN-US_TOPIC_0000002268726213__li1913533853318"><p id="EN-US_TOPIC_0000002268726213__p713573815331"><a name="EN-US_TOPIC_0000002268726213__li1913533853318"></a><a name="li1913533853318"></a><strong id="EN-US_TOPIC_0000002268726213__b81351238123314">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002268726213__li20135133812336"><p id="EN-US_TOPIC_0000002268726213__p41351438163315"><a name="EN-US_TOPIC_0000002268726213__li20135133812336"></a><a name="li20135133812336"></a><strong id="EN-US_TOPIC_0000002268726213__b1513517382332">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row88090373335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p2013593863314">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_0000002268726213__p21351538113317">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p10135133893317">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1280914371331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p5135638103317">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1813511383339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p2135183813331">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul7135238143315"><li id="EN-US_TOPIC_0000002268726213__li12135143819331"><p id="EN-US_TOPIC_0000002268726213__p61356386335"><a name="EN-US_TOPIC_0000002268726213__li12135143819331"></a><a name="li12135143819331"></a><strong id="EN-US_TOPIC_0000002268726213__b1213514382336">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002268726213__li113573853313"><p id="EN-US_TOPIC_0000002268726213__p11135173883319"><a name="EN-US_TOPIC_0000002268726213__li113573853313"></a><a name="li113573853313"></a><strong id="EN-US_TOPIC_0000002268726213__b1135163873310">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row6811163753318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p12135038153317">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_0000002268726213__p13135123893319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p3135638143312">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002268726213__b31352382333">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row98112037173317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p61354386330">flavor_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p313520381333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p20135153873319">Image resource type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_Lease"></a><a name="en-us_topic_0000002055322398_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row168191037113315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p141357381337">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_0000002268726213__p10135103811335">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_0000002268726213__p14135538123316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row3819237103310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p813683817331">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_0000002268726213__p19136123883316">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p10136133863317">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1281911371331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p413616385334">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p141361138183320">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p4136123823316">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_0000002268726213__row881913374338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p513663863312">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p213612384335">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p111361638133311">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row88195372339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1413612381331">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p113618389334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1213614389337">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002268726213__ul9136113819335"><li id="EN-US_TOPIC_0000002268726213__li14136103812335"><p id="EN-US_TOPIC_0000002268726213__p12136738163313"><a name="EN-US_TOPIC_0000002268726213__li14136103812335"></a><a name="li14136103812335"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li4136153853316"><p id="EN-US_TOPIC_0000002268726213__p0136438133315"><a name="EN-US_TOPIC_0000002268726213__li4136153853316"></a><a name="li4136153853316"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row581914374331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p17136938123311">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_0000002268726213__p41360384331">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p18136143853312">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_0000002268726213__en-us_topic_0000002055322398_response_Pool"></a><a name="en-us_topic_0000002055322398_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row1382214377339"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p1813613818334">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_0000002268726213__p13136133813319">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_0000002268726213__p11136143823316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row8823183713315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p613653853314">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p31362389331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1213603815338">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row982323733310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p11136183853315">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p14136123893318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p4136203833316">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_VolumeRes"></a><a name="en-us_topic_0000002055322398_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 15 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row168241237123311"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p113643818335">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_0000002268726213__p613713893311">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_0000002268726213__p14137938113313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row13824103713334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p121371386332">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p913733818334">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p151371438123314">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_0000002268726213__row382415372337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p201371338103313">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p141371638153318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p11379385335">Supported storage types. For details about the differences between the storage types, see"Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002268726213__i13137143815337">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul713713388337"><li id="EN-US_TOPIC_0000002268726213__li6137153833314"><p id="EN-US_TOPIC_0000002268726213__p6137173823319"><a name="EN-US_TOPIC_0000002268726213__li6137153833314"></a><a name="li6137153833314"></a><strong id="EN-US_TOPIC_0000002268726213__b1013723813334">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002268726213__li713711381332"><p id="EN-US_TOPIC_0000002268726213__p3137153817338"><a name="EN-US_TOPIC_0000002268726213__li713711381332"></a><a name="li713711381332"></a><strong id="EN-US_TOPIC_0000002268726213__b8137183818330">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row6824837163315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1213703843316">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_0000002268726213__p13137153853317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p21378382333">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002268726213__b12137113811339">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row982473710337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1813715389335">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1913716387331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1013753823313">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002268726213__ul51377386335"><li id="EN-US_TOPIC_0000002268726213__li1613712385335"><p id="EN-US_TOPIC_0000002268726213__p1713712385333"><a name="EN-US_TOPIC_0000002268726213__li1613712385335"></a><a name="li1613712385335"></a><strong id="EN-US_TOPIC_0000002268726213__b1713723811331">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002268726213__li11137123823315"><p id="EN-US_TOPIC_0000002268726213__p10137203820336"><a name="EN-US_TOPIC_0000002268726213__li11137123823315"></a><a name="li11137123823315"></a><strong id="EN-US_TOPIC_0000002268726213__b513713388334">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002268726213__b1113717386339">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row882412377333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1413763811336">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1137143816337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p213703817332">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002268726213__b7137193811334">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_0000002268726213__en-us_topic_0000002055322398_response_user"></a><a name="en-us_topic_0000002055322398_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_user" frame="border" border="1" rules="all"><caption><b>Table 16 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row208278375336"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p413853814336">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_0000002268726213__p1513813814336">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_0000002268726213__p1713813853317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row19827133720336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p12138038193317">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p16138123833316"><a href="#EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_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_0000002268726213__p313883873317">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1082713377337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p18138638123318">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p14138838143312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p3138143873317">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row18271737113310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p18138138193317">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p19138038123318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p1713893883315">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_domain"></a><a name="en-us_topic_0000002055322398_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_response_domain" frame="border" border="1" rules="all"><caption><b>Table 17 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row1182812378333"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002268726213__p513853863318">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_0000002268726213__p5138153811337">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_0000002268726213__p013833811336">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row13828837103312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p6138113813331">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p513803883311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p313814381336">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row882818373330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1713853820333">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002268726213__p11138183893316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002268726213__p4138203893316">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002268726213__section81380382334"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002268726213__p4138123803313">The following is an example of how to create a notebook instance whose flavor is <strong id="EN-US_TOPIC_0000002268726213__b11138838123316">modelarts.vm.cpu.2u</strong>, storage type is <strong id="EN-US_TOPIC_0000002268726213__b1413819387332">evs</strong>, ownership is <strong id="EN-US_TOPIC_0000002268726213__b15138103815330">MANAGED</strong>, and storage capacity is 50 GB.</p>
<pre class="screen" id="EN-US_TOPIC_0000002268726213__screen14138103818331">{
"name" : "notebooks_test",
"feature" : "NOTEBOOK",
"workspace_id" : "0",
"description" : "api-test",
"flavor" : "modelarts.vm.cpu.2u",
"image_id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"volume" : {
"category" : "evs",
"ownership" : "managed",
"capacity" : 50
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002268726213__section101381238133315"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002268726213__p4138338183311"><strong id="EN-US_TOPIC_0000002268726213__b413833816330">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002268726213__p1139133819332">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002268726213__screen1813913817339">{
"description" : "api-test",
"feature" : "NOTEBOOK",
"flavor" : "modelarts.vm.cpu.2u",
"id" : "f9937afa-4451-42db-a76b-72d624749f66",
"image" : {
"description" : "description",
"id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
"name" : "notebook2.0-mul-kernel-cpu-cp36",
"swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
"tag" : "3.3.2-release_v1",
"type" : "BUILD_IN"
},
"lease" : {
"create_at" : 1638841744515,
"duration" : 3600000,
"enable" : true,
"type" : "TIMING",
"update_at" : 1638841744515
},
"name" : "notebooks_test",
"status" : "CREATING",
"token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022",
"workspace_id" : "0"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002268726213__section313943803311"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268726213__en-us_topic_0000002055322398_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002268726213__row168311237193315"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002268726213__p19139143893319">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_0000002268726213__p913953893310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268726213__row783123733317"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268726213__p171391538133318">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1013983818333">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row13831937133318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268726213__p41391838113319">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1813912385333">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row17831237193312"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268726213__p18139103810338">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1213920382337">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row1283115379331"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268726213__p4139203816339">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268726213__p1213913811334">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268726213__row8831153733311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268726213__p1413973811338">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268726213__p513913386334">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002268726213__section1913913819334"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002268726213__p191395388330">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