vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/ListPoolNodes.html
Lai, Weijian 68e5cd0687 ModelArts API 23.3.0 Version. 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
2024-06-18 11:02:37 +00:00

475 lines
33 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001910008036"></a><a name="EN-US_TOPIC_0000001910008036"></a>
<h1 class="topictitle1">Obtaining Nodes</h1>
<div id="body0000001599745693"><div class="section" id="EN-US_TOPIC_0000001910008036__section14455193765713"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001910008036__p12456437145714">This API is used to obtain nodes in a resource pool.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008036__section045603775714"><h4 class="sectiontitle">Debugging</h4><p id="EN-US_TOPIC_0000001910008036__p104582037165710">You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008036__section1045883717571"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001910008036__p445973795714">GET /v2/{project_id}/pools/{pool_name}/nodes</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__table1246423710576" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row1546013710577"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001910008036__p12465203775712">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_0000001910008036__p3466123712576">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_0000001910008036__p17466133755717">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_0000001910008036__p046814376575">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row134601371578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001910008036__p1946933712574">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_0000001910008036__p1947016379577">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001910008036__p11470183715716">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001910008036__p64711037115716">Project ID. For details, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row19462837105718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001910008036__p1847293710578">pool_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001910008036__p947333725713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001910008036__p9473123712574">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001910008036__p13474137165714">Name of a resource pool.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__table1847811379576" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row204762037155718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000001910008036__p1647823711573">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_0000001910008036__p16479183718575">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_0000001910008036__p2480173714575">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_0000001910008036__p1248013795718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row04769374574"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001910008036__p148116379578">continue</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001910008036__p84823379577">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001910008036__p548343713576">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001910008036__p144831637125713">Previous query location in pagination query.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row1947613785710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001910008036__p3484637135716">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001910008036__p548413376572">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001910008036__p1148523715572">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001910008036__p3486737185710">Number of records returned for a single pagination query.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008036__section5486183712579"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000001910008036__p648783717575">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008036__section7488143735719"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000001910008036__p1948933725713"><strong id="EN-US_TOPIC_0000001910008036__b18489637135717">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__response_NodeList" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row174913371572"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000001910008036__p18498103795718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000001910008036__p2499133785713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000001910008036__p75006377579">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row74913379571"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p95001137195714">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p12501113719572">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p16502937205716">API version. Options:</p>
<ul id="EN-US_TOPIC_0000001910008036__ul95031937195714"><li id="EN-US_TOPIC_0000001910008036__li650312378575"><p id="EN-US_TOPIC_0000001910008036__p20503203735712"><a name="EN-US_TOPIC_0000001910008036__li650312378575"></a><a name="li650312378575"></a><strong id="EN-US_TOPIC_0000001910008036__b1150410370573">v2</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row10491437145718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p3504337105712">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p1250553711570">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p9505137165718">Resource type. Options:</p>
<ul id="EN-US_TOPIC_0000001910008036__ul17506143715711"><li id="EN-US_TOPIC_0000001910008036__li8506337175716"><p id="EN-US_TOPIC_0000001910008036__p8506143717575"><a name="EN-US_TOPIC_0000001910008036__li8506337175716"></a><a name="li8506337175716"></a><strong id="EN-US_TOPIC_0000001910008036__b3507203785719">NodeList</strong>: nodes</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row8495173713577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p3507937145716">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p1350883710572"><a href="#EN-US_TOPIC_0000001910008036__response_NodeListMetadata">NodeListMetadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p45100375570">Metadata of resources.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row1495337145719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p145101137195719">items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p15511183795711">Array of <a href="#EN-US_TOPIC_0000001910008036__response_Node">Node</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p75122374574">Nodes.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001910008036__response_NodeListMetadata"></a><a name="response_NodeListMetadata"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__response_NodeListMetadata" frame="border" border="1" rules="all"><caption><b>Table 4 </b>NodeListMetadata</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row15131237185714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000001910008036__p185156377579">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="EN-US_TOPIC_0000001910008036__p7516123735714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="EN-US_TOPIC_0000001910008036__p165161837105717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row19513123714573"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p851713714576">continue</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p351953755720">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p1519173715718">Next query position during pagination query.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row95138377572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p0520173715576">remainingItemCount</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p15521113715715">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p0522173765714">Number of remaining resources.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001910008036__response_Node"></a><a name="response_Node"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__response_Node" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Node</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row1852383765716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000001910008036__p352619370576">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="EN-US_TOPIC_0000001910008036__p652753717573">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="EN-US_TOPIC_0000001910008036__p352818371576">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row15241637145713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p952833711571">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p1852983715575">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p6530037115713">API version. Options:</p>
<ul id="EN-US_TOPIC_0000001910008036__ul1753073711577"><li id="EN-US_TOPIC_0000001910008036__li5530113715573"><p id="EN-US_TOPIC_0000001910008036__p15530737145714"><a name="EN-US_TOPIC_0000001910008036__li5530113715573"></a><a name="li5530113715573"></a><strong id="EN-US_TOPIC_0000001910008036__b13531537165711">v2</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row1452473795715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p75318371571">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p1953210372575">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p353213375570">Resource type. Options:</p>
<ul id="EN-US_TOPIC_0000001910008036__ul053313379579"><li id="EN-US_TOPIC_0000001910008036__li11533437195715"><p id="EN-US_TOPIC_0000001910008036__p1353313718574"><a name="EN-US_TOPIC_0000001910008036__li11533437195715"></a><a name="li11533437195715"></a><strong id="EN-US_TOPIC_0000001910008036__b4534143710575">Node</strong>: node</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row9524103711577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p95355372572">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p1053513725714"><a href="#EN-US_TOPIC_0000001910008036__response_metadata">metadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p18536537195718">Specifies the node metadata information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row252433745716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p195373374572">spec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p16537163715577"><a href="#EN-US_TOPIC_0000001910008036__response_NodeSpec">NodeSpec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p1953814372576">Expected node information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row452413785717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p154043719572">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p5540337145716"><a href="#EN-US_TOPIC_0000001910008036__response_NodeStatus">NodeStatus</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p254173715712">Node status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001910008036__response_metadata"></a><a name="response_metadata"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__response_metadata" frame="border" border="1" rules="all"><caption><b>Table 6 </b>metadata</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row1754213718579"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000001910008036__p15544163719574">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="EN-US_TOPIC_0000001910008036__p3545153725717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="EN-US_TOPIC_0000001910008036__p1546237145717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row954293714575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p2546113712577">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p10547103710576">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p1354716375577">Node name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row1854383775714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p165481379576">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p15491237125713">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p155499372577">Creation time.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001910008036__response_NodeSpec"></a><a name="response_NodeSpec"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__response_NodeSpec" frame="border" border="1" rules="all"><caption><b>Table 7 </b>NodeSpec</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row855173735716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="EN-US_TOPIC_0000001910008036__p20552193717574">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="EN-US_TOPIC_0000001910008036__p195532037125717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="EN-US_TOPIC_0000001910008036__p6554153765710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row85515372578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p175551137175714">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p5555173719575">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p055683719573">Node specifications</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001910008036__response_NodeStatus"></a><a name="response_NodeStatus"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__response_NodeStatus" frame="border" border="1" rules="all"><caption><b>Table 8 </b>NodeStatus</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row855717376576"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="EN-US_TOPIC_0000001910008036__p1560123715575">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p id="EN-US_TOPIC_0000001910008036__p55601237105714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p id="EN-US_TOPIC_0000001910008036__p956133717576">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row955715377575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p1456263755719">phase</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p1156213735711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p15563133716577">Current status of a node. The options are as follows:</p>
<ul id="EN-US_TOPIC_0000001910008036__ul85631637105711"><li id="EN-US_TOPIC_0000001910008036__li1356411376577"><p id="EN-US_TOPIC_0000001910008036__p2564163716574"><a name="EN-US_TOPIC_0000001910008036__li1356411376577"></a><a name="li1356411376577"></a>Available: The node is available.</p>
</li><li id="EN-US_TOPIC_0000001910008036__li14564113725718"><p id="EN-US_TOPIC_0000001910008036__p15564837135712"><a name="EN-US_TOPIC_0000001910008036__li14564113725718"></a><a name="li14564113725718"></a>Creating: The node is being created.</p>
</li><li id="EN-US_TOPIC_0000001910008036__li14565143745718"><p id="EN-US_TOPIC_0000001910008036__p656563785714"><a name="EN-US_TOPIC_0000001910008036__li14565143745718"></a><a name="li14565143745718"></a>Deleting: The node is being deleted.</p>
</li><li id="EN-US_TOPIC_0000001910008036__li165651537195716"><p id="EN-US_TOPIC_0000001910008036__p656683765713"><a name="EN-US_TOPIC_0000001910008036__li165651537195716"></a><a name="li165651537195716"></a>Abnormal: The node is abnormal.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row455843735717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p45685376578">az</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p1256933735714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p956973755716">AZ that the node belongs to.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row13558437175712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p115708378576">privateIp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p1257183714577">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p6572203755712">Node IP address</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row1955816374574"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p257223725719">resources</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p257303713572"><a href="#EN-US_TOPIC_0000001910008036__response_NodeResource">NodeResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p19574837165711">Node resource information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row1455883755711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p1857513714578">availableResources</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p4576173715710"><a href="#EN-US_TOPIC_0000001910008036__response_NodeResource">NodeResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p1957793718579">Available resources of a node.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001910008036__response_NodeResource"></a><a name="response_NodeResource"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__response_NodeResource" frame="border" border="1" rules="all"><caption><b>Table 9 </b>NodeResource</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row1857883720575"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="EN-US_TOPIC_0000001910008036__p1358015378571">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="EN-US_TOPIC_0000001910008036__p1558193711578">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="EN-US_TOPIC_0000001910008036__p115821637155710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row857819378577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p2582537185719">cpu</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p458373715717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p12584143755718">Number of CPU resources.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row145780372570"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p14584193712576">memory</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p858573795713">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p25861137195714">Indicates the amount of memory resources.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row175781337175713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p1258616377578">nvidia.com/gpu</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p358733795712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p258813717574">Number of GPU resources on a GPU node.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0000001910008036__p1859363775713"><strong id="EN-US_TOPIC_0000001910008036__b2059473725715">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row20595337205713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="EN-US_TOPIC_0000001910008036__p3597113716577">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="EN-US_TOPIC_0000001910008036__p3598143775719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="EN-US_TOPIC_0000001910008036__p760253714574">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row2595163715711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p1760383710579">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p26041037125712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p9605133716576">Error code.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row5595153785712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="EN-US_TOPIC_0000001910008036__p2060613715571">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="EN-US_TOPIC_0000001910008036__p206068379579">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="EN-US_TOPIC_0000001910008036__p15607133715714">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008036__section46071937175715"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000001910008036__p14608173717576">Obtain nodes in a resource pool.</p>
<pre class="screen" id="EN-US_TOPIC_0000001910008036__screen1160912379575">GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/nodes
{ }</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008036__section1361110376574"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000001910008036__p261163735719"><strong id="EN-US_TOPIC_0000001910008036__b8612123716575">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000001910008036__p361263775716">OK</p>
<pre class="screen" id="EN-US_TOPIC_0000001910008036__screen13617337115710">{
"kind" : "NodeList",
"apiVersion" : "v2",
"metadata" : { },
"items" : [ {
"kind" : "Node",
"apiVersion" : "v2",
"metadata" : {
"name" : "os-node-created-zlncn",
"creationTimestamp" : "2022-09-16T05:32:44Z"
},
"spec" : {
"flavor" : "modelarts.vm.cpu.4ud"
},
"status" : {
"phase" : "Available",
"az" : "cn-xxxxx-7c",
"privateIp" : "192.168.0.1",
"resources" : {
"cpu" : "3920m",
"memory" : "6270Mi"
},
"availableResources" : {
"cpu" : "2970m",
"memory" : "4558Mi"
}
}
}, {
"kind" : "Node",
"apiVersion" : "v2",
"metadata" : {
"name" : "os-node-created-4s522",
"creationTimestamp" : "2022-09-16T03:20:53Z"
},
"spec" : {
"flavor" : "modelarts.vm.cpu.4ud"
},
"status" : {
"phase" : "Available",
"az" : "cn-xxxxx-7c",
"privateIp" : "192.168.0.2",
"resources" : {
"cpu" : "3920m",
"memory" : "6270Mi"
},
"availableResources" : {
"cpu" : "2970m",
"memory" : "4558Mi"
}
}
}, {
"kind" : "Node",
"apiVersion" : "v2",
"metadata" : {
"name" : "os-node-created-v7hfj",
"creationTimestamp" : "2022-09-16T09:16:37Z"
},
"spec" : {
"flavor" : "modelarts.vm.cpu.4ud"
},
"status" : {
"phase" : "Available",
"az" : "cn-xxxxx-7c",
"privateIp" : "192.168.0.3",
"resources" : {
"cpu" : "3920m",
"memory" : "6270Mi"
},
"availableResources" : {
"cpu" : "3720m",
"memory" : "5670Mi"
}
}
} ]
}</pre>
<p id="EN-US_TOPIC_0000001910008036__p596312398575"><strong id="EN-US_TOPIC_0000001910008036__b15964143935718">Status code: 404</strong></p>
<p id="EN-US_TOPIC_0000001910008036__p15964173913577">Not found.</p>
<pre class="screen" id="EN-US_TOPIC_0000001910008036__screen896423912579">{
"error_code" : "ModelArts.50015001",
"error_msg" : "pool not found"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008036__section189651939155718"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001910008036__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001910008036__row1964819378571"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000001910008036__p18965153915713">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_0000001910008036__p13966123935716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001910008036__row1464818372575"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001910008036__p1396673918578">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001910008036__p12966739135719">OK</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001910008036__row964843795716"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001910008036__p1396653914579">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001910008036__p119671639165711">Not found.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001910008036__section1596713399579"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000001910008036__p179676395574">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="topic_300000007.html">Node management</a></div>
</div>
</div>
View Git Blame Copy Permalink