doc-exports/docs/mrs/api-ref/mrs_02_0057.html
Yang, Tong f1bf1560d6 MRS API Doc 20240802 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>
2024-09-28 19:01:52 +00:00

298 lines
17 KiB
HTML

<a name="mrs_02_0057"></a><a name="mrs_02_0057"></a>
<h1 class="topictitle1">Querying a Host List</h1>
<div id="body1518426263242"><div class="section" id="mrs_02_0057__section389618791731"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0057__p75459541771">This API is used to query a host list of a specified cluster.</p>
</div>
<div class="section" id="mrs_02_0057__section3064850017952"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0057__ul1939595517957"><li id="mrs_02_0057__li3625219217957">Format<p id="mrs_02_0057__p2640899717716"><a name="mrs_02_0057__li3625219217957"></a><a name="li3625219217957"></a>GET /v1.1/{project_id}/clusters/{cluster_id}/hosts</p>
</li><li id="mrs_02_0057__li251218317103">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0057__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0057__row33700024194754"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0057__p16571835194812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0057__p141410194812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0057__p11454278194812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0057__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0057__p3492262515356">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0057__p1016041415356">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0057__p1768719515356">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="mrs_02_0057__row37407495194754"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0057__p56702435194812">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0057__p29494508194812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0057__p40820562194812">Cluster ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="mrs_02_0057__section27807627171231"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0057__table32644073161516" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter description</caption><thead align="left"><tr id="mrs_02_0057__row43445380161516"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.2.5.1.1"><p id="mrs_02_0057__p29414883161516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.2"><p id="mrs_02_0057__p33795347161516">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.3"><p id="mrs_02_0057__p7484174311367">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.2.2.5.1.4"><p id="mrs_02_0057__p53068604161516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0057__row27166366161516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0057__p52992019161516">pageSize</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0057__p64495161161516">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0057__p6484174315368">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0057__p56725559161516">Maximum number of clusters displayed on a page</p>
<p id="mrs_02_0057__p40767991161516">Value range: [1-2147483646]. The default value is <strong id="mrs_02_0057__b159151136204914">10</strong>.</p>
</td>
</tr>
<tr id="mrs_02_0057__row31367606161516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0057__p57748190161516">currentPage</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0057__p47091798161516">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0057__p34851043113614">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0057__p56339270161516">Current page number The default value is <strong id="mrs_02_0057__b84235270615612">1</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="mrs_02_0057__section6047763217644"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0057__table62954996104116" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0057__row50672710104116"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0057__p10848813104116"><strong id="mrs_02_0057__b1877515381938">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.2"><p id="mrs_02_0057__p43671186104116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.4.1.3"><p id="mrs_02_0057__p47705183104116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0057__row38914633104116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0057__p47671482104141">total</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0057__p45292505104141">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0057__p44814299104141">Total number of hosts in a list</p>
</td>
</tr>
<tr id="mrs_02_0057__row19491349104116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0057__p16863286104133">hosts</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0057__p54145644104133">Array</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0057__p159111050153212">Host parameters</p>
<p id="mrs_02_0057__p50701308104133">For details, see <a href="#mrs_02_0057__table21026630171650">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="mrs_02_0057__table21026630171650"></a><a name="table21026630171650"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0057__table21026630171650" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="mrs_02_0057__b1957204617512">Hosts</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0057__row25475785171650"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.2.4.1.1"><p id="mrs_02_0057__p31080335171739"><strong id="mrs_02_0057__b15444141017516">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.2.4.1.2"><p id="mrs_02_0057__p41349730171739">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.4.1.3"><p id="mrs_02_0057__p60993867171739">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0057__row64164652171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p29954363171650">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p35827707171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p16363131171650">VM ID</p>
</td>
</tr>
<tr id="mrs_02_0057__row13050456171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p50454016171650">ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p47886046171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p53564516171650">VM IP address</p>
</td>
</tr>
<tr id="mrs_02_0057__row12318597171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p58282272171650">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p3683120171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p29897333171650">VM flavor ID</p>
</td>
</tr>
<tr id="mrs_02_0057__row640547171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p51884380171650">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p37262675171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p1112113610339">VM type</p>
<p id="mrs_02_0057__p65486689171650">Currently, MasterNode, CoreNode, and TaskNode are supported.</p>
</td>
</tr>
<tr id="mrs_02_0057__row52509293171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p25394365171650">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p48232943171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p14554272171650">VM name</p>
</td>
</tr>
<tr id="mrs_02_0057__row63879587171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p6864084171650">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p5213748171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p19660467171650">Current VM state</p>
</td>
</tr>
<tr id="mrs_02_0057__row42726478171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p38292731171650">mem</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p50132509171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p34201443171650">Memory</p>
</td>
</tr>
<tr id="mrs_02_0057__row39377536171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p35463825171650">cpu</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p11730090171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p10613249171650">Number of CPU cores</p>
</td>
</tr>
<tr id="mrs_02_0057__row28410384171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p19539777171650">root_volume_size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p22550052171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p14614951171650">OS disk capacity</p>
</td>
</tr>
<tr id="mrs_02_0057__row64425697171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p51098939171650">data_volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p51364957171650">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p66920820171650">Data disk type</p>
</td>
</tr>
<tr id="mrs_02_0057__row65416474171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p64243064171650">data_volume_size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p55078124171650">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p32143059171650">Data disk capacity</p>
</td>
</tr>
<tr id="mrs_02_0057__row20852078171650"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.1 "><p id="mrs_02_0057__p11296761171650">data_volume_count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.2 "><p id="mrs_02_0057__p29864308171650">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.4.1.3 "><p id="mrs_02_0057__p3089844171650">Number of data disks</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="mrs_02_0057__section107789113217"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0057__ul82831535112112"><li id="mrs_02_0057__li811118379213">Example request<p id="mrs_02_0057__p196602053162113"><a name="mrs_02_0057__li811118379213"></a><a name="li811118379213"></a>None</p>
</li><li id="mrs_02_0057__li6283163582113">Example response<pre class="screen" id="mrs_02_0057__screen658083651798">{
"total": 5,
"hosts": [
{
"id": "063d1d47-ae91-4a48-840c-b3cfe4efbcf0",
"name": "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_IQhiC",
"ip": "192.168.0.169",
"status": "ACTIVE",
"flavor": "c6.4xlarge.4linux.mrs",
"type": "Core",
"mem": "16384",
"cpu": "8",
"root_volume_size": "40",
"data_volume_type": "SATA",
"data_volume_size": 100,
"data_volume_count": 1
},
{
"id": "dc5c6208-faa2-4727-a65a-2b1ce235d350",
"name": "a78e161c-d14f-4b68-8c2d-0219920ce844_node_master1_ASzkl",
"ip": "192.168.0.156",
"status": "ACTIVE",
"flavor": "c2.4xlarge.linux.mrs",
"type": "Master",
"mem": "32768",
"cpu": "16",
"root_volume_size": "40",
"data_volume_type": "SATA",
"data_volume_size": 100,
"data_volume_count": 1
},
{
"id": "c0ce793d-848b-448a-835b-ea0cac534b09",
"name": "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_ANnRN",
"ip": "192.168.0.243",
"status": "ACTIVE",
"flavor": "c6.4xlarge.4linux.mrs",
"type": "Core",
"mem": "16384",
"cpu": "8",
"root_volume_size": "40",
"data_volume_type": "SATA",
"data_volume_size": 100,
"data_volume_count": 1
},
{
"id": "95c23e43-ef6e-4732-b6ed-a5f1c7779fae",
"name": "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_uRRiA",
"ip": "192.168.0.126",
"status": "ACTIVE",
"flavor": "c6.4xlarge.4linux.mrs",
"type": "Core",
"mem": "16384",
"cpu": "8",
"root_volume_size": "40",
"data_volume_type": "SATA",
"data_volume_size": 100,
"data_volume_count": 1
},
{
"id": "63bdbf75-1133-4a94-8c27-1fa12c8b9e70",
"name": "a78e161c-d14f-4b68-8c2d-0219920ce844_node_master2_StqFu",
"ip": "192.168.0.22",
"status": "ACTIVE",
"flavor": "c2.4xlarge.linux.mrs",
"type": "Master",
"mem": "32768",
"cpu": "16",
"root_volume_size": "40",
"data_volume_type": "SATA",
"data_volume_size": 100,
"data_volume_count": 1
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="mrs_02_0057__section31921280171927"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0057__p48149648171927"><a href="#mrs_02_0057__table33682380171927">Table 5</a> describes the status code of this API.</p>
<div class="tablenoborder"><a name="mrs_02_0057__table33682380171927"></a><a name="table33682380171927"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0057__table33682380171927" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="mrs_02_0057__row56379034171927"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="mrs_02_0057__p28423228171927">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="mrs_02_0057__p20580145171927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0057__row35948064171927"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="mrs_02_0057__p3299040171927">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="mrs_02_0057__p65895658171927">The host list information has been successfully queried.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="mrs_02_0057__p3132993710328">For the description about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
<p id="mrs_02_0057__p14474703171927"></p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0027.html">Cluster management APIs (V1)</a></div>
</div>
</div>