forked from docs/doc-exports
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>
455 lines
41 KiB
HTML
455 lines
41 KiB
HTML
<a name="EN-US_TOPIC_0000002341058306"></a><a name="EN-US_TOPIC_0000002341058306"></a>
|
|
|
|
<h1 class="topictitle1">Querying Supported Images</h1>
|
|
<div id="body32001227"><div class="section" id="EN-US_TOPIC_0000002341058306__section76966252816"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002341058306__p5696425281">This API is used to query all images by page based on specified conditions.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002341058306__section10697425581"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002341058306__p1669711251789">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002341058306__section4698152518820"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002341058306__p1698325889">GET /v1/{project_id}/images</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058306__table47001025488" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058306__row569920258817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002341058306__p77018254812">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_0000002341058306__p7701152520814">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_0000002341058306__p10702192512811">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_0000002341058306__p15702125787">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002341058306__row470022517814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p770214258810">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_0000002341058306__p197027252816">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p11703152518818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p270314251682">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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058306__table4707725685" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058306__row6705192519813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000002341058306__p670752515818">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000002341058306__p187084251816">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000002341058306__p157081525682">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000002341058306__p1170813251814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002341058306__row970516251087"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p5709225485">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p270962514814">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p177091125789">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p770916259813">Number of records on each page. The default value is <strong id="EN-US_TOPIC_0000002341058306__b1270912511818">200</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row5705925789"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p17709182514815">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p167104251483">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p47103251488">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p107101925584">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_0000002341058306__row127055251382"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p271016251885">name_fuzzy_match</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1071016251581">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p9710825089">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p20711172510814">Whether the image name is used for fuzzy match. The default value is <strong id="EN-US_TOPIC_0000002341058306__b171116255817">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row17059251284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p18711112513812">namespace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p771114251788">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p37115252816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p77113251581">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002341058306__b17712125786">Organization Management</strong> page of the SWR console.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row3706142517815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p137122258818">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1771212513811">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p107121625283">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p167128255817">Start offset of the records on each page. The default value is <strong id="EN-US_TOPIC_0000002341058306__b1171212252815">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row470612251688"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p1171252514818">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p20713192518817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p15713112512818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p17135252811">Supported image types. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul16713142518816"><li id="EN-US_TOPIC_0000002341058306__li771316257820"><p id="EN-US_TOPIC_0000002341058306__p67135259812"><a name="EN-US_TOPIC_0000002341058306__li771316257820"></a><a name="li771316257820"></a><strong id="EN-US_TOPIC_0000002341058306__b071318251081">COMMON</strong>: common image</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li13713225589"><p id="EN-US_TOPIC_0000002341058306__p167131325689"><a name="EN-US_TOPIC_0000002341058306__li13713225589"></a><a name="li13713225589"></a><strong id="EN-US_TOPIC_0000002341058306__b77139253815">INFERENCE</strong>: image used for inference</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li1371392516813"><p id="EN-US_TOPIC_0000002341058306__p2071318251583"><a name="EN-US_TOPIC_0000002341058306__li1371392516813"></a><a name="li1371392516813"></a>TRAIN: image used for training</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li67144251784"><p id="EN-US_TOPIC_0000002341058306__p4714142510817"><a name="EN-US_TOPIC_0000002341058306__li67144251784"></a><a name="li67144251784"></a>DEV: image used for development and debugging</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li157141125384"><p id="EN-US_TOPIC_0000002341058306__p127146253810"><a name="EN-US_TOPIC_0000002341058306__li157141125384"></a><a name="li157141125384"></a>UNKNOWN: image whose supported services are not specified</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row1706112510812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p117141625281">sort_dir</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p17714192517812">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p67144251187">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p97141225784">Sorting mode. The options are <strong id="EN-US_TOPIC_0000002341058306__b1071412251488">ASC</strong> (ascending order) and <strong id="EN-US_TOPIC_0000002341058306__b1714225786">DESC</strong> (descending order). The default value is <strong id="EN-US_TOPIC_0000002341058306__b15714192511810">DESC</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row17069259816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p127141625182">sort_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p571432520815">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1271516251888">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p47156251189">Sorting fields. Separate multiple fields with commas (,). For example, <strong id="EN-US_TOPIC_0000002341058306__b16715725687">updateTime</strong> indicates sorting by update time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row1170615251881"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p1071522513819">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p167151259812">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p97159251587">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p127153257810">Image type. Enums:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul1471518257819"><li id="EN-US_TOPIC_0000002341058306__li67154258820"><p id="EN-US_TOPIC_0000002341058306__p137154257811"><a name="EN-US_TOPIC_0000002341058306__li67154258820"></a><a name="li67154258820"></a><strong id="EN-US_TOPIC_0000002341058306__b1571510251384">BUILD_IN</strong>: built-in system image</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li071612250813"><p id="EN-US_TOPIC_0000002341058306__p1871662516817"><a name="EN-US_TOPIC_0000002341058306__li071612250813"></a><a name="li071612250813"></a><strong id="EN-US_TOPIC_0000002341058306__b27161325585">DEDICATED</strong>: image you have saved</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row97061251884"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002341058306__p107168251686">workspace_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002341058306__p18716162518818">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1671618250810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002341058306__p157167257819">Workspace ID If no workspace is created, the default value is 0. If a workspace is created and used, the actual value prevails.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002341058306__section1771672518819"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002341058306__p167161225789">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002341058306__section8716425381"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002341058306__p167171252813"><strong id="EN-US_TOPIC_0000002341058306__b871716259815">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058306__en-us_topic_0000002055164070_response_ImageListResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058306__row1271715254811"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002341058306__p1771813250816">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_0000002341058306__p8718152511819">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_0000002341058306__p2718125383">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002341058306__row27172255814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p127182251685">current</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p187181025088">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1271814251182">Current page</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row471719251788"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p187191257813">data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1472014259816">Array of <a href="#EN-US_TOPIC_0000002341058306__en-us_topic_0000002055164070_response_ImageResponse">ImageResponse</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_0000002341058306__p1072052517819">Data</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row371715251819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p37209251815">pages</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p117209256817">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p772012519812">Total pages</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row07178256819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p177203251684">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p16720162511818">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p872052519812">Number of records on each page</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row671711256817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p1472016259817">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1972120258815">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p2721162514819">Total records</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002341058306__en-us_topic_0000002055164070_response_ImageResponse"></a><a name="en-us_topic_0000002055164070_response_ImageResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058306__en-us_topic_0000002055164070_response_ImageResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ImageResponse</caption><thead align="left"><tr id="EN-US_TOPIC_0000002341058306__row107215251786"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002341058306__p47241025482">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_0000002341058306__p1072417251783">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_0000002341058306__p27242251783">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002341058306__row5721225681"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p47241725988">arch</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p172412511813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p372519255816">Processor architecture supported by the image. Enums:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul107253251188"><li id="EN-US_TOPIC_0000002341058306__li8725172517816"><p id="EN-US_TOPIC_0000002341058306__p157255251885"><a name="EN-US_TOPIC_0000002341058306__li8725172517816"></a><a name="li8725172517816"></a><strong id="EN-US_TOPIC_0000002341058306__b37251125288">X86_64</strong>: x86 architecture</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li172514251289"><p id="EN-US_TOPIC_0000002341058306__p197253251986"><a name="EN-US_TOPIC_0000002341058306__li172514251289"></a><a name="li172514251289"></a><strong id="EN-US_TOPIC_0000002341058306__b11725132515811">AARCH64</strong>: Arm architecture</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row127222252082"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p187251025383">create_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p57251825789">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1672532518812">Time (UTC) when the image is created, accurate to millisecond</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row472219251184"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p147255255818">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1572619251184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1172652518817">Image description with a maximum of 512 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row207222254819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p197262251281">dev_services</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p107265251386">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1726125081">Services supported by the image. Enums:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul1472618252813"><li id="EN-US_TOPIC_0000002341058306__li1872692512816"><p id="EN-US_TOPIC_0000002341058306__p1726325383"><a name="EN-US_TOPIC_0000002341058306__li1872692512816"></a><a name="li1872692512816"></a><strong id="EN-US_TOPIC_0000002341058306__b137261625783">NOTEBOOK</strong>: You can access a notebook instance using HTTPS.</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li1372614255818"><p id="EN-US_TOPIC_0000002341058306__p872610257810"><a name="EN-US_TOPIC_0000002341058306__li1372614255818"></a><a name="li1372614255818"></a><strong id="EN-US_TOPIC_0000002341058306__b207267251282">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_0000002341058306__row207229259819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p1872620251784">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p127277251885">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p137271925683">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_0000002341058306__row117221257815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p1472715251780">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p17727102518815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p177271325388">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_0000002341058306__row16722162516811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p1872712251089">namespace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1872712252815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p272715253815">Organization to which the image belongs. You can create and view the organization on the <strong id="EN-US_TOPIC_0000002341058306__b147273250817">Organization Management</strong> page of the SWR console.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row1072217251882"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p17281425684">origin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p47280251086">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p772818251680">Image source, which defaults to <strong id="EN-US_TOPIC_0000002341058306__b117281925685">CUSTOMIZE</strong>. This parameter is optional. Enums:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul147281925786"><li id="EN-US_TOPIC_0000002341058306__li27281725584"><p id="EN-US_TOPIC_0000002341058306__p1872817251982"><a name="EN-US_TOPIC_0000002341058306__li27281725584"></a><a name="li27281725584"></a><strong id="EN-US_TOPIC_0000002341058306__b8728182512811">CUSTOMIZE</strong>: custom image</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li1772882519818"><p id="EN-US_TOPIC_0000002341058306__p1572872513810"><a name="EN-US_TOPIC_0000002341058306__li1772882519818"></a><a name="li1772882519818"></a><strong id="EN-US_TOPIC_0000002341058306__b20728142512814">IMAGE_SAVE</strong>: image saved by a notebook instance</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row147221125684"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p197281725482">resource_categories</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p772910252812">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p3729172518816">Flavors supported by the image. Enums:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul19729192514818"><li id="EN-US_TOPIC_0000002341058306__li16729182513818"><p id="EN-US_TOPIC_0000002341058306__p472913259818"><a name="EN-US_TOPIC_0000002341058306__li16729182513818"></a><a name="li16729182513818"></a><strong id="EN-US_TOPIC_0000002341058306__b472917253810">CPU</strong></p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li1572918252818"><p id="EN-US_TOPIC_0000002341058306__p572916251882"><a name="EN-US_TOPIC_0000002341058306__li1572918252818"></a><a name="li1572918252818"></a><strong id="EN-US_TOPIC_0000002341058306__b972917251380">GPU</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row47221525381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p67299255811">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1572942516817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p57290252086">Supported image types. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul072912255820"><li id="EN-US_TOPIC_0000002341058306__li167297251682"><p id="EN-US_TOPIC_0000002341058306__p472915251687"><a name="EN-US_TOPIC_0000002341058306__li167297251682"></a><a name="li167297251682"></a><strong id="EN-US_TOPIC_0000002341058306__b117291525388">COMMON</strong>: common image</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li197309254818"><p id="EN-US_TOPIC_0000002341058306__p1873022512818"><a name="EN-US_TOPIC_0000002341058306__li197309254818"></a><a name="li197309254818"></a><strong id="EN-US_TOPIC_0000002341058306__b16730325484">INFERENCE</strong>: image used for inference</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li16730825886"><p id="EN-US_TOPIC_0000002341058306__p573012253812"><a name="EN-US_TOPIC_0000002341058306__li16730825886"></a><a name="li16730825886"></a>TRAIN: image used for training</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li1073014251982"><p id="EN-US_TOPIC_0000002341058306__p1073016252816"><a name="EN-US_TOPIC_0000002341058306__li1073014251982"></a><a name="li1073014251982"></a>DEV: image used for development and debugging</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li20730152516812"><p id="EN-US_TOPIC_0000002341058306__p373017251820"><a name="EN-US_TOPIC_0000002341058306__li20730152516812"></a><a name="li20730152516812"></a>UNKNOWN: image whose supported services are not specified</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row12722325282"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p187302025486">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p16730725584">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p373016251383">Specifies the image size, in KB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row1972242515814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p37301725481">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1273010257813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1773116259817">Image status. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul12731625886"><li id="EN-US_TOPIC_0000002341058306__li117319251089"><p id="EN-US_TOPIC_0000002341058306__p17731102518818"><a name="EN-US_TOPIC_0000002341058306__li117319251089"></a><a name="li117319251089"></a><strong id="EN-US_TOPIC_0000002341058306__b4731142515814">INIT</strong>: The image is being initialized.</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li57313251281"><p id="EN-US_TOPIC_0000002341058306__p673142514819"><a name="EN-US_TOPIC_0000002341058306__li57313251281"></a><a name="li57313251281"></a><strong id="EN-US_TOPIC_0000002341058306__b147315257814">CREATING</strong>: The image is being saved. In this case, the notebook instance is unavailable.</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li1673114251388"><p id="EN-US_TOPIC_0000002341058306__p177315251184"><a name="EN-US_TOPIC_0000002341058306__li1673114251388"></a><a name="li1673114251388"></a><strong id="EN-US_TOPIC_0000002341058306__b573232515810">CREATE_FAILED</strong>: Saving the image failed.</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li3732172520817"><p id="EN-US_TOPIC_0000002341058306__p1973212251288"><a name="EN-US_TOPIC_0000002341058306__li3732172520817"></a><a name="li3732172520817"></a><strong id="EN-US_TOPIC_0000002341058306__b127328251682">ERROR</strong>: An error occurs.</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li157323251381"><p id="EN-US_TOPIC_0000002341058306__p167322252817"><a name="EN-US_TOPIC_0000002341058306__li157323251381"></a><a name="li157323251381"></a><strong id="EN-US_TOPIC_0000002341058306__b173215251086">DELETED</strong>: The image has been deleted.</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li1373242511814"><p id="EN-US_TOPIC_0000002341058306__p107332259817"><a name="EN-US_TOPIC_0000002341058306__li1373242511814"></a><a name="li1373242511814"></a><strong id="EN-US_TOPIC_0000002341058306__b187331725287">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_0000002341058306__row072312517812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p19733625583">status_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p4733142516814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p77338253811">Build information during image saving</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row167232255820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p4733182510818">swr_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p177334255810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1473352516813">SWR image address</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row13723112520812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p6733025289">tag</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p47331925984">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p77344251481">Image tag</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row6723182519817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p073411251384">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p7734525985">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p073418257813">Image type. Enums:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul157341025387"><li id="EN-US_TOPIC_0000002341058306__li1573414251287"><p id="EN-US_TOPIC_0000002341058306__p573417256814"><a name="EN-US_TOPIC_0000002341058306__li1573414251287"></a><a name="li1573414251287"></a><strong id="EN-US_TOPIC_0000002341058306__b97341256813">BUILD_IN</strong>: built-in system image</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li1973462516819"><p id="EN-US_TOPIC_0000002341058306__p1573414251181"><a name="EN-US_TOPIC_0000002341058306__li1973462516819"></a><a name="li1973462516819"></a><strong id="EN-US_TOPIC_0000002341058306__b573416253812">DEDICATED</strong>: image you have saved</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row2723162514814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p273492519817">update_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1273516255811">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p37351225382">Time (UTC) when the image was last updated, accurate to millisecond</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row1723162513813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p1273518251080">visibility</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p573516252818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p973513255816">Image visibility. Options:</p>
|
|
<ul id="EN-US_TOPIC_0000002341058306__ul1073516254814"><li id="EN-US_TOPIC_0000002341058306__li173562510817"><p id="EN-US_TOPIC_0000002341058306__p773517258813"><a name="EN-US_TOPIC_0000002341058306__li173562510817"></a><a name="li173562510817"></a><strong id="EN-US_TOPIC_0000002341058306__b773519256811">PRIVATE</strong>: private image</p>
|
|
</li><li id="EN-US_TOPIC_0000002341058306__li137358251289"><p id="EN-US_TOPIC_0000002341058306__p8735182516815"><a name="EN-US_TOPIC_0000002341058306__li137358251289"></a><a name="li137358251289"></a><strong id="EN-US_TOPIC_0000002341058306__b1873515253813">PUBLIC</strong>: All users can perform read-only operations based on the image ID.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row137231825389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002341058306__p973519256813">workspace_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1373517257819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002341058306__p1473511251283">Workspace ID. If no workspaces are available, the default value is <strong id="EN-US_TOPIC_0000002341058306__b1073612513817">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002341058306__section97364251983"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002341058306__screen3736152512811">GET https://{endpoint}/v1/{project_id}/images</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002341058306__section1773718253820"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002341058306__p17737825088"><strong id="EN-US_TOPIC_0000002341058306__b373717251886">Status code: 200</strong></p>
|
|
<p id="EN-US_TOPIC_0000002341058306__p1973720255812">OK</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002341058306__screen1737132515820">{
|
|
"current" : 4,
|
|
"data" : [ {
|
|
"arch" : "x86_64",
|
|
"create_at" : 1638841805439,
|
|
"description" : "AI inference application development, preconfigured ModelBox and AI engine LibTorch, only SSH connection supported.",
|
|
"dev_services" : [ "AI_FLOW", "SSH" ],
|
|
"id" : "e1a07296-22a8-4f05-8bc8-e936c8e54103",
|
|
"name" : "modelbox1.3.0-libtorch1.9.1-cuda10.2-cudnn8-euler2.9.6",
|
|
"resource_categories" : [ "GPU" ],
|
|
"service_type" : "TRAIN",
|
|
"status" : "ACTIVE",
|
|
"swr_path" : "swr.xxx.com/atelier/modelarts-modelbox-libtorch-gpu-x86:1.3.0-20221027202714-160a680",
|
|
"tag" : "1.3.0-20221027202714-160a680",
|
|
"type" : "BUILD_IN",
|
|
"update_at" : 1638234504492,
|
|
"workspace_id" : "0"
|
|
}, {
|
|
"arch" : "x86_64",
|
|
"create_at" : 1638841805439,
|
|
"description" : "CPU and GPU general algorithm development and training, preconfigured with AI engine PyTorch1.8",
|
|
"dev_services" : [ "NOTEBOOK", "SSH" ],
|
|
"id" : "278e88d1-5b71-4766-8502-b3ba72e824d9",
|
|
"name" : "pytorch1.8-cuda10.2-cudnn7-ubuntu18.04",
|
|
"resource_categories" : [ "GPU", "CPU" ],
|
|
"service_type" : "COMMON",
|
|
"status" : "ACTIVE",
|
|
"swr_path" : "swr.xxx.com/atelier/pytorch_1_8:pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e",
|
|
"tag" : "pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e",
|
|
"type" : "BUILD_IN",
|
|
"update_at" : 1638234504492,
|
|
"workspace_id" : "0"
|
|
} ],
|
|
"pages" : 54,
|
|
"size" : 2,
|
|
"total" : 107
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002341058306__section8857925785"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002341058306__en-us_topic_0000002055164070_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002341058306__row107416256815"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002341058306__p98584251485">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_0000002341058306__p13858142515813">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002341058306__row137411425088"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058306__p585818253815">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058306__p28586252817">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row1774110252817"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058306__p16858162512817">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058306__p188582251284">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row1374115251082"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058306__p385820252815">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058306__p28581125882">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002341058306__row87412258816"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002341058306__p198587251584">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002341058306__p1285872517814">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002341058306__section128581325786"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002341058306__p17858162517815">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>
|
|
|