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

760 lines
73 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000002268806141"></a><a name="EN-US_TOPIC_0000002268806141"></a>
<h1 class="topictitle1">Deleting a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002268806141__section10459163823316"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002268806141__p12459113883314">This API is used to delete a notebook instance. The resources to be deleted include the notebook container and all corresponding storage resources.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002268806141__section64591938193312"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002268806141__p10459113823315">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002268806141__section64591638143319"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002268806141__p1045953853313">DELETE /v1/{project_id}/notebooks/{id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__table1346063813339" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row04601438123315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002268806141__p646003810338">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_0000002268806141__p44615387338">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_0000002268806141__p14461173811339">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_0000002268806141__p246112380339">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row16460338193320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002268806141__p9461838163317">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002268806141__p5461838193313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002268806141__p246113863316">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002268806141__p4461638173311">Notebook instance ID, which can be obtained by calling the API for querying the notebook instance list.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row746013833310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002268806141__p12461113843318">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_0000002268806141__p6461113813339">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002268806141__p046214383337">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002268806141__p046216387331">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_0000002268806141__section64621138203311"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002268806141__p1462838123312">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002268806141__section1246293873311"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002268806141__p346253819334"><strong id="EN-US_TOPIC_0000002268806141__b11462133833313">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_NotebookResp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row124631038153310"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p2046510385335">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_0000002268806141__p44651381337">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_0000002268806141__p1846523863310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row154631438173318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p44651138163314">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_0000002268806141__p13465638193318">Array of <a href="#EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_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_0000002268806141__p64652038143317">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1646393813311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1246517388332">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p746603853317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p746612388333">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1946317386339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1046613385331">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p11466113833315">Array of <a href="#EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_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_0000002268806141__p15466113893317">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_0000002268806141__row1846313893316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p19466103810336">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_0000002268806141__p18466133820333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p15466638193316">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row194634388332"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p17467538133311">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p1446743803311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p046753813316">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row4463163863312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1846723883311">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p446793818337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p1346773813317">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row6464038163320"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p124671938193318">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p346703863319"><a href="#EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_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_0000002268806141__p446773820335">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row164641338133317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p346813385330">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p18468838173312"><a href="#EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_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_0000002268806141__p446813382337">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1746419383335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p24681138123314">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p846818389330">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p446814389339">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row144641538183314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1346810386336">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p3468103803318"><a href="#EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_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_0000002268806141__p3468153823313">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_0000002268806141__row1946413815335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p94691438103311">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p246933810333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p1146963817332">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul16469123813332"><li id="EN-US_TOPIC_0000002268806141__li10469153819336"><p id="EN-US_TOPIC_0000002268806141__p11469038123311"><a name="EN-US_TOPIC_0000002268806141__li10469153819336"></a><a name="li10469153819336"></a><strong id="EN-US_TOPIC_0000002268806141__b346963853315">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li84691538173315"><p id="EN-US_TOPIC_0000002268806141__p846915386339"><a name="EN-US_TOPIC_0000002268806141__li84691538173315"></a><a name="li84691538173315"></a><strong id="EN-US_TOPIC_0000002268806141__b144696386332">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li2469123817337"><p id="EN-US_TOPIC_0000002268806141__p74691238173317"><a name="EN-US_TOPIC_0000002268806141__li2469123817337"></a><a name="li2469123817337"></a><strong id="EN-US_TOPIC_0000002268806141__b84691385333">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li19469183816335"><p id="EN-US_TOPIC_0000002268806141__p1546923814339"><a name="EN-US_TOPIC_0000002268806141__li19469183816335"></a><a name="li19469183816335"></a><strong id="EN-US_TOPIC_0000002268806141__b446918380339">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li147023817335"><p id="EN-US_TOPIC_0000002268806141__p04702388336"><a name="EN-US_TOPIC_0000002268806141__li147023817335"></a><a name="li147023817335"></a><strong id="EN-US_TOPIC_0000002268806141__b1470143853316">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li124701638193312"><p id="EN-US_TOPIC_0000002268806141__p1147003843320"><a name="EN-US_TOPIC_0000002268806141__li124701638193312"></a><a name="li124701638193312"></a><strong id="EN-US_TOPIC_0000002268806141__b10470238193310">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li204704388331"><p id="EN-US_TOPIC_0000002268806141__p1470183863317"><a name="EN-US_TOPIC_0000002268806141__li204704388331"></a><a name="li204704388331"></a><strong id="EN-US_TOPIC_0000002268806141__b144702038123313">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li13470163812334"><p id="EN-US_TOPIC_0000002268806141__p114702389337"><a name="EN-US_TOPIC_0000002268806141__li13470163812334"></a><a name="li13470163812334"></a><strong id="EN-US_TOPIC_0000002268806141__b64701238103315">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li16470438123316"><p id="EN-US_TOPIC_0000002268806141__p19470143817336"><a name="EN-US_TOPIC_0000002268806141__li16470438123316"></a><a name="li16470438123316"></a><strong id="EN-US_TOPIC_0000002268806141__b13470193823311">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li5470153815333"><p id="EN-US_TOPIC_0000002268806141__p74701138163318"><a name="EN-US_TOPIC_0000002268806141__li5470153815333"></a><a name="li5470153815333"></a><strong id="EN-US_TOPIC_0000002268806141__b2047003883311">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li174708387334"><p id="EN-US_TOPIC_0000002268806141__p1147010389334"><a name="EN-US_TOPIC_0000002268806141__li174708387334"></a><a name="li174708387334"></a><strong id="EN-US_TOPIC_0000002268806141__b154701638183314">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li1471103803314"><p id="EN-US_TOPIC_0000002268806141__p447120386332"><a name="EN-US_TOPIC_0000002268806141__li1471103803314"></a><a name="li1471103803314"></a><strong id="EN-US_TOPIC_0000002268806141__b20471193893315">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li13471163833311"><p id="EN-US_TOPIC_0000002268806141__p1747113833310"><a name="EN-US_TOPIC_0000002268806141__li13471163833311"></a><a name="li13471163833311"></a><strong id="EN-US_TOPIC_0000002268806141__b9471193816338">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li1747116383331"><p id="EN-US_TOPIC_0000002268806141__p84715387333"><a name="EN-US_TOPIC_0000002268806141__li1747116383331"></a><a name="li1747116383331"></a><strong id="EN-US_TOPIC_0000002268806141__b14471183833310">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row3464113873318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1471193893319">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p3471193814330">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p10471163833314">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row346493873313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p147133815331">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p10472638183317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p15472183812331">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row20464138153311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p147283817334">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p547223853316"><a href="#EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_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_0000002268806141__p1647218389333">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row946417383339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p13472438103310">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_0000002268806141__p947210383334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p3472173810331">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002268806141__b154721038143311">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row20464203843313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p18473183893318">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p9473438153317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p24735382334">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul6473638193319"><li id="EN-US_TOPIC_0000002268806141__li5473183853317"><p id="EN-US_TOPIC_0000002268806141__p17473123833320"><a name="EN-US_TOPIC_0000002268806141__li5473183853317"></a><a name="li5473183853317"></a><strong id="EN-US_TOPIC_0000002268806141__b1647353817335">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li1447333810337"><p id="EN-US_TOPIC_0000002268806141__p747323813313"><a name="EN-US_TOPIC_0000002268806141__li1447333810337"></a><a name="li1447333810337"></a><strong id="EN-US_TOPIC_0000002268806141__b1947315389339">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1464538123318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1347333811334">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_0000002268806141__p144741338143317">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_0000002268806141__p4474138103315">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002268806141__p1447463810334">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002268806141__p12474538193316">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002268806141__p14741138103312">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1346423893320"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1647416386332">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p1647414386334"><a href="#EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_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_0000002268806141__p134741338173313">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_JobProgress"></a><a name="en-us_topic_0000002055164054_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 3 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row16475438173314"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p547613863313">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_0000002268806141__p1347643818339">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_0000002268806141__p5476113820332">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row13475438193315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p194761738113320">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_0000002268806141__p8476103873311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p13476938203318">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row11475163823313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p5476143811336">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p164769382333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p15477438193314">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul347713820332"><li id="EN-US_TOPIC_0000002268806141__li13477133823315"><p id="EN-US_TOPIC_0000002268806141__p8477238163313"><a name="EN-US_TOPIC_0000002268806141__li13477133823315"></a><a name="li13477133823315"></a><strong id="EN-US_TOPIC_0000002268806141__b204771138153318">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li3477123843315"><p id="EN-US_TOPIC_0000002268806141__p194771238133314"><a name="EN-US_TOPIC_0000002268806141__li3477123843315"></a><a name="li3477123843315"></a><strong id="EN-US_TOPIC_0000002268806141__b1947723816337">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li84776382339"><p id="EN-US_TOPIC_0000002268806141__p147713385334"><a name="EN-US_TOPIC_0000002268806141__li84776382339"></a><a name="li84776382339"></a><strong id="EN-US_TOPIC_0000002268806141__b647811384336">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li54781238153310"><p id="EN-US_TOPIC_0000002268806141__p1847814383331"><a name="EN-US_TOPIC_0000002268806141__li54781238153310"></a><a name="li54781238153310"></a><strong id="EN-US_TOPIC_0000002268806141__b10478183819330">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row18475138173318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p347814380332">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p194781338123316">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p174781382337">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul347933833310"><li id="EN-US_TOPIC_0000002268806141__li84791138183314"><p id="EN-US_TOPIC_0000002268806141__p447993843318"><a name="EN-US_TOPIC_0000002268806141__li84791138183314"></a><a name="li84791138183314"></a><strong id="EN-US_TOPIC_0000002268806141__b13479938133317">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li10479163813318"><p id="EN-US_TOPIC_0000002268806141__p19479183843315"><a name="EN-US_TOPIC_0000002268806141__li10479163813318"></a><a name="li10479163813318"></a><strong id="EN-US_TOPIC_0000002268806141__b1647963813336">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li647914381337"><p id="EN-US_TOPIC_0000002268806141__p16479638183312"><a name="EN-US_TOPIC_0000002268806141__li647914381337"></a><a name="li647914381337"></a><strong id="EN-US_TOPIC_0000002268806141__b1479238173319">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li15479153814337"><p id="EN-US_TOPIC_0000002268806141__p1747943818332"><a name="EN-US_TOPIC_0000002268806141__li15479153814337"></a><a name="li15479153814337"></a><strong id="EN-US_TOPIC_0000002268806141__b7479138143316">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1447510384332"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p348017383339">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_0000002268806141__p13480203883318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p6480738113310">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_EndpointsRes"></a><a name="en-us_topic_0000002055164054_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 4 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row11481238183316"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p134824383339">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_0000002268806141__p2482203843312">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_0000002268806141__p64822385339">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row134811538153319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p3483123823317">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_0000002268806141__p148393815337">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_0000002268806141__p6483103853311">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_0000002268806141__row14481838113312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p15483143853316">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_0000002268806141__p17483163873317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p9484123819332">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul94841938163317"><li id="EN-US_TOPIC_0000002268806141__li1048473814337"><p id="EN-US_TOPIC_0000002268806141__p184841938103320"><a name="EN-US_TOPIC_0000002268806141__li1048473814337"></a><a name="li1048473814337"></a><strong id="EN-US_TOPIC_0000002268806141__b948463873313">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li10484163863315"><p id="EN-US_TOPIC_0000002268806141__p164841389336"><a name="EN-US_TOPIC_0000002268806141__li10484163863315"></a><a name="li10484163863315"></a><strong id="EN-US_TOPIC_0000002268806141__b1648412383337">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row8481338163311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p15484638133310">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_0000002268806141__p2485113823318">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_0000002268806141__p1148512385334">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_0000002268806141__row10481103814338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p12485338183317">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p12485203883310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p144851738113310">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul13485143814333"><li id="EN-US_TOPIC_0000002268806141__li3486438173320"><p id="EN-US_TOPIC_0000002268806141__p1048610388330"><a name="EN-US_TOPIC_0000002268806141__li3486438173320"></a><a name="li3486438173320"></a><strong id="EN-US_TOPIC_0000002268806141__b248673816337">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li204861238183312"><p id="EN-US_TOPIC_0000002268806141__p5486738113319"><a name="EN-US_TOPIC_0000002268806141__li204861238183312"></a><a name="li204861238183312"></a><strong id="EN-US_TOPIC_0000002268806141__b24869385336">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1248113386333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p164861938153320">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p04861738163312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p24861238123317">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_Image"></a><a name="en-us_topic_0000002055164054_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_Image" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row13487113893315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p7491738123315">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_0000002268806141__p13491203893311">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_0000002268806141__p16491133863316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row648883823313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p649243853317">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p204928383331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p1649213386336">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul12492173812336"><li id="EN-US_TOPIC_0000002268806141__li184921538133316"><p id="EN-US_TOPIC_0000002268806141__p17492113814338"><a name="EN-US_TOPIC_0000002268806141__li184921538133316"></a><a name="li184921538133316"></a><strong id="EN-US_TOPIC_0000002268806141__b349217388338">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002268806141__li049293815336"><p id="EN-US_TOPIC_0000002268806141__p149213811330"><a name="EN-US_TOPIC_0000002268806141__li049293815336"></a><a name="li049293815336"></a><strong id="EN-US_TOPIC_0000002268806141__b649215382337">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row194887381330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p13492153810334">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_0000002268806141__p349210386336">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p9493638193317">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row14881238193310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p84932387339">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p549316381336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p84939386338">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row24883381339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p204931038183319">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_0000002268806141__p1749353833317">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_0000002268806141__p74932383338">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul19493138123316"><li id="EN-US_TOPIC_0000002268806141__li84931538143311"><p id="EN-US_TOPIC_0000002268806141__p449315384330"><a name="EN-US_TOPIC_0000002268806141__li84931538143311"></a><a name="li84931538143311"></a><strong id="EN-US_TOPIC_0000002268806141__b174941838123311">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li549410389331"><p id="EN-US_TOPIC_0000002268806141__p7494238143318"><a name="EN-US_TOPIC_0000002268806141__li549410389331"></a><a name="li549410389331"></a><strong id="EN-US_TOPIC_0000002268806141__b749417387335">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_0000002268806141__row2488438193312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p8494138103316">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p4494143810338">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p1149443863311">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_0000002268806141__row1548812382334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p0494038173316">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p7494123863315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p649453863310">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_0000002268806141__row144887388337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1749583811331">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p149517384339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p154951538183317">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002268806141__b1249520381337">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row24885384336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p14951138173314">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p4495138113319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p154958381335">Image source, which defaults to <strong id="EN-US_TOPIC_0000002268806141__b8495133815331">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul2495538203317"><li id="EN-US_TOPIC_0000002268806141__li9495113843318"><p id="EN-US_TOPIC_0000002268806141__p149563893312"><a name="EN-US_TOPIC_0000002268806141__li9495113843318"></a><a name="li9495113843318"></a><strong id="EN-US_TOPIC_0000002268806141__b149533819331">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002268806141__li1149510388335"><p id="EN-US_TOPIC_0000002268806141__p649523820335"><a name="EN-US_TOPIC_0000002268806141__li1149510388335"></a><a name="li1149510388335"></a><strong id="EN-US_TOPIC_0000002268806141__b1949511389332">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1048863816331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p17496138103319">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_0000002268806141__p44967382330">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_0000002268806141__p149614385337">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul1149614380337"><li id="EN-US_TOPIC_0000002268806141__li12496938193317"><p id="EN-US_TOPIC_0000002268806141__p2496133811333"><a name="EN-US_TOPIC_0000002268806141__li12496938193317"></a><a name="li12496938193317"></a><strong id="EN-US_TOPIC_0000002268806141__b18496738133317">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002268806141__li549673863311"><p id="EN-US_TOPIC_0000002268806141__p164969387339"><a name="EN-US_TOPIC_0000002268806141__li549673863311"></a><a name="li549673863311"></a><strong id="EN-US_TOPIC_0000002268806141__b7496183817332">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row20489238143315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p349617385337">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_0000002268806141__p44961538123310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p449610389334">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul049613380332"><li id="EN-US_TOPIC_0000002268806141__li74979382337"><p id="EN-US_TOPIC_0000002268806141__p6497338143314"><a name="EN-US_TOPIC_0000002268806141__li74979382337"></a><a name="li74979382337"></a><strong id="EN-US_TOPIC_0000002268806141__b124971385333">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002268806141__li164976381330"><p id="EN-US_TOPIC_0000002268806141__p1249713873314"><a name="EN-US_TOPIC_0000002268806141__li164976381330"></a><a name="li164976381330"></a><strong id="EN-US_TOPIC_0000002268806141__b18497123853318">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002268806141__li849712385331"><p id="EN-US_TOPIC_0000002268806141__p849783812333"><a name="EN-US_TOPIC_0000002268806141__li849712385331"></a><a name="li849712385331"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002268806141__li0851138183311"><p id="EN-US_TOPIC_0000002268806141__p0851123863318"><a name="EN-US_TOPIC_0000002268806141__li0851138183311"></a><a name="li0851138183311"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002268806141__li10851203817334"><p id="EN-US_TOPIC_0000002268806141__p785113815335"><a name="EN-US_TOPIC_0000002268806141__li10851203817334"></a><a name="li10851203817334"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row54899384334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p3851133823316">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p985114383333">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p138511238183318">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row9489113813312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1085112382336">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p1785193816339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p885113386331">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul185117381334"><li id="EN-US_TOPIC_0000002268806141__li19851338143315"><p id="EN-US_TOPIC_0000002268806141__p178511238143318"><a name="EN-US_TOPIC_0000002268806141__li19851338143315"></a><a name="li19851338143315"></a><strong id="EN-US_TOPIC_0000002268806141__b1785123810339">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li18851038103312"><p id="EN-US_TOPIC_0000002268806141__p1085112386338"><a name="EN-US_TOPIC_0000002268806141__li18851038103312"></a><a name="li18851038103312"></a><strong id="EN-US_TOPIC_0000002268806141__b18511138193317">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li118516388331"><p id="EN-US_TOPIC_0000002268806141__p158512381337"><a name="EN-US_TOPIC_0000002268806141__li118516388331"></a><a name="li118516388331"></a><strong id="EN-US_TOPIC_0000002268806141__b9851133873316">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li14851738203320"><p id="EN-US_TOPIC_0000002268806141__p285118384331"><a name="EN-US_TOPIC_0000002268806141__li14851738203320"></a><a name="li14851738203320"></a><strong id="EN-US_TOPIC_0000002268806141__b1685113853319">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li138511638113315"><p id="EN-US_TOPIC_0000002268806141__p15851338193318"><a name="EN-US_TOPIC_0000002268806141__li138511638113315"></a><a name="li138511638113315"></a><strong id="EN-US_TOPIC_0000002268806141__b16851183843319">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li18851123820334"><p id="EN-US_TOPIC_0000002268806141__p7851133883311"><a name="EN-US_TOPIC_0000002268806141__li18851123820334"></a><a name="li18851123820334"></a><strong id="EN-US_TOPIC_0000002268806141__b0851143810332">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_0000002268806141__row24892384334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p168512380335">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_0000002268806141__p1585110384339">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p7851173811332">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row248993853317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p98511738143319">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_0000002268806141__p1385153818333">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_0000002268806141__p78511738163314">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul1585143819332"><li id="EN-US_TOPIC_0000002268806141__li285133813315"><p id="EN-US_TOPIC_0000002268806141__p1085193893317"><a name="EN-US_TOPIC_0000002268806141__li285133813315"></a><a name="li285133813315"></a><strong id="EN-US_TOPIC_0000002268806141__b15851113813334">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002268806141__li178512389338"><p id="EN-US_TOPIC_0000002268806141__p18511138183314"><a name="EN-US_TOPIC_0000002268806141__li178512389338"></a><a name="li178512389338"></a><strong id="EN-US_TOPIC_0000002268806141__b108517389338">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row2489183883315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p6851038133319">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_0000002268806141__p385110386335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p11851238173313">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row548943818334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p5851133873318">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p1285163816337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p785112384338">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row10490173813339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p9852638183317">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p15852103823315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p0852338193318">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul1985243863313"><li id="EN-US_TOPIC_0000002268806141__li7852203816334"><p id="EN-US_TOPIC_0000002268806141__p148521381330"><a name="EN-US_TOPIC_0000002268806141__li7852203816334"></a><a name="li7852203816334"></a><strong id="EN-US_TOPIC_0000002268806141__b285214389333">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002268806141__li885213385334"><p id="EN-US_TOPIC_0000002268806141__p20852138103316"><a name="EN-US_TOPIC_0000002268806141__li885213385334"></a><a name="li885213385334"></a><strong id="EN-US_TOPIC_0000002268806141__b16852183816336">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row104902381333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p12852113803312">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_0000002268806141__p5852193873311">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p8852193853316">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row1849053812336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p19852113810336">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p12852103863315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p58521238173316">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul16852153823310"><li id="EN-US_TOPIC_0000002268806141__li13852203853318"><p id="EN-US_TOPIC_0000002268806141__p7852163813339"><a name="EN-US_TOPIC_0000002268806141__li13852203853318"></a><a name="li13852203853318"></a><strong id="EN-US_TOPIC_0000002268806141__b11852338113313">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002268806141__li17852123815332"><p id="EN-US_TOPIC_0000002268806141__p885223816335"><a name="EN-US_TOPIC_0000002268806141__li17852123815332"></a><a name="li17852123815332"></a><strong id="EN-US_TOPIC_0000002268806141__b28521838133319">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row164901338103315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p585216384338">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_0000002268806141__p208521338133312">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p1785273820335">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002268806141__b1485283883314">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row12490173843310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p17852438183317">flavor_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p148521438193317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p138521838133316">Image resource type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_Lease"></a><a name="en-us_topic_0000002055164054_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row115043381331"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p1985233803310">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_0000002268806141__p1185283817331">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_0000002268806141__p08522038153315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row1450433811333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p58521138173319">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_0000002268806141__p8852193815337">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p11853138103312">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row18504133853319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1785333816331">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p0853163814336">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p118531638183313">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_0000002268806141__row155041538143316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1685312387337">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p16853133820339">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p68531338133318">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row350443818331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1685313388336">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p15853113843310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p4853238203313">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002268806141__ul885323823310"><li id="EN-US_TOPIC_0000002268806141__li88531538143311"><p id="EN-US_TOPIC_0000002268806141__p7853103816333"><a name="EN-US_TOPIC_0000002268806141__li88531538143311"></a><a name="li88531538143311"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li4853123813317"><p id="EN-US_TOPIC_0000002268806141__p2853163853319"><a name="EN-US_TOPIC_0000002268806141__li4853123813317"></a><a name="li4853123813317"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row125041038173318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p38531038173312">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_0000002268806141__p16853438123318">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p385363873315">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_0000002268806141__en-us_topic_0000002055164054_response_Pool"></a><a name="en-us_topic_0000002055164054_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row1650633883319"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p17853193833313">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_0000002268806141__p198531238193317">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_0000002268806141__p118533382336">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row18506338193314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p8853123817337">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p785318386332">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p118531938173313">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row18507438173315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p385316387337">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p585363813317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p15853183810336">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_VolumeRes"></a><a name="en-us_topic_0000002055164054_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 8 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row105081438183320"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p08537382337">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_0000002268806141__p12853838183317">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_0000002268806141__p685313386331">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row1550811382330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p13853238133310">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p4853038123312">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p485383817336">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_0000002268806141__row155081738123316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p138538384332">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p6853133818334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p1785311389334">Supported storage types. For details about the differences between the storage types, see"Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002268806141__i085483893314">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul1854738103319"><li id="EN-US_TOPIC_0000002268806141__li9854183873314"><p id="EN-US_TOPIC_0000002268806141__p1285433843315"><a name="EN-US_TOPIC_0000002268806141__li9854183873314"></a><a name="li9854183873314"></a><strong id="EN-US_TOPIC_0000002268806141__b485473818331">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002268806141__li7854123814331"><p id="EN-US_TOPIC_0000002268806141__p185443812337"><a name="EN-US_TOPIC_0000002268806141__li7854123814331"></a><a name="li7854123814331"></a><strong id="EN-US_TOPIC_0000002268806141__b3854138163311">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row185081338193319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p16854123833313">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_0000002268806141__p2854203873319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p5854133813331">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002268806141__b285418388339">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row0508103813310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p17854173820333">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p2085423883315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p1885483817335">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002268806141__ul3854938193319"><li id="EN-US_TOPIC_0000002268806141__li15854173813336"><p id="EN-US_TOPIC_0000002268806141__p1885453833318"><a name="EN-US_TOPIC_0000002268806141__li15854173813336"></a><a name="li15854173813336"></a><strong id="EN-US_TOPIC_0000002268806141__b185483873314">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002268806141__li3854153811332"><p id="EN-US_TOPIC_0000002268806141__p2085413883320"><a name="EN-US_TOPIC_0000002268806141__li3854153811332"></a><a name="li3854153811332"></a><strong id="EN-US_TOPIC_0000002268806141__b20854638183319">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002268806141__b1685413382330">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row8508203819336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p5854193893310">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p2854193823317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p15854538123317">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002268806141__b11854173853313">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_0000002268806141__en-us_topic_0000002055164054_response_user"></a><a name="en-us_topic_0000002055164054_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_user" frame="border" border="1" rules="all"><caption><b>Table 9 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row3510123843311"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p8854113814333">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_0000002268806141__p14854143843313">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_0000002268806141__p208541388333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row1151014386331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p68541638153319">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p8854438133319"><a href="#EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_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_0000002268806141__p185417387331">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row351019386337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p18854173873312">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p158541938153316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p20854338133311">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row851017381334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1985412383338">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p1185413813315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p585413853317">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_domain"></a><a name="en-us_topic_0000002055164054_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_response_domain" frame="border" border="1" rules="all"><caption><b>Table 10 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row1512193883315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002268806141__p118541838183312">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_0000002268806141__p18854163873318">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_0000002268806141__p885473823311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row155124381338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p168546387330">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p38541738133313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p4855163813311">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row4512183833314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002268806141__p78556386337">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002268806141__p885513813337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002268806141__p585583833316">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002268806141__section5855138203314"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002268806141__screen08559385338">DELETE https://{endpoint}/v1/{project_id}/notebooks/{id}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002268806141__section12855123814332"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002268806141__p1585593811332"><strong id="EN-US_TOPIC_0000002268806141__b13855738153316">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002268806141__p285511381332">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002268806141__screen1485514385335">{
"create_at" : 1638841805440,
"description" : "update",
"feature" : "DEFAULT",
"flavor" : "modelarts.vm.cpu.free",
"id" : "f9937afa-ca78-45b6-bc12-7ecf42553c48",
"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" : 1638841805439,
"duration" : 3600000,
"enable" : true,
"update_at" : 1638841805439
},
"name" : "notebook_5ee4bf0e",
"status" : "DELETING",
"token" : "58ba50c6-e8ff-245c-4840-49e51aa70737",
"update_at" : 1638842504178,
"workspace_id" : "0"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002268806141__section0855638133318"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002268806141__en-us_topic_0000002055164054_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002268806141__row195152384338"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002268806141__p1685543813314">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_0000002268806141__p15855138193314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002268806141__row135151138143319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268806141__p1085553863312">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268806141__p15855173817333">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row155155381339"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268806141__p585573819336">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268806141__p985543814333">No Content</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row851513893319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268806141__p085518384339">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268806141__p15855738163315">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002268806141__row951514389334"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002268806141__p185614383331">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002268806141__p285623893313">Forbidden</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002268806141__section1885633818334"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002268806141__p1585643815333">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