forked from docs/doc-exports
178 lines
18 KiB
HTML
178 lines
18 KiB
HTML
<a name="elb_zq_hd_0003"></a><a name="elb_zq_hd_0003"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details of a Backend Server</h1>
|
|
<h4 class="sectiontitle">Function</h4><p id="elb_zq_hd_0003__en-us_topic_0096561555_p44897614341">This API is used to query details about a backend server.</p>
|
|
|
|
<h4 class="sectiontitle">URI</h4><p id="elb_zq_hd_0003__en-us_topic_0096561555_p7171183923718">GET /v2.0/lbaas/pools/{pool_id}/members/{member_id}</p>
|
|
|
|
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hd_0003__en-us_topic_0096561555_table1498425144" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="elb_zq_hd_0003__en-us_topic_0096561555_row1044204241416"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.1"><p id="elb_zq_hd_0003__en-us_topic_0096561555_p174464221419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.5.1.2"><p id="elb_zq_hd_0003__en-us_topic_0096561555_p444124218140">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.5.1.3"><p id="elb_zq_hd_0003__en-us_topic_0096561555_p1644144231415">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.2.3.2.5.1.4"><p id="elb_zq_hd_0003__en-us_topic_0096561555_p644154211142"><strong id="elb_zq_hd_0003__en-us_topic_0096561555_b84235270681620">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_zq_hd_0003__en-us_topic_0096561555_row134684241415"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_p1846742161412">pool_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_p1694481915147">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_p172911640205310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.3.2.5.1.4 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_p16462042161417">Specifies the ID of the backend server group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_row184611422148"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_p19468428144">member_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_p298351716532">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_p6222842195313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.3.2.5.1.4 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_p946142141419">Specifies the backend server ID.</p>
|
|
<span class="notetitle"> NOTE: </span><ul id="elb_zq_hd_0003__en-us_topic_0096561555_ul1345681012434"><li id="elb_zq_hd_0003__en-us_topic_0096561555_li14456151018436">The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.</li><li id="elb_zq_hd_0003__en-us_topic_0096561555_li44567107434">You can obtain this value by calling the API described in <a href="elb_zq_hd_0002.html#elb_zq_hd_0002">Querying Backend Servers</a>.</li></ul>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<h4 class="sectiontitle">Request</h4><p id="elb_zq_hd_0003__en-us_topic_0096561555_p497221816205">None</p>
|
|
|
|
<h4 class="sectiontitle">Response</h4>
|
|
<a name="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_table63335993"></a><a name="en-us_topic_0096561555_en-us_topic_0049139656_table63335993"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_table63335993" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_row52988976"><th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.4.2.2.4.1.1"><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_p64248638">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.61%" id="mcps1.3.4.2.2.4.1.2"><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_p36757156">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.22%" id="mcps1.3.4.2.2.4.1.3"><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_p41555354">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_row10540538"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.4.2.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_p48477267">member</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.4.2.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_p34344524">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.4.2.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_p49965631">Lists the backend servers. For details, see <a href="#elb_zq_hd_0003__en-us_topic_0096561555_table1080991113150">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a name="elb_zq_hd_0003__en-us_topic_0096561555_table1080991113150"></a><a name="en-us_topic_0096561555_table1080991113150"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hd_0003__en-us_topic_0096561555_table1080991113150" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b1987790351">member</strong> parameter description</caption><thead align="left"><tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row1215463171615"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.3.2.4.1.1"><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p1315410319169">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.3.2.4.1.2"><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p141541431101611">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="72%" id="mcps1.3.4.3.2.4.1.3"><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p2154153161615">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row161541231151616"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p71549319164">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p937416199308">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p6154231141610">Specifies the backend server ID.</p>
|
|
<span class="notetitle"> NOTE: </span><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p7954937184520">The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that has already associated with the load balancer.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row8154123119164"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p2015420313169">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p131565312169">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p201561631141618">Specifies the ID of the project where the backend server is used.</p>
|
|
<p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p4289054517">The value contains a maximum of 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row41561731101617"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p2015683161617">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p915643117163">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p13156193151618">Specifies the backend server name.</p>
|
|
<p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p126641735112">The value contains a maximum of 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row12156113141613"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p215633112161">address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p61561331181617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p2611194017408">Specifies the private IP address of the backend server. This IP address must be in the subnet specified by <strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b17159113041919">subnet_id</strong>.</p>
|
|
<p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p18611164024019">This parameter can be set only to the IP address of the primary NIC, for example, 192.168.3.11.</p>
|
|
<p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p1314571145112">The value contains a maximum of 64 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row121562031101617"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p1115653101620">protocol_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p111561631171619">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p141561431161615">Specifies the port used by the backend server. The port number ranges from 1 to 65535.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row111561931111610"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p171561231151617">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p1577372523116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p986015317414">Specifies the ID of the subnet where the backend server works. The private IP address of the backend server is in this subnet.</p>
|
|
<p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p88604374112">IPv6 subnets are not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row111561331101617"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p19156231141611">admin_state_up</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p1915603181610">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p38145286413">Specifies the administrative status of the backend server.</p>
|
|
<p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p124391238151518">This parameter is reserved. The value can be <strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_en-us_topic_0141008273_b165949352520">true</strong> or <strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_en-us_topic_0141008273_b76047354513">false</strong>.</p>
|
|
<ul id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_ul34394383151"><li id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_en-us_topic_0141008273_li1786915015393"><strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_en-us_topic_0141008273_b1178053714514">true</strong>: Enabled</li><li id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_en-us_topic_0141008273_li1031815323916"><strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_en-us_topic_0141008273_b1524614510615">false</strong>: Disabled</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row8156193116164"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p171561931151617">weight</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p4156103110161">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p8605175104117">Specifies the backend server weight. The value ranges from <strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b736895210190">0</strong> to <strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b10369135211196">100</strong>.</p>
|
|
<p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p1460555119418">If the value is <strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b142577543194">0</strong>, the backend server will not accept new requests. The default value is <strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b7720155541911">1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_row7156631161615"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p31561031161610">operating_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p715663171614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_p13931747122017">Specifies the health check result of the backend server. The value can be one of the following:</p>
|
|
<ul id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_ul182681814182112"><li id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_li11268191418212"><strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b237573620916">ONLINE</strong>: The backend server is running normally.</li><li id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_li12681214132115"><strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b103891719105114">NO_MONITOR</strong>: No health check is configured for the backend server group that the backend server belongs to.</li><li id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_li3268191412116"><strong id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561556_b976682611106">OFFLINE</strong>: The cloud server used as the backend server is stopped or does not exist.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<h4 class="sectiontitle">Example Request</h4><ul id="elb_zq_hd_0003__en-us_topic_0096561555_ul950141372013"><li id="elb_zq_hd_0003__en-us_topic_0096561555_li0501313182019">Example request: Querying details of a backend server<pre class="screen" id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0049139656_screen20684297">GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members/cf024846-7516-4e3a-b0fb-6590322c836f</pre>
|
|
</li></ul>
|
|
|
|
<h4 class="sectiontitle">Example Response</h4><ul id="elb_zq_hd_0003__en-us_topic_0096561555_ul2789344121816"><li id="elb_zq_hd_0003__en-us_topic_0096561555_li1978914443189">Example response<pre class="screen" id="elb_zq_hd_0003__en-us_topic_0096561555_screen078918448189">{
|
|
"member": {
|
|
"name": "",
|
|
"weight": 1,
|
|
"admin_state_up": true,
|
|
"subnet_id": "823d5866-6e30-45c2-9b1a-a1ebc3757fdb",
|
|
"tenant_id": "145483a5107745e9b3d80f956713e6a3",
|
|
|
|
"address": "192.172.3.100",
|
|
"protocol_port": 8080,
|
|
"operating_status": "ONLINE",
|
|
"id": "e58f5bfa-0e46-4bc5-951c-8473d3e5f24a"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
|
|
<h4 class="sectiontitle">Status Code</h4><p id="elb_zq_hd_0003__en-us_topic_0096561555_en-us_topic_0096561531_en-us_topic_0049139631_p12358762">For details, see <a href="elb_gc_1102.html#elb_gc_1102">Status Codes</a>.</p>
|
|
|
|
|
|
|
|
|
|
<strong>Parent topic:</strong> <a href="elb_zq_hd_0000.html">Backend Server</a>
|
|
|
|
|
|
|