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/ShowNotebook.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

757 lines
73 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000002233726938"></a><a name="EN-US_TOPIC_0000002233726938"></a>
<h1 class="topictitle1">Querying Details of a Notebook Instance</h1>
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002233726938__section13146133816332"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002233726938__p714663818334">This API is used to query details about a notebook instance, including the instance ID, name, specifications, image, instance status, and URL that can be opened.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726938__section11148133816332"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002233726938__p914813389330">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726938__section11149183815334"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002233726938__p18149103816331">GET /v1/{project_id}/notebooks/{id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__table131507384339" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row2149133823310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002233726938__p14150103814335">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_0000002233726938__p61501238133313">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_0000002233726938__p7150038173313">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_0000002233726938__p5150183819332">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row81491538183313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726938__p14150203816333">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1615013382333">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726938__p615116388336">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726938__p1151538113317">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_0000002233726938__row1914912389338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1915123815333">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_0000002233726938__p8151938103313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002233726938__p615103818338">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002233726938__p101511038193320">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_0000002233726938__section161514386333"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002233726938__p1615113382337">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726938__section11152183819331"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002233726938__p1515273819331"><strong id="EN-US_TOPIC_0000002233726938__b7152193873320">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__row71531938103316"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p1715533814330">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_0000002233726938__p115583833312">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_0000002233726938__p17155153819336">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row1015317386338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p15155738103315">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_0000002233726938__p515517381339">Array of <a href="#EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__p12155103810332">Instance initialization progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row161531538133313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p18155113815339">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p5155103820336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p61561138203312">Instance description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row15153133893313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1515633815331">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p18156113812335">Array of <a href="#EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__p1215619381332">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_0000002233726938__row41531238163319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p315653814332">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_0000002233726938__p1015623813337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p0156738183312">Instance failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row41536386331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p3156838113317">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1415643817330">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1415643863317">Instance flavor</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row2153123813339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p115753823315">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p6157113813338">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1815714382331">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row17153338183314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p41576385333">image</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1715713385339"><a href="#EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__p12157173873313">Instance image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row11531738203318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p181579388334">lease</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p191571238163319"><a href="#EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__p1157133853312">Countdown to automatic instance stop.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row101531938163315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p51571138133310">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p16158103873311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p10158538163311">Instance name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row615363833314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p11158173814335">pool</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p315883810334"><a href="#EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__p9158738183315">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_0000002233726938__row3153183833313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p191581038153313">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p19158638173314">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p141581938123314">Instance status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul201581938143313"><li id="EN-US_TOPIC_0000002233726938__li9158153803315"><p id="EN-US_TOPIC_0000002233726938__p615823815331"><a name="EN-US_TOPIC_0000002233726938__li9158153803315"></a><a name="li9158153803315"></a><strong id="EN-US_TOPIC_0000002233726938__b415873814330">INIT</strong>: The instance is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li3158103893316"><p id="EN-US_TOPIC_0000002233726938__p111581038183311"><a name="EN-US_TOPIC_0000002233726938__li3158103893316"></a><a name="li3158103893316"></a><strong id="EN-US_TOPIC_0000002233726938__b31591338153314">CREATING</strong>: The instance is being created.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li131597385339"><p id="EN-US_TOPIC_0000002233726938__p1415903818337"><a name="EN-US_TOPIC_0000002233726938__li131597385339"></a><a name="li131597385339"></a><strong id="EN-US_TOPIC_0000002233726938__b12159138143319">STARTING</strong>: The instance is starting.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li0159113813314"><p id="EN-US_TOPIC_0000002233726938__p115943818335"><a name="EN-US_TOPIC_0000002233726938__li0159113813314"></a><a name="li0159113813314"></a><strong id="EN-US_TOPIC_0000002233726938__b19159113810335">STOPPING</strong>: The instance is being stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li1515917381339"><p id="EN-US_TOPIC_0000002233726938__p18159123833318"><a name="EN-US_TOPIC_0000002233726938__li1515917381339"></a><a name="li1515917381339"></a><strong id="EN-US_TOPIC_0000002233726938__b11159173816331">DELETING</strong>: The instance is being deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li7159193883314"><p id="EN-US_TOPIC_0000002233726938__p2159123813335"><a name="EN-US_TOPIC_0000002233726938__li7159193883314"></a><a name="li7159193883314"></a><strong id="EN-US_TOPIC_0000002233726938__b8159183853313">RUNNING</strong>: The instance is running.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li2015933813310"><p id="EN-US_TOPIC_0000002233726938__p4159138183316"><a name="EN-US_TOPIC_0000002233726938__li2015933813310"></a><a name="li2015933813310"></a><strong id="EN-US_TOPIC_0000002233726938__b19159123803310">STOPPED</strong>: The instance has been stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li20159338153319"><p id="EN-US_TOPIC_0000002233726938__p7159138173314"><a name="EN-US_TOPIC_0000002233726938__li20159338153319"></a><a name="li20159338153319"></a><strong id="EN-US_TOPIC_0000002233726938__b3159738173314">SNAPSHOTTING</strong>: The image of the instance is being saved.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li915913384336"><p id="EN-US_TOPIC_0000002233726938__p1415993833317"><a name="EN-US_TOPIC_0000002233726938__li915913384336"></a><a name="li915913384336"></a><strong id="EN-US_TOPIC_0000002233726938__b10160113873313">CREATE_FAILED</strong>: Creating the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li516083819339"><p id="EN-US_TOPIC_0000002233726938__p14160153813339"><a name="EN-US_TOPIC_0000002233726938__li516083819339"></a><a name="li516083819339"></a><strong id="EN-US_TOPIC_0000002233726938__b71601938113317">START_FAILED</strong>: Starting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li141600380331"><p id="EN-US_TOPIC_0000002233726938__p1616033815337"><a name="EN-US_TOPIC_0000002233726938__li141600380331"></a><a name="li141600380331"></a><strong id="EN-US_TOPIC_0000002233726938__b41601738143319">DELETE_FAILED</strong>: Deleting the instance failed.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li161601383337"><p id="EN-US_TOPIC_0000002233726938__p81608385333"><a name="EN-US_TOPIC_0000002233726938__li161601383337"></a><a name="li161601383337"></a><strong id="EN-US_TOPIC_0000002233726938__b1516093853316">ERROR</strong>: An error occurred.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li1616063803310"><p id="EN-US_TOPIC_0000002233726938__p20160038153315"><a name="EN-US_TOPIC_0000002233726938__li1616063803310"></a><a name="li1616063803310"></a><strong id="EN-US_TOPIC_0000002233726938__b1016053818333">DELETED</strong>: The instance has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li181601638103318"><p id="EN-US_TOPIC_0000002233726938__p1616023819333"><a name="EN-US_TOPIC_0000002233726938__li181601638103318"></a><a name="li181601638103318"></a><strong id="EN-US_TOPIC_0000002233726938__b14160338123310">FROZEN</strong>: The instance is frozen.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row715313386333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1416015388336">token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p16161638103310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p19161138193314">Token information used for notebook authentication.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row61531138133313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p816193820338">url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p8161538123313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p21611738183311">URL for accessing the notebook instance</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row101541538203318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1316113803312">volume</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p15161103843314"><a href="#EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__p31628388331">Storage volume</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row51549385331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1216212382336">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_0000002233726938__p1316233814336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p161621838183313">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726938__b12162338203316">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row1115419385333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1916273818330">feature</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p41625384333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p14163193853315">Instance type. Options:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul19163123818332"><li id="EN-US_TOPIC_0000002233726938__li716343833315"><p id="EN-US_TOPIC_0000002233726938__p1416393813338"><a name="EN-US_TOPIC_0000002233726938__li716343833315"></a><a name="li716343833315"></a><strong id="EN-US_TOPIC_0000002233726938__b41631038163316">DEFAULT</strong>: free CodeLab instance. You can create only one.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li161631438163315"><p id="EN-US_TOPIC_0000002233726938__p141633386336"><a name="EN-US_TOPIC_0000002233726938__li161631438163315"></a><a name="li161631438163315"></a><strong id="EN-US_TOPIC_0000002233726938__b1316315384336">NOTEBOOK</strong>: billed instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row1615453813311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p5163938153316">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_0000002233726938__p71633383338">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_0000002233726938__p18163163863315">Type of a charging resource. Options:</p>
<p id="EN-US_TOPIC_0000002233726938__p1116315382337">STORAGE: Storage resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726938__p1516311385331">COMPUTE: Computing resources are charged.</p>
<p id="EN-US_TOPIC_0000002233726938__p716363818339">ALL: all charging types</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row115414387336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p151647384338">user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1816433893310"><a href="#EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__p181641238153313">Account information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_JobProgress"></a><a name="en-us_topic_0000002091201317_response_JobProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_JobProgress" frame="border" border="1" rules="all"><caption><b>Table 3 </b>JobProgress</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row316463833320"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p51651338133315">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_0000002233726938__p1816543893311">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_0000002233726938__p3165238163316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row15164038193310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p916519387339">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_0000002233726938__p1816613819332">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1716611387337">Instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row15164103843311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p916615387339">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p6166183814331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p15166238183313">Job status in a specified step. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul4166173814336"><li id="EN-US_TOPIC_0000002233726938__li1016653873315"><p id="EN-US_TOPIC_0000002233726938__p216614380332"><a name="EN-US_TOPIC_0000002233726938__li1016653873315"></a><a name="li1016653873315"></a><strong id="EN-US_TOPIC_0000002233726938__b171661538193315">WAITING</strong>: The job is awaiting.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li1816633812337"><p id="EN-US_TOPIC_0000002233726938__p181661838163317"><a name="EN-US_TOPIC_0000002233726938__li1816633812337"></a><a name="li1816633812337"></a><strong id="EN-US_TOPIC_0000002233726938__b61661138173314">PROCESSING</strong>: The job is being processed.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li13166938103319"><p id="EN-US_TOPIC_0000002233726938__p1516683823317"><a name="EN-US_TOPIC_0000002233726938__li13166938103319"></a><a name="li13166938103319"></a><strong id="EN-US_TOPIC_0000002233726938__b6167163893316">FAILED</strong>: The job failed.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li816712387336"><p id="EN-US_TOPIC_0000002233726938__p41671238153319"><a name="EN-US_TOPIC_0000002233726938__li816712387336"></a><a name="li816712387336"></a><strong id="EN-US_TOPIC_0000002233726938__b13167133818335">COMPLETED</strong>: The job is complete.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row5165038153315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p121678384336">step</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1916753814336">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p016793803313">Job step. Options:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul8167238153312"><li id="EN-US_TOPIC_0000002233726938__li1416717383335"><p id="EN-US_TOPIC_0000002233726938__p1416714388337"><a name="EN-US_TOPIC_0000002233726938__li1416717383335"></a><a name="li1416717383335"></a><strong id="EN-US_TOPIC_0000002233726938__b016716385331">1</strong>: Prepare storage.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li171671438133313"><p id="EN-US_TOPIC_0000002233726938__p2016773817332"><a name="EN-US_TOPIC_0000002233726938__li171671438133313"></a><a name="li171671438133313"></a><strong id="EN-US_TOPIC_0000002233726938__b6168438103315">2</strong>: Prepare compute resources.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li5168143818336"><p id="EN-US_TOPIC_0000002233726938__p1916816382339"><a name="EN-US_TOPIC_0000002233726938__li5168143818336"></a><a name="li5168143818336"></a><strong id="EN-US_TOPIC_0000002233726938__b216863817331">3</strong>: Configure the network.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li716813388333"><p id="EN-US_TOPIC_0000002233726938__p171687381336"><a name="EN-US_TOPIC_0000002233726938__li716813388333"></a><a name="li716813388333"></a><strong id="EN-US_TOPIC_0000002233726938__b5168143853320">4</strong>: Initialize the instance.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row3165638153314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p12168173823316">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_0000002233726938__p61681738113313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1316873853315">Description of a step in a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_EndpointsRes"></a><a name="en-us_topic_0000002091201317_response_EndpointsRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_EndpointsRes" frame="border" border="1" rules="all"><caption><b>Table 4 </b>EndpointsRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row18168173813337"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p11169113833311">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_0000002233726938__p101691838133319">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_0000002233726938__p13169133823310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row1616814381333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1616993810331">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_0000002233726938__p1169143893317">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_0000002233726938__p141701338123317">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_0000002233726938__row1616943814337"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p131701638143312">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_0000002233726938__p217013811337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p14170163893319">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul217012381338"><li id="EN-US_TOPIC_0000002233726938__li7170173812332"><p id="EN-US_TOPIC_0000002233726938__p517013813335"><a name="EN-US_TOPIC_0000002233726938__li7170173812332"></a><a name="li7170173812332"></a><strong id="EN-US_TOPIC_0000002233726938__b171701838153310">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li12170638183312"><p id="EN-US_TOPIC_0000002233726938__p41702381339"><a name="EN-US_TOPIC_0000002233726938__li12170638183312"></a><a name="li12170638183312"></a><strong id="EN-US_TOPIC_0000002233726938__b817010387338">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row13169163873316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p111701038123310">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_0000002233726938__p3170163803318">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_0000002233726938__p91711038203311">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_0000002233726938__row416933812339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p17171153818333">service</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p617114380337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p01711338163320">Path for accessing the notebook instance. The enumerated values are as follows:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul8171103819334"><li id="EN-US_TOPIC_0000002233726938__li131721238203319"><p id="EN-US_TOPIC_0000002233726938__p5172133818339"><a name="EN-US_TOPIC_0000002233726938__li131721238203319"></a><a name="li131721238203319"></a><strong id="EN-US_TOPIC_0000002233726938__b15172163873319">NOTEBOOK</strong>: You can access notebook instances using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li10172163883312"><p id="EN-US_TOPIC_0000002233726938__p617283816338"><a name="EN-US_TOPIC_0000002233726938__li10172163883312"></a><a name="li10172163883312"></a><strong id="EN-US_TOPIC_0000002233726938__b11172183883311">SSH</strong>: You can remotely access the notebook instance through SSH.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row3169123812331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p917210385338">uri</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p131723387337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1217219381337">Private IP address of the instance</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_Image"></a><a name="en-us_topic_0000002091201317_response_Image"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_Image" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Image</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row2017373817338"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p1117583815333">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_0000002233726938__p1617573853313">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_0000002233726938__p13175438193311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row617353812333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p2175143893311">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p517553815333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p17175153893313">Processor architecture supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul141751138193319"><li id="EN-US_TOPIC_0000002233726938__li111756386337"><p id="EN-US_TOPIC_0000002233726938__p111751938193310"><a name="EN-US_TOPIC_0000002233726938__li111756386337"></a><a name="li111756386337"></a><strong id="EN-US_TOPIC_0000002233726938__b1017553893316">X86_64</strong>: x86 architecture</p>
</li><li id="EN-US_TOPIC_0000002233726938__li15175638113317"><p id="EN-US_TOPIC_0000002233726938__p317513811339"><a name="EN-US_TOPIC_0000002233726938__li15175638113317"></a><a name="li15175638113317"></a><strong id="EN-US_TOPIC_0000002233726938__b1617515383339">AARCH64</strong>: Arm architecture</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row41732383334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p151758388332">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_0000002233726938__p161761338193317">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1517623810337">Specifies the time (UTC ms) when the image is created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row141734389338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1176133873318">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p817615388336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p41766383335">Image description with a maximum of 512 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row3173173815331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p917673863310">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_0000002233726938__p111762389339">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_0000002233726938__p19176203813331">Services supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul14176938133313"><li id="EN-US_TOPIC_0000002233726938__li1317673815338"><p id="EN-US_TOPIC_0000002233726938__p141761838143314"><a name="EN-US_TOPIC_0000002233726938__li1317673815338"></a><a name="li1317673815338"></a><strong id="EN-US_TOPIC_0000002233726938__b81761238163318">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li81762386331"><p id="EN-US_TOPIC_0000002233726938__p8176123810333"><a name="EN-US_TOPIC_0000002233726938__li81762386331"></a><a name="li81762386331"></a><strong id="EN-US_TOPIC_0000002233726938__b517663833315">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_0000002233726938__row2017363863311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p17177838183320">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p17177163810334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p11177113873319">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_0000002233726938__row517319388338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p11177103811336">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p417716382335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p111771938173318">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_0000002233726938__row417343812338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p16177113893317">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p41773389336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1517833811331">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002233726938__b317811380332">Organization Management</strong> page of the SWR console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row1417303816330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p2178938133319">origin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p317833813333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p317812380333">Image source, which defaults to <strong id="EN-US_TOPIC_0000002233726938__b171781638173318">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul1117843810332"><li id="EN-US_TOPIC_0000002233726938__li117873810334"><p id="EN-US_TOPIC_0000002233726938__p91787386330"><a name="EN-US_TOPIC_0000002233726938__li117873810334"></a><a name="li117873810334"></a><strong id="EN-US_TOPIC_0000002233726938__b201781038113318">CUSTOMIZE</strong>: custom image</p>
</li><li id="EN-US_TOPIC_0000002233726938__li1617933813312"><p id="EN-US_TOPIC_0000002233726938__p141791538183316"><a name="EN-US_TOPIC_0000002233726938__li1617933813312"></a><a name="li1617933813312"></a><strong id="EN-US_TOPIC_0000002233726938__b10179113893312">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row31730388338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p617943814335">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_0000002233726938__p141796381337">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_0000002233726938__p817973893312">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul1217973816336"><li id="EN-US_TOPIC_0000002233726938__li317903893310"><p id="EN-US_TOPIC_0000002233726938__p16179103811337"><a name="EN-US_TOPIC_0000002233726938__li317903893310"></a><a name="li317903893310"></a><strong id="EN-US_TOPIC_0000002233726938__b917953803315">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726938__li5179738203313"><p id="EN-US_TOPIC_0000002233726938__p1717903814334"><a name="EN-US_TOPIC_0000002233726938__li5179738203313"></a><a name="li5179738203313"></a><strong id="EN-US_TOPIC_0000002233726938__b1117923813334">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row61731238103316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p2179038113316">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_0000002233726938__p19179123818336">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p18179338113317">Supported image types. Options:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul218093816332"><li id="EN-US_TOPIC_0000002233726938__li14180938143318"><p id="EN-US_TOPIC_0000002233726938__p131809384337"><a name="EN-US_TOPIC_0000002233726938__li14180938143318"></a><a name="li14180938143318"></a><strong id="EN-US_TOPIC_0000002233726938__b4180038163310">COMMON</strong>: common image</p>
</li><li id="EN-US_TOPIC_0000002233726938__li11180438193315"><p id="EN-US_TOPIC_0000002233726938__p15180123893310"><a name="EN-US_TOPIC_0000002233726938__li11180438193315"></a><a name="li11180438193315"></a><strong id="EN-US_TOPIC_0000002233726938__b11180133883320">INFERENCE</strong>: image used for inference</p>
</li><li id="EN-US_TOPIC_0000002233726938__li121801138123312"><p id="EN-US_TOPIC_0000002233726938__p6180138113315"><a name="EN-US_TOPIC_0000002233726938__li121801138123312"></a><a name="li121801138123312"></a>TRAIN: image used for training</p>
</li><li id="EN-US_TOPIC_0000002233726938__li180853863313"><p id="EN-US_TOPIC_0000002233726938__p1808103883313"><a name="EN-US_TOPIC_0000002233726938__li180853863313"></a><a name="li180853863313"></a>DEV: image used for development and debugging</p>
</li><li id="EN-US_TOPIC_0000002233726938__li8808193820331"><p id="EN-US_TOPIC_0000002233726938__p1280817385330"><a name="EN-US_TOPIC_0000002233726938__li8808193820331"></a><a name="li8808193820331"></a>UNKNOWN: image whose supported services are not specified</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row10174538123316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p16808153863317">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p88081038133316">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p168081038123315">Specifies the image size, in KB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row171741038113312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p480814388333">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p380813843318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p12808193853315">Image status. Options:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul1180853810339"><li id="EN-US_TOPIC_0000002233726938__li9808123814337"><p id="EN-US_TOPIC_0000002233726938__p78081438173311"><a name="EN-US_TOPIC_0000002233726938__li9808123814337"></a><a name="li9808123814337"></a><strong id="EN-US_TOPIC_0000002233726938__b1980873812331">INIT</strong>: The image is being initialized.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li12808238143318"><p id="EN-US_TOPIC_0000002233726938__p1180893812336"><a name="EN-US_TOPIC_0000002233726938__li12808238143318"></a><a name="li12808238143318"></a><strong id="EN-US_TOPIC_0000002233726938__b980812384338">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li1880833819331"><p id="EN-US_TOPIC_0000002233726938__p1980819383332"><a name="EN-US_TOPIC_0000002233726938__li1880833819331"></a><a name="li1880833819331"></a><strong id="EN-US_TOPIC_0000002233726938__b8808838203317">CREATE_FAILED</strong>: Saving the image failed.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li28089380339"><p id="EN-US_TOPIC_0000002233726938__p15808203853316"><a name="EN-US_TOPIC_0000002233726938__li28089380339"></a><a name="li28089380339"></a><strong id="EN-US_TOPIC_0000002233726938__b580873812334">ERROR</strong>: An error occurs.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li180810385332"><p id="EN-US_TOPIC_0000002233726938__p1480863833320"><a name="EN-US_TOPIC_0000002233726938__li180810385332"></a><a name="li180810385332"></a><strong id="EN-US_TOPIC_0000002233726938__b7808133818334">DELETED</strong>: The image has been deleted.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li180816386337"><p id="EN-US_TOPIC_0000002233726938__p2808838203319"><a name="EN-US_TOPIC_0000002233726938__li180816386337"></a><a name="li180816386337"></a><strong id="EN-US_TOPIC_0000002233726938__b2080893813330">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_0000002233726938__row817443843317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p17808193812335">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_0000002233726938__p1680833819333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p198081238183312">Build information during image saving</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row6174163893318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p0808638143313">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_0000002233726938__p12808133873310">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_0000002233726938__p8808838103314">Flavors supported by the image. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul28081038163320"><li id="EN-US_TOPIC_0000002233726938__li9808123819334"><p id="EN-US_TOPIC_0000002233726938__p15808938123318"><a name="EN-US_TOPIC_0000002233726938__li9808123819334"></a><a name="li9808123819334"></a><strong id="EN-US_TOPIC_0000002233726938__b1180883803312">CPU</strong></p>
</li><li id="EN-US_TOPIC_0000002233726938__li16808338163317"><p id="EN-US_TOPIC_0000002233726938__p1280910388335"><a name="EN-US_TOPIC_0000002233726938__li16808338163317"></a><a name="li16808338163317"></a><strong id="EN-US_TOPIC_0000002233726938__b12809193811333">GPU</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row21741638143317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p6809103813337">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_0000002233726938__p1980912388331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p180963803315">SWR image address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row18174193810334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p480973863318">tag</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p280913873318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p18809123813310">Image tag</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row13174238133315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p6809153823310">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p6809193863310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p14809838153317">Image type. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul380983811333"><li id="EN-US_TOPIC_0000002233726938__li48091538183314"><p id="EN-US_TOPIC_0000002233726938__p1680993843313"><a name="EN-US_TOPIC_0000002233726938__li48091538183314"></a><a name="li48091538183314"></a><strong id="EN-US_TOPIC_0000002233726938__b19809153853312">BUILD_IN</strong>: built-in system image</p>
</li><li id="EN-US_TOPIC_0000002233726938__li68091438143314"><p id="EN-US_TOPIC_0000002233726938__p080910382334"><a name="EN-US_TOPIC_0000002233726938__li68091438143314"></a><a name="li68091438143314"></a><strong id="EN-US_TOPIC_0000002233726938__b168091038133313">DEDICATED</strong>: image you have saved</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row8174173820332"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p380953863319">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_0000002233726938__p168091038183315">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p580933819334">Specifies the time (UTC ms) when the image was last updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row13174173818334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p6809123813319">visibility</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p7809438203319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p180993815339">Image visibility. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul0809143823311"><li id="EN-US_TOPIC_0000002233726938__li780923833316"><p id="EN-US_TOPIC_0000002233726938__p8809738163313"><a name="EN-US_TOPIC_0000002233726938__li780923833316"></a><a name="li780923833316"></a><strong id="EN-US_TOPIC_0000002233726938__b1780913383339">PRIVATE</strong>: private image</p>
</li><li id="EN-US_TOPIC_0000002233726938__li380973815339"><p id="EN-US_TOPIC_0000002233726938__p680993817332"><a name="EN-US_TOPIC_0000002233726938__li380973815339"></a><a name="li380973815339"></a><strong id="EN-US_TOPIC_0000002233726938__b1480933813311">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row817453843313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p11809113813311">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_0000002233726938__p17809123819337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p19809103873311">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002233726938__b980983814332">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row12174193863313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p8809103814339">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_0000002233726938__p380917382338">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p9809138173317">Image resource type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_Lease"></a><a name="en-us_topic_0000002091201317_response_Lease"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_Lease" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Lease</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row1218920387339"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p081043816333">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_0000002233726938__p7810538143317">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_0000002233726938__p581093816334">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row16189203819331"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p581073823318">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_0000002233726938__p19810638143310">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p198101238183313">Time (UTC) when the instance is created, accurate to millisecond.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row11189203873312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p138102382336">duration</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1881093811339">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p178101438153313">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_0000002233726938__row8189738163320"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p11810133810334">enable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p19810183863315">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1681013883311">Whether to enable auto stop of the instance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row518993853310"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p5810183873314">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p3810133843316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p0810438103315">Indicates the automatic stop type.</p>
<ul id="EN-US_TOPIC_0000002233726938__ul158101738143316"><li id="EN-US_TOPIC_0000002233726938__li58101238103315"><p id="EN-US_TOPIC_0000002233726938__p10810173814339"><a name="EN-US_TOPIC_0000002233726938__li58101238103315"></a><a name="li58101238103315"></a>timing: The task is automatically stopped.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li1381073883315"><p id="EN-US_TOPIC_0000002233726938__p581011380333"><a name="EN-US_TOPIC_0000002233726938__li1381073883315"></a><a name="li1381073883315"></a>idle: The task is stopped when it is idle.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row11189193818336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p281012381333">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_0000002233726938__p11810638133314">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p2081033863310">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_0000002233726938__en-us_topic_0000002091201317_response_Pool"></a><a name="en-us_topic_0000002091201317_response_Pool"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_Pool" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Pool</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row519293863316"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p12810133813332">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_0000002233726938__p5810153823310">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_0000002233726938__p1281023853319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row119333815338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p2810638133319">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1981023813331">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p78101038193310">ID of a dedicated resource pool</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row1319363816334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1281053863317">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p14810238173311">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p48101938183318">Name of a dedicated resource pool</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_VolumeRes"></a><a name="en-us_topic_0000002091201317_response_VolumeRes"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_VolumeRes" frame="border" border="1" rules="all"><caption><b>Table 8 </b>VolumeRes</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row1419543811337"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p8811153813315">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_0000002233726938__p881103812331">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_0000002233726938__p1881133818333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row13195438193312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p3811138163317">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p128111138203312">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p17811738193318">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_0000002233726938__row1519583815338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p081116386338">category</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p8811438113320">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p18111338173317">Supported storage types. For details about the differences between the storage types, see"Selecting Storage in DevEnviron" in <em id="EN-US_TOPIC_0000002233726938__i128111380335">User Guide</em>. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul19811538143312"><li id="EN-US_TOPIC_0000002233726938__li981123818338"><p id="EN-US_TOPIC_0000002233726938__p481115385336"><a name="EN-US_TOPIC_0000002233726938__li981123818338"></a><a name="li981123818338"></a><strong id="EN-US_TOPIC_0000002233726938__b1781112383333">SFS</strong></p>
</li><li id="EN-US_TOPIC_0000002233726938__li3811153812336"><p id="EN-US_TOPIC_0000002233726938__p88111381331"><a name="EN-US_TOPIC_0000002233726938__li3811153812336"></a><a name="li3811153812336"></a><strong id="EN-US_TOPIC_0000002233726938__b12811938103311">EVS</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row3195153863319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1981111386332">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_0000002233726938__p881173823316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p1381113814336">Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is <strong id="EN-US_TOPIC_0000002233726938__b128111338203310">/home/ma-user/work/</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row119523893316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1681153843310">ownership</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1181153813333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p38119386337">Owner to which the resource belongs. Enums:</p>
<ul id="EN-US_TOPIC_0000002233726938__ul168111838113316"><li id="EN-US_TOPIC_0000002233726938__li1981114389333"><p id="EN-US_TOPIC_0000002233726938__p148110385335"><a name="EN-US_TOPIC_0000002233726938__li1981114389333"></a><a name="li1981114389333"></a><strong id="EN-US_TOPIC_0000002233726938__b1381113386332">MANAGED</strong>: Resources are managed by the service.</p>
</li><li id="EN-US_TOPIC_0000002233726938__li1681112382331"><p id="EN-US_TOPIC_0000002233726938__p1811133893316"><a name="EN-US_TOPIC_0000002233726938__li1681112382331"></a><a name="li1681112382331"></a><strong id="EN-US_TOPIC_0000002233726938__b16811438193312">DEDICATED</strong>: Resources are managed by the user account. This mode is supported only when the instance category is <strong id="EN-US_TOPIC_0000002233726938__b17811338113310">EFS</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row12195133823312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p6811203820336">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p17811173810337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p481111387337">EVS disk capacity expansion status, which is <strong id="EN-US_TOPIC_0000002233726938__b20811173811331">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_0000002233726938__en-us_topic_0000002091201317_response_user"></a><a name="en-us_topic_0000002091201317_response_user"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_user" frame="border" border="1" rules="all"><caption><b>Table 9 </b>user</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row01981038153318"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.10.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p1681113384331">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_0000002233726938__p98111538183315">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_0000002233726938__p18811438203314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row0198183818339"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p681183814337">domain</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p12811133818332"><a href="#EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_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_0000002233726938__p6812193873315">Account domain information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row1819863823318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p138122382335">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1181273814335">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p4812163813319">IAM user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row3198193883313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p1981213382333">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.10.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p1781253813330">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p58121138133311">IAM username.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_domain"></a><a name="en-us_topic_0000002091201317_response_domain"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_response_domain" frame="border" border="1" rules="all"><caption><b>Table 10 </b>domain</caption><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row112001538123315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000002233726938__p9812113893319">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_0000002233726938__p1481253816336">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_0000002233726938__p8812193833312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row1720019388333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p10812173812333">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p981220387330">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p381220385332">Account ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row1320014386338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000002233726938__p381213381331">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000002233726938__p481273812334">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000002233726938__p0812238123317">Account name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726938__section128121338103313"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002233726938__screen14812143816331">GET https://{endpoint}/v1/{project_id}/notebooks/{id}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726938__section188121038103315"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002233726938__p6812153818338"><strong id="EN-US_TOPIC_0000002233726938__b98122038143314">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002233726938__p5812113803310">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000002233726938__screen7812113811330">{
"description" : "api-test",
"feature" : "NOTEBOOK",
"flavor" : "modelarts.vm.cpu.2u",
"id" : "f9937afa-631e-4a8f-a8f7-3b6c800585f0",
"image" : {
"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.1.B007_V2",
"type" : "BUILD_IN"
},
"lease" : {
"create_at" : 1638778344300,
"duration" : 3600000,
"enable" : true,
"update_at" : 1638778344300
},
"name" : "notebooks_test",
"status" : "CREATING",
"token" : "7b22482a-a4cb-4b46-e3b3-6a793a47967e",
"url" : "https://authoring-modelarts-xxxxx.xxxxx.com/f9937afa-631e-4a8f-a8f7-3b6c800585f0/lab",
"workspace_id" : "0"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726938__section19813133863310"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002233726938__en-us_topic_0000002091201317_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002233726938__row12203113853316"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002233726938__p168139389330">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_0000002233726938__p198131938113314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002233726938__row142036385335"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726938__p11813153833317">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726938__p16813103819338">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row11203193816330"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726938__p11813338193312">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726938__p5813153883310">Unauthorized</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row320313387339"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726938__p3813163813337">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726938__p19813113813311">Forbidden</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002233726938__row2203183843317"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002233726938__p28131938193318">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002233726938__p4813143883316">Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002233726938__section188131838113312"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002233726938__p58131382338">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