vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/elb/api-ref/elb_zq_hd_0001.html

326 lines
29 KiB
HTML
Raw Blame History

<a name="elb_zq_hd_0001"></a><a name="elb_zq_hd_0001"></a>
<h1 class="topictitle1">Adding a Backend Server</h1>
<h4 class="sectiontitle">Function</h4><p id="elb_zq_hd_0001__en-us_topic_0096561556_p11327175714319">This API is used to add a backend server to a specific backend server group. After a backend server group is added to a listener, traffic is distributed to backend servers in this server group using the specified load balancing algorithm.</p>
<h4 class="sectiontitle">Constraints</h4><p id="elb_zq_hd_0001__en-us_topic_0096561556_p14264935173011">Two backend servers in a backend server group cannot have the same private IP address or port number.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p23002374305">The subnet specified during server creation must be in the same VPC as the subnet from which the private IP address of the load balancer is assigned.</p>
<h4 class="sectiontitle">URI</h4><p id="elb_zq_hd_0001__en-us_topic_0096561556_p132381410204016">POST /v2.0/lbaas/pools/{pool_id}/members</p>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hd_0001__en-us_topic_0096561556_table1853663311511" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="elb_zq_hd_0001__en-us_topic_0096561556_row17575233151512"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.3.2.5.1.1"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p145751333181512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.3.3.2.5.1.2"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p45284312273">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.3.2.5.1.3"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p8575933191519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.3.3.2.5.1.4"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p7575433161518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hd_0001__en-us_topic_0096561556_row4575183319152"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p4575433161515">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.3.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p457623311517">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1957613311515">String</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.3.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p957653301520">Specifies the ID of the backend server group.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Request</h4>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_table20060988" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_row42045429"><th align="left" class="cellrowborder" valign="top" width="21.397860213978607%" id="mcps1.3.4.2.2.5.1.1"><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p50236607">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.69763023697631%" id="mcps1.3.4.2.2.5.1.2"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1165111299278">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.048795120487954%" id="mcps1.3.4.2.2.5.1.3"><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p42633357">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.85571442855715%" id="mcps1.3.4.2.2.5.1.4"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p872854182812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_row20823715"><td class="cellrowborder" valign="top" width="21.397860213978607%" headers="mcps1.3.4.2.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p8999315">member</p>
</td>
<td class="cellrowborder" valign="top" width="23.69763023697631%" headers="mcps1.3.4.2.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p867665092712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.048795120487954%" headers="mcps1.3.4.2.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p55815296">Object</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855715%" headers="mcps1.3.4.2.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p24745166">Specifies the backend server. For details, see <a href="#elb_zq_hd_0001__en-us_topic_0096561556_table1686816641616">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
<a name="elb_zq_hd_0001__en-us_topic_0096561556_table1686816641616"></a><a name="en-us_topic_0096561556_table1686816641616"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hd_0001__en-us_topic_0096561556_table1686816641616" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="elb_zq_hd_0001__en-us_topic_0096561556_b19767174972320">member</strong> parameter description</caption><thead align="left"><tr id="elb_zq_hd_0001__en-us_topic_0096561556_row1248177161610"><th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.3.2.5.1.1"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p134810712160">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.3.2.5.1.2"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p54816721618">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.3.2.5.1.3"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p24817761618">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.5.1.4"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p16486771617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hd_0001__en-us_topic_0096561556_row648147111617"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139654_p691901312412">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p10490713160">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1548178167">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p14191130133014">Specifies the ID of the project where the backend server is used.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p8222164914610"></p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p1649137101619">The value must be the same as the value of <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b31354117540">project_id</strong> in the token.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p1264211013318">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row17492716167"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p3494771611">name</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p10491674163">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p11492771610">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1549137131615">Specifies the backend server name. The value is an empty character string by default.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p9157446165019">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row2499741612"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1749107141620">address</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p134916717160">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p12494731617">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p121434772311">Specifies the private IP address of the backend server. This IP address must be in the subnet specified by <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b3212124818188">subnet_id</strong>.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p31969789144950">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_0001__en-us_topic_0096561556_p127189485507">The value contains a maximum of 64 characters.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row124997171613"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p04927111617">protocol_port</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p7491579161">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p3491073166">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p174915731618">Specifies the port used by the backend server. The port number ranges from 1 to 65535.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row3494713167"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p24910716162">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p104918701610">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p158985942913">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p3542138124217">Specifies the ID of the subnet where the backend server works.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p27021957153415">The private IP address of the backend server is in this subnet.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p317019213435">Only IPv4 subnets are supported.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row34912710165"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1649679163">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p10498712165">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p114910781618">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1558456113514">Specifies the administrative status of the backend server.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p136141610163013">This parameter is reserved, and the default value is <strong id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0141008273_b7386530455">true</strong>.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row10492076165"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p15494741610">weight</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.3.2.5.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p8498791613">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1849197101610">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.5.1.4 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p93020435366">Specifies the backend server weight. The value ranges from <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b18125124111810">0</strong> to <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b0469161061813">100</strong>.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p72901421173616">If the value is <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b7373131251815">0</strong>, the backend server will not accept new requests. The default value is <strong>1</strong>.</p>
</td>
</tr>
</tbody>
</table>
<h4 class="sectiontitle">Response</h4>
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_table54050919" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_row57900534"><th align="left" class="cellrowborder" valign="top" width="23.169999999999998%" id="mcps1.3.5.2.2.4.1.1"><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p59431671">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.61%" id="mcps1.3.5.2.2.4.1.2"><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p49236012">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.22%" id="mcps1.3.5.2.2.4.1.3"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p11701040112915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_row21061526"><td class="cellrowborder" valign="top" width="23.169999999999998%" headers="mcps1.3.5.2.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p28262061">member</p>
</td>
<td class="cellrowborder" valign="top" width="25.61%" headers="mcps1.3.5.2.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p7525633">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.22%" headers="mcps1.3.5.2.2.4.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_p50666366">Specifies the backend server. For details, see <a href="#elb_zq_hd_0001__en-us_topic_0096561556_table1096713051618">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
<a name="elb_zq_hd_0001__en-us_topic_0096561556_table1096713051618"></a><a name="en-us_topic_0096561556_table1096713051618"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_hd_0001__en-us_topic_0096561556_table1096713051618" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="elb_zq_hd_0001__en-us_topic_0096561556_b1987790351">member</strong> parameter description</caption><thead align="left"><tr id="elb_zq_hd_0001__en-us_topic_0096561556_row1215463171615"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.5.3.2.4.1.1"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1315410319169">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.5.3.2.4.1.2"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p141541431101611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="72%" id="mcps1.3.5.3.2.4.1.3"><p id="elb_zq_hd_0001__en-us_topic_0096561556_p2154153161615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="elb_zq_hd_0001__en-us_topic_0096561556_row161541231151616"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p71549319164">id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p937416199308">String</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p6154231141610">Specifies the backend server ID.</p>
<span class="notetitle"> NOTE: </span><p id="elb_zq_hd_0001__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_0001__en-us_topic_0096561556_row8154123119164"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p2015420313169">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p131565312169">String</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p201561631141618">Specifies the ID of the project where the backend server is used.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p4289054517">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row41561731101617"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p2015683161617">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p915643117163">String</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p13156193151618">Specifies the backend server name.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p126641735112">The value contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row12156113141613"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p215633112161">address</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p61561331181617">String</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__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_0001__en-us_topic_0096561556_b17159113041919">subnet_id</strong>.</p>
<p id="elb_zq_hd_0001__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_0001__en-us_topic_0096561556_p1314571145112">The value contains a maximum of 64 characters.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row121562031101617"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1115653101620">protocol_port</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p111561631171619">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__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_0001__en-us_topic_0096561556_row111561931111610"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p171561231151617">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1577372523116">String</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__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_0001__en-us_topic_0096561556_p88604374112">IPv6 subnets are not supported.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row111561331101617"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p19156231141611">admin_state_up</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p1915603181610">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p38145286413">Specifies the administrative status of the backend server.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p124391238151518">This parameter is reserved. The value can be <strong id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0141008273_b165949352520">true</strong> or <strong id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0141008273_b76047354513">false</strong>.</p>
<ul id="elb_zq_hd_0001__en-us_topic_0096561556_ul34394383151"><li id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0141008273_li1786915015393"><strong id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0141008273_b1178053714514">true</strong>: Enabled</li><li id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0141008273_li1031815323916"><strong id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0141008273_b1524614510615">false</strong>: Disabled</li></ul>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row8156193116164"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p171561931151617">weight</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p4156103110161">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p8605175104117">Specifies the backend server weight. The value ranges from <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b736895210190">0</strong> to <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b10369135211196">100</strong>.</p>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p1460555119418">If the value is <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b142577543194">0</strong>, the backend server will not accept new requests. The default value is <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b7720155541911">1</strong>.</p>
</td>
</tr>
<tr id="elb_zq_hd_0001__en-us_topic_0096561556_row7156631161615"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.1 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p31561031161610">operating_status</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="elb_zq_hd_0001__en-us_topic_0096561556_p715663171614">String</p>
</td>
<td class="cellrowborder" valign="top" width="72%" headers="mcps1.3.5.3.2.4.1.3 "><p id="elb_zq_hd_0001__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_0001__en-us_topic_0096561556_ul182681814182112"><li id="elb_zq_hd_0001__en-us_topic_0096561556_li11268191418212"><strong id="elb_zq_hd_0001__en-us_topic_0096561556_b237573620916">ONLINE</strong>: The backend server is running normally.</li><li id="elb_zq_hd_0001__en-us_topic_0096561556_li12681214132115"><strong id="elb_zq_hd_0001__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_0001__en-us_topic_0096561556_li3268191412116"><strong id="elb_zq_hd_0001__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_0001__en-us_topic_0096561556_ul17633516553"><li id="elb_zq_hd_0001__en-us_topic_0096561556_li1069222685516"><a name="elb_zq_hd_0001__en-us_topic_0096561556_li1069222685516"></a><a name="en-us_topic_0096561556_li1069222685516"></a>Step 1: Query the subnet ID and IP address using the server ID. <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b1299543719342">device_id</strong> in the request indicates the server ID. Obtain the values of <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b131181523133510">subnet_id</strong> and <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b18903202617355">ip_address</strong> of the primary NIC (the port for which <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b794684511454">primary_interface</strong> is <strong id="elb_zq_hd_0001__en-us_topic_0096561556_b149499498453">true</strong>) in the response body.<pre class="screen" id="elb_zq_hd_0001__en-us_topic_0096561556_screen752232315719">GET https://{VPCEndpoint}/v2.0/ports?device_id=f738c464-b5c2-45df-86c0-7f436620cd54</pre>
<p id="elb_zq_hd_0001__en-us_topic_0096561556_p1081848145911">Example response</p>
<pre class="screen" id="elb_zq_hd_0001__en-us_topic_0096561556_screen1535111584591">{
"ports": [
{
"id": "94971c39-46f0-443a-85e8-31cb7497c78e",
"name": "",
"status": "ACTIVE",
"admin_state_up": true,
"fixed_ips": [
{
<strong id="elb_zq_hd_0001__en-us_topic_0096561556_b42007114119">"subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503"</strong>,
<strong id="elb_zq_hd_0001__en-us_topic_0096561556_b55369143119">"ip_address": "192.168.44.11"</strong>
}
],
"mac_address": "fa:16:3e:5c:d2:57",
"network_id": "1b76b9c2-9b7e-4ced-81bd-d13f7389d7c9",
"tenant_id": "04dd36f978800fe22f9bc00bea090736",
"project_id": "04dd36f978800fe22f9bc00bea090736",
"device_id": "f738c464-b5c2-45df-86c0-7f436620cd54",
"device_owner": "compute:xx-xxxx-4a",
"security_groups": [
"a10dfc31-0055-4b84-b36e-1291b918125c",
"7a233393-5be2-4dff-8360-1558dd950f6e"
],
"extra_dhcp_opts": [],
"allowed_address_pairs": [],
"binding:vnic_type": "normal",
"binding:vif_details": {
<strong id="elb_zq_hd_0001__en-us_topic_0096561556_b0410121629">"primary_interface": true</strong>
},
"binding:profile": {},
"port_security_enabled": true,
"created_at": "2019-11-12T17:17:51",
"updated_at": "2019-11-12T17:17:51"
}
]
}</pre>
</li><li id="elb_zq_hd_0001__en-us_topic_0096561556_li182501069261">Step 2: Use the subnet ID and IP address obtained in <a href="#elb_zq_hd_0001__en-us_topic_0096561556_li1069222685516">▪ Step 1</a> to add a backend server.<pre class="screen" id="elb_zq_hd_0001__en-us_topic_0096561556_en-us_topic_0049139657_screen49278634124617">POST https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members
{
"member": {
"subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503",
"protocol_port": 88,
"name": "member-jy-tt-1",
"address": "192.168.44.11"
}
}</pre>
</li></ul>
<h4 class="sectiontitle">Example Response</h4><ul id="elb_zq_hd_0001__en-us_topic_0096561556_ul866439105419"><li id="elb_zq_hd_0001__en-us_topic_0096561556_li766519965412">Example response<pre class="screen" id="elb_zq_hd_0001__en-us_topic_0096561556_screen266514911543">{
"member": {
"name": "member-jy-tt-1",
"weight": 1,
"admin_state_up": true,
"subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503",
"tenant_id": "145483a5107745e9b3d80f956713e6a3",
"address": "192.168.44.11",
"protocol_port": 88,
"operating_status": "ONLINE",
"id": "c0042496-e220-44f6-914b-e6ca33bab503"
}
}</pre>
</li></ul>
<h4 class="sectiontitle">Status Code</h4><p id="elb_zq_hd_0001__en-us_topic_0096561556_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>
View Git Blame Copy Permalink