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

1122 lines
133 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002341058378"></a><a name="EN-US_TOPIC_0000002341058378"></a>
<h1 class="topictitle1">Creating a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_section96612536385"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p766145343817">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_0000002341058378__en-us_topic_0000002055322398_p126611653133815">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_0000002341058378__en-us_topic_0000002055322398_section20661195318383"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p96611353173818">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_section1166217538383"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p266285316386">POST /v1/{project_id}/notebooks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_table36625532387" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row14662185311387"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p9662115311383">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_0000002341058378__en-us_topic_0000002055322398_p16663185316385">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_0000002341058378__en-us_topic_0000002055322398_p8663195312380">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_0000002341058378__en-us_topic_0000002055322398_p566395383819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row26628536385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p8663135317384">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_0000002341058378__en-us_topic_0000002055322398_p8663205393813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1866375317384">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p0663853173813">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_0000002341058378__en-us_topic_0000002055322398_section17663135318385"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row76648536382"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p466575311382">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_0000002341058378__en-us_topic_0000002055322398_p166595373811">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_0000002341058378__en-us_topic_0000002055322398_p186651453173815">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_0000002341058378__en-us_topic_0000002055322398_p86659535383">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row3664153123818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p136651953153819">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p766515311384">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p106663534384">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2666195383820">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_0000002341058378__en-us_topic_0000002055322398_row19664153183813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p17666195319382">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1666625353814">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p166620533383">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p7666353193817">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_0000002341058378__en-us_topic_0000002055322398_row5664753163814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15666453153810">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1066685320386">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p12666753123815">Array of <a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p16666155314381">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_0000002341058378__en-us_topic_0000002055322398_row116641153173810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p0666145313389">feature</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p6667653163814">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p146674536389">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1566715323818">Instance type. The default value is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b156671153193812">NOTEBOOK</strong>. Options:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul766765353815"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li136671853173811"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p19667125363816"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li136671853173811"></a><a name="en-us_topic_0000002055322398_li136671853173811"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b866725317381">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li566718530387"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5667853123816"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li566718530387"></a><a name="en-us_topic_0000002055322398_li566718530387"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b12667853123819">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row5664175353819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p156671653123819">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p766725316388">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p206677535388">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p366814539380">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_0000002341058378__en-us_topic_0000002055322398_ul06681053183816"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li7668175333810"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p86681953163814"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li7668175333810"></a><a name="en-us_topic_0000002055322398_li7668175333810"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b13668195343810">modelarts.vm.cpu.2u</strong>: General-purpose Intel CPU flavor, ideal for rapid data exploration and experiments</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li146686537385"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1966815315381"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li146686537385"></a><a name="en-us_topic_0000002055322398_li146686537385"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b17668205319388">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_0000002341058378__en-us_topic_0000002055322398_row76641153123811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p4668105319389">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_0000002341058378__en-us_topic_0000002055322398_p116688537385">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p13668125314381">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10668125393819">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_0000002341058378__en-us_topic_0000002055322398_row17664165323818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p186681353193817">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1066965313382">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p156696537381">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1666911537389">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_0000002341058378__en-us_topic_0000002055322398_row46641053193819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1669175353813">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_0000002341058378__en-us_topic_0000002055322398_p19669353113813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1066945373813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p166965314386">ID of a dedicated resource pool, for example, <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b17669653143817">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_0000002341058378__en-us_topic_0000002055322398_row36641653183819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10669553103817">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p176690533387">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2669195343813"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p136701538388">Storage volume.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row766515353813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p76705537383">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_0000002341058378__en-us_topic_0000002055322398_p16701853103812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15670125316385">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p6670185323814">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1067055310384">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1666585313383"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p9670195314387">hooks</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p166701953203812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5670553173820"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p1067045313380">Customized startup script hook configuration.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row5665185317387"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1670155312388">lease</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p267085317381">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10671155318384"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p136716535380">Instance lease configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row12671115318389"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p267155353817">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_0000002341058378__en-us_topic_0000002055322398_p186721053183819">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_0000002341058378__en-us_topic_0000002055322398_p4672153203816">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_0000002341058378__en-us_topic_0000002055322398_p367205383812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row0671753103811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p166729535383">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_0000002341058378__en-us_topic_0000002055322398_p17672253113817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p116723531383">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_0000002341058378__en-us_topic_0000002055322398_p46724533387">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_0000002341058378__en-us_topic_0000002055322398_row186711853183814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p19672253173816">service</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p196721053193812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10672195311389">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p17672153133818">Supported service. Possible values are as follows:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul1967285333814"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li12672953103814"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p36721753123811"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li12672953103814"></a><a name="en-us_topic_0000002055322398_li12672953103814"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1867375313813">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li267318537387"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p46733538388"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li267318537387"></a><a name="en-us_topic_0000002055322398_li267318537387"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1567325313384">SSH</strong>: You can remotely access notebook instances through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row15671135310383"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p16673125317389">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_0000002341058378__en-us_topic_0000002055322398_p26732053153811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1967375317382">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_0000002341058378__en-us_topic_0000002055322398_p1567385319388">Name of the SSH key pair, which can be created and viewed on the <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b867315537382">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_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row4673195310386"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1167495319385">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_0000002341058378__en-us_topic_0000002055322398_p1767415534389">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_0000002341058378__en-us_topic_0000002055322398_p186741253173813">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_0000002341058378__en-us_topic_0000002055322398_p1267413537386">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1767325314383"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p767415538380">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1067419536381">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p7674175311380">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1967475373817">Storage capacity. The default value is 5 GB for EVS. The maximum value is 4096 GB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row367395312385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p467505319384">category</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p167565313813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1267513538385">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p13675853143817">Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_i86755535385">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul6675553103819"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li8675125314384"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p66751053143819"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li8675125314384"></a><a name="en-us_topic_0000002055322398_li8675125314384"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b86758537384">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li146751953163815"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p567517533388"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li146751953163815"></a><a name="en-us_topic_0000002055322398_li146751953163815"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b8675145313811">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1267495310381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p8675353113820">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p16675195312387">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2675145313811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p186756538386">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul9675175323810"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li8675653153816"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p267545314388"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li8675653153816"></a><a name="en-us_topic_0000002055322398_li8675653153816"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1667614536384">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5676195343819"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1567625323812"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5676195343819"></a><a name="en-us_topic_0000002055322398_li5676195343819"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b206761753163814">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b7676195319385">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1167475323818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p767645343811">uri</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p136766539388">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1367685363813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p176761853123814">Disk URI of the EFS. This parameter is mandatory only when the instance category is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b3676145313386">EFS</strong> and the ownership is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b106766532382">DEDICATED</strong>.</p>
<p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5676185317381">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_0000002341058378__en-us_topic_0000002055322398_row1767420538388"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p667615319384">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p18676125373817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p196761253103818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p20676195303812">Disk ID of the EFS. This parameter is mandatory only when the instance category is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b15676153193812">EFS</strong> and the ownership is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1067625373815">DEDICATED</strong>. This parameter is mandatory.</p>
<p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p767635313812">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_0000002341058378__en-us_topic_0000002055322398_b13676105314385">ID</strong> is the value of this parameter.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row2067715393812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p3677105363810">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_0000002341058378__en-us_topic_0000002055322398_p367716538389">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_0000002341058378__en-us_topic_0000002055322398_p1967735317384">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_0000002341058378__en-us_topic_0000002055322398_p15677175311388">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row06771153173816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1267735317389">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_0000002341058378__en-us_topic_0000002055322398_p16677165373818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p26771853153820"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p17678553103817">Container-related hook configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row9678853183817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p16678195317382">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_0000002341058378__en-us_topic_0000002055322398_p6678145303816">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_0000002341058378__en-us_topic_0000002055322398_p667885323816">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_0000002341058378__en-us_topic_0000002055322398_p156786539388">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row2678115315381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p26781853183815">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_0000002341058378__en-us_topic_0000002055322398_p5678105310382">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p66792533387"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p1967913534388">Configure the script after the service is started.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row667875373815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1767995313810">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_0000002341058378__en-us_topic_0000002055322398_p667925319387">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p96794531384"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p8679115311384">Configure the script before starting the service.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row467955353813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p96809539389">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_0000002341058378__en-us_topic_0000002055322398_p1568065316381">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_0000002341058378__en-us_topic_0000002055322398_p19680653193813">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_0000002341058378__en-us_topic_0000002055322398_p3680165383818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row2679853103819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1968016532387">script</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p126801053153820">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p12680105343812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p16801653163817">User-defined script content (Base64 encoding) or absolute script path.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row36798531388"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p166801653103817">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15680453123819">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p268018532383">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1068015531388">Script type.</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul106805531386"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li26801153123810"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p18680553163819"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li26801153123810"></a><a name="en-us_topic_0000002055322398_li26801153123810"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b10680135393818">COMMAND</strong>: The script content (Base64-encoded) must be specified.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li16816533385"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p136812534384"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li16816533385"></a><a name="en-us_topic_0000002055322398_li16816533385"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b568175353812">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_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row1868195318386"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1868175320387">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_0000002341058378__en-us_topic_0000002055322398_p106811753163810">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_0000002341058378__en-us_topic_0000002055322398_p968113532382">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_0000002341058378__en-us_topic_0000002055322398_p10681145323811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1681105311382"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p16814530383">duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p9682453123810">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p12682165333812">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.8.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p668216532382">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_0000002341058378__en-us_topic_0000002055322398_row19681145318381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1368255312389">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p86821553163814">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p12682125383817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.8.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1268211530386">Automatic stop type. The default value is timing.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_section1068219538384"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1068215363820"><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b3682165311389">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row96831953123820"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p206841353173813">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_0000002341058378__en-us_topic_0000002055322398_p1868495343815">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_0000002341058378__en-us_topic_0000002055322398_p168405314385">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row18683453143818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p19684153143817">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_0000002341058378__en-us_topic_0000002055322398_p568418530385">Array of <a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p468413533385">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row3683053173810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p176847536383">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2684205311384">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p176840537386">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1168385316384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p11685153103818">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p3685853163810">Array of <a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p39306536387">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_0000002341058378__en-us_topic_0000002055322398_row268345373820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p6930453133815">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_0000002341058378__en-us_topic_0000002055322398_p15930853123811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15930135353810">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row168385333813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p593020535386">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p7930165383818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193005343811">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1468335323818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p14930105319380">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1693125323810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p19311353183818">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row156831053103818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p29311053103812">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1993165315385"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p109311853123818">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row06836530385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p139316539388">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1293165313385"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p14931353113816">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row768311535381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p16931953173817">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1693119536382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p49315538383">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row17683153193819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p149311753123812">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p393195319382"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p10931185314388">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_0000002341058378__en-us_topic_0000002055322398_row11683253103811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p169311853173814">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193165353816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p8931165373819">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul79311153163820"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1193195319381"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p4931155314389"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1193195319381"></a><a name="en-us_topic_0000002055322398_li1193195319381"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b7931353173817">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li15931145318384"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1493119530383"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li15931145318384"></a><a name="en-us_topic_0000002055322398_li15931145318384"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b139311536386">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li793165315381"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193155343818"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li793165315381"></a><a name="en-us_topic_0000002055322398_li793165315381"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b99311053173813">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li49311533386"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p593115533388"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li49311533386"></a><a name="en-us_topic_0000002055322398_li49311533386"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b119314534382">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li19311953173810"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p11931135314389"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li19311953173810"></a><a name="en-us_topic_0000002055322398_li19311953173810"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b9931145343815">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li593115533385"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p093118536386"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li593115533385"></a><a name="en-us_topic_0000002055322398_li593115533385"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1393117537387">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li693155353815"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15931553173812"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li693155353815"></a><a name="en-us_topic_0000002055322398_li693155353815"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b12931205383820">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li119311353123810"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p993135316382"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li119311353123810"></a><a name="en-us_topic_0000002055322398_li119311353123810"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1593110534386">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li18931145316383"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1293115313816"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li18931145316383"></a><a name="en-us_topic_0000002055322398_li18931145316383"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b79317538387">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li7931145323819"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5931145314387"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li7931145323819"></a><a name="en-us_topic_0000002055322398_li7931145323819"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b2093135373820">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1931135363812"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p11931553173819"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1931135363812"></a><a name="en-us_topic_0000002055322398_li1931135363812"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1293105316388">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li199311353143814"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p14931453173819"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li199311353143814"></a><a name="en-us_topic_0000002055322398_li199311353143814"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b15931165314387">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1931165383812"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p199317537380"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1931165383812"></a><a name="en-us_topic_0000002055322398_li1931165383812"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b17931175383812">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li193165303813"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p893111532383"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li193165303813"></a><a name="en-us_topic_0000002055322398_li193165303813"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b11931953143817">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row5683753163820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p189311453113820">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p179315539382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p49311053103811">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row468310531387"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1993212536381">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10932105312386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p3932653143820">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row17683115312386"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p119321453193818">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1093285312385"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p119321353163816">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1868318532384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p69321253103814">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_0000002341058378__en-us_topic_0000002055322398_p6932353173814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p109321453123811">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b293217534384">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row6683175315384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10932175373811">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p13932155343815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p4932453103817">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul1893265393816"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li2932553153813"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p49321853153812"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li2932553153813"></a><a name="en-us_topic_0000002055322398_li2932553153813"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b149321253143810">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li6932105317387"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p189321353163814"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li6932105317387"></a><a name="en-us_topic_0000002055322398_li6932105317387"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b39325534381">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1768325393815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1893218537388">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_0000002341058378__en-us_topic_0000002055322398_p209321853163810">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_0000002341058378__en-us_topic_0000002055322398_p4932165319389">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2093255312382">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1493285317385">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2932145313810">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1468320539389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1932453173810">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p109324534388"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p19321537387">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row15689125363815"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5932185363817">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_0000002341058378__en-us_topic_0000002055322398_p29321253153815">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_0000002341058378__en-us_topic_0000002055322398_p149321539389">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row10689165312389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p993213532382">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_0000002341058378__en-us_topic_0000002055322398_p8932125318386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p79321853163818">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row868917530388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p593211533384">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p12932125317388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1793285317388">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul19321153163812"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li293205313383"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p59321553173817"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li293205313383"></a><a name="en-us_topic_0000002055322398_li293205313383"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1393245393813">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li9932135314385"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p993215383811"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li9932135314385"></a><a name="en-us_topic_0000002055322398_li9932135314385"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b793219533386">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1932155314385"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1393219533389"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1932155314385"></a><a name="en-us_topic_0000002055322398_li1932155314385"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b199321353123814">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li493215343810"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1193217538388"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li493215343810"></a><a name="en-us_topic_0000002055322398_li493215343810"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1093245363815">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row0689155314385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p79324539388">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1693214538389">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193385310389">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul393313531387"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li10933053133811"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1933105383814"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li10933053133811"></a><a name="en-us_topic_0000002055322398_li10933053133811"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b893319530381">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li29331953193811"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p9933353123818"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li29331953193811"></a><a name="en-us_topic_0000002055322398_li29331953193811"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b793365313384">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li8933653113815"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p17933135313383"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li8933653113815"></a><a name="en-us_topic_0000002055322398_li8933653113815"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b3933155353812">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li19933155323817"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5933115317385"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li19933155323817"></a><a name="en-us_topic_0000002055322398_li19933155323817"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1933145373812">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row13690165323813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p16933115303816">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_0000002341058378__en-us_topic_0000002055322398_p893335315389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p11933105363811">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row1969115532386"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1493375343818">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_0000002341058378__en-us_topic_0000002055322398_p169331453193810">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_0000002341058378__en-us_topic_0000002055322398_p1933205343815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row196911553183814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p8933145310382">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_0000002341058378__en-us_topic_0000002055322398_p149335534382">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_0000002341058378__en-us_topic_0000002055322398_p2933185318381">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_0000002341058378__en-us_topic_0000002055322398_row1869185314380"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p79335536387">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_0000002341058378__en-us_topic_0000002055322398_p193345313384">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1993375313817">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul1293311533389"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li8933175353813"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p129332053153817"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li8933175353813"></a><a name="en-us_topic_0000002055322398_li8933175353813"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b11933353113811">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li2933195317385"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p4933195313817"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li2933195317385"></a><a name="en-us_topic_0000002055322398_li2933195317385"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1793325313817">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1869195315387"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15933853183813">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_0000002341058378__en-us_topic_0000002055322398_p11933125393818">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_0000002341058378__en-us_topic_0000002055322398_p10933853203815">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_0000002341058378__en-us_topic_0000002055322398_row136914538388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p149331953153810">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p79334538384">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1893314535382">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul1193315310389"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1293365310388"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p18933135343818"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1293365310388"></a><a name="en-us_topic_0000002055322398_li1293365310388"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1093325310382">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li13933135313816"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p3933753193817"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li13933135313816"></a><a name="en-us_topic_0000002055322398_li13933135313816"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b179334535382">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1769115537389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15933145312388">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1693319539386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1693325383818">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row7693125333820"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1793465343815">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_0000002341058378__en-us_topic_0000002055322398_p1893415323815">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_0000002341058378__en-us_topic_0000002055322398_p693425313388">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1869465312388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2934155314382">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1293445373810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p11934553143816">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul893425373812"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li149341553173811"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1793411531389"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li149341553173811"></a><a name="en-us_topic_0000002055322398_li149341553173811"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b19349537389">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5934053173815"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1093465353815"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5934053173815"></a><a name="en-us_topic_0000002055322398_li5934053173815"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b6934105343816">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1969485303812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p12934145323818">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_0000002341058378__en-us_topic_0000002055322398_p793418535385">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1493485333813">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row8694453173814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p13934125343818">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1893419535382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p119341553193810">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1694155311386"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p17934105373815">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_0000002341058378__en-us_topic_0000002055322398_p11934853193815">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_0000002341058378__en-us_topic_0000002055322398_p293465318386">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul1893445313817"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li149341536387"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p129341853183813"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li149341536387"></a><a name="en-us_topic_0000002055322398_li149341536387"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b993495317388">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li4934145373816"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p693485343812"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li4934145373816"></a><a name="en-us_topic_0000002055322398_li4934145373816"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b12934125311385">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_0000002341058378__en-us_topic_0000002055322398_row46941153173818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p593475320382">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p7934185353810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1793455313382">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_0000002341058378__en-us_topic_0000002055322398_row2069435311384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p79341853143816">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1593475312387">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1393445313814">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_0000002341058378__en-us_topic_0000002055322398_row146944531381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p12934115363820">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p179343538389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193435310388">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b16934155318388">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row16694135333812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5934105323810">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p9934553193817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p13934053173810">Image source, which defaults to <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1934145313819">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul17934753123813"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li119341053163815"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p19934165363812"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li119341053163815"></a><a name="en-us_topic_0000002055322398_li119341053163815"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b8934753163811">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1493415363819"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p59341153173819"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1493415363819"></a><a name="en-us_topic_0000002055322398_li1493415363819"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b209346536382">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1769485320388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p79340532386">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_0000002341058378__en-us_topic_0000002055322398_p1934353203813">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_0000002341058378__en-us_topic_0000002055322398_p3934175333818">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul1693495393815"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1693410531386"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p493415317380"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1693410531386"></a><a name="en-us_topic_0000002055322398_li1693410531386"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b13934165393818">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1693412536384"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1793410537389"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1693412536384"></a><a name="en-us_topic_0000002055322398_li1693412536384"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b293419537385">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1769485314382"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193485312382">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_0000002341058378__en-us_topic_0000002055322398_p12934453173820">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p893435353819">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul2934145319384"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1793495353810"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p393412538385"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1793495353810"></a><a name="en-us_topic_0000002055322398_li1793495353810"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b793419532383">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1593512535384"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p179351153133819"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1593512535384"></a><a name="en-us_topic_0000002055322398_li1593512535384"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b193514536388">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li14935153173816"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p293545310382"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li14935153173816"></a><a name="en-us_topic_0000002055322398_li14935153173816"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li7935753153817"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2935105312384"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li7935753153817"></a><a name="en-us_topic_0000002055322398_li7935753153817"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li10935125320381"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p16935353153813"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li10935125320381"></a><a name="en-us_topic_0000002055322398_li10935125320381"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row116941553193810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p993535343818">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193525310386">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p149351553123819">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row069475318381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2935253123812">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15935253173813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10935105373814">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul793519534387"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li09351253133819"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1593525363815"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li09351253133819"></a><a name="en-us_topic_0000002055322398_li09351253133819"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b129354533388">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5935353183812"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p7935153123816"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5935353183812"></a><a name="en-us_topic_0000002055322398_li5935353183812"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b13935953123813">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li14935105316385"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p29359534387"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li14935105316385"></a><a name="en-us_topic_0000002055322398_li14935105316385"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b393515310383">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li15935155315388"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p29351539388"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li15935155315388"></a><a name="en-us_topic_0000002055322398_li15935155315388"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b3935153103812">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li13935175333817"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p189353533389"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li13935175333817"></a><a name="en-us_topic_0000002055322398_li13935175333817"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1093515317382">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li393516532386"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p17935353113811"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li393516532386"></a><a name="en-us_topic_0000002055322398_li393516532386"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1493505313386">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_0000002341058378__en-us_topic_0000002055322398_row7694153173810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p17935115343815">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_0000002341058378__en-us_topic_0000002055322398_p16935853193810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p13935145312388">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row26947535381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193525323817">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_0000002341058378__en-us_topic_0000002055322398_p17935205393818">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_0000002341058378__en-us_topic_0000002055322398_p1793519533382">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul1993515318383"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1893515535388"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p18935105303818"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1893515535388"></a><a name="en-us_topic_0000002055322398_li1893515535388"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b29351253193816">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5935153103812"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p893517538383"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5935153103812"></a><a name="en-us_topic_0000002055322398_li5935153103812"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b3935253183813">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1694253193816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p59351653103815">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_0000002341058378__en-us_topic_0000002055322398_p893575311389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p129351653163818">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row36941053113813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p14935205393820">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p12935145313386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p493520534389">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row8694195323818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p7935953113811">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p593555314386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2935145319382">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul49358531382"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li19935185320382"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p199351053183812"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li19935185320382"></a><a name="en-us_topic_0000002055322398_li19935185320382"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b49356533383">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5935453143817"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p993518535388"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5935453143817"></a><a name="en-us_topic_0000002055322398_li5935453143817"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b15935175323814">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row136941753153819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193518536381">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_0000002341058378__en-us_topic_0000002055322398_p1593511533389">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1593555363815">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1869455311386"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p189353535386">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10935185313386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193545393810">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul493535320386"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li393618534381"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5936195310386"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li393618534381"></a><a name="en-us_topic_0000002055322398_li393618534381"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b8936453143816">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li393635363811"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p18936153193810"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li393635363811"></a><a name="en-us_topic_0000002055322398_li393635363811"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b11936125317381">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row269417534383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p14936175318386">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_0000002341058378__en-us_topic_0000002055322398_p093614539389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p2093635323816">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b119361753103818">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row169935343819"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10936145319388">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_0000002341058378__en-us_topic_0000002055322398_p6936753113815">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_0000002341058378__en-us_topic_0000002055322398_p19936175393812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row67005530385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1936145313813">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_0000002341058378__en-us_topic_0000002055322398_p1393612532384">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p9936165313388">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1870018531384"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1893685383814">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p9936553203813">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1993655311380">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_0000002341058378__en-us_topic_0000002055322398_row9700135393812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p169361053203815">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p393675343810">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1693617531388">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row14700653133818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1993655323813">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p39364531386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p19936135303817">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul1493613535380"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li169361953173816"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p179361853103816"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li169361953173816"></a><a name="en-us_topic_0000002055322398_li169361953173816"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li693665315386"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p18936175383812"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li693665315386"></a><a name="en-us_topic_0000002055322398_li693665315386"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1070013534383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p199361853163816">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_0000002341058378__en-us_topic_0000002055322398_p5936145312386">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p139361553133810">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_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row6701165393820"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p4936195312386">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_0000002341058378__en-us_topic_0000002055322398_p1593617535387">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_0000002341058378__en-us_topic_0000002055322398_p393635383816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1970115314381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p693612530385">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p093785373816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1893775323814">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row6701175311389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p149371553173814">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15937753143812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p993775313811">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row370255373814"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1293716538384">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_0000002341058378__en-us_topic_0000002055322398_p593735316388">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_0000002341058378__en-us_topic_0000002055322398_p13937205373819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row9702453103812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p10937125393818">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p18937145363812">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p169378536381">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_0000002341058378__en-us_topic_0000002055322398_row13702153123816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p179371753123814">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p3937653183818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p149375537386">Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_i293745313815">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul129371153133820"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5937165333818"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p093795312386"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li5937165333818"></a><a name="en-us_topic_0000002055322398_li5937165333818"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b14937155323816">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1793719535384"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p179371153163819"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li1793719535384"></a><a name="en-us_topic_0000002055322398_li1793719535384"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b6937105315381">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row11702135316386"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p49371653163811">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_0000002341058378__en-us_topic_0000002055322398_p793795383816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p893745343814">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b393745313812">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row18702053123812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p4937115317386">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p209371453143819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p17937145393816">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_ul7937115313815"><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li149378535388"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p993785318382"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li149378535388"></a><a name="en-us_topic_0000002055322398_li149378535388"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b09371153143814">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li199372053143817"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p15937153103810"><a name="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_li199372053143817"></a><a name="en-us_topic_0000002055322398_li199372053143817"></a><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b1793755353818">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b19371853163814">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row570295311383"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p39374532381">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p159371453133811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p3937753123818">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b593714539389">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_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row4703125317382"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p209373537383">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_0000002341058378__en-us_topic_0000002055322398_p1093717534381">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_0000002341058378__en-us_topic_0000002055322398_p2937125313382">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row2704165313815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p3937553173817">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1193715539384"><a href="#EN-US_TOPIC_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_p13937205383815">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row147049532385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5937165318389">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p159371553123810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p11937153163815">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row4704175363817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p129371253163815">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1937353183811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p209374532388">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058378__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_0000002341058378__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_0000002341058378__en-us_topic_0000002055322398_row177051534380"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p189389536384">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_0000002341058378__en-us_topic_0000002055322398_p3938653143819">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_0000002341058378__en-us_topic_0000002055322398_p193865319386">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row9705653203818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p493812530381">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p189381653153813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1938453113814">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row177051153183815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1938115318384">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1093895315385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p193814539385">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_section1093810532388"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p39382053183819">The following is an example of how to create a notebook instance whose flavor is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b893845393818">modelarts.vm.cpu.2u</strong>, storage type is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b15938185316389">evs</strong>, ownership is <strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b693875311382">MANAGED</strong>, and storage capacity is 50 GB.</p>
<pre class="screen" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_screen193817533388">{
"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_0000002341058378__en-us_topic_0000002055322398_section16938165323812"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p6938753183812"><strong id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_b17938115383816">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p7938135363814">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_screen8938155319383">{
"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_0000002341058378__en-us_topic_0000002055322398_section7938185312381"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row18713155315385"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p189381053113819">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_0000002341058378__en-us_topic_0000002055322398_p8938115363810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row19713165314385"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p149381539384">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1893819532388">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1071317533384"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p693855320383">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p29381953153811">Created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row1471315532383"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p5938105383813">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1493813530386">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row137131253103817"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1893945363811">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p14939185318380">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_row2071315315385"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1793935319381">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p09391753113811">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_section129396535387"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002341058378__en-us_topic_0000002055322398_p1293975323810">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