forked from docs/doc-exports
126 lines
9.5 KiB
HTML
126 lines
9.5 KiB
HTML
<a name="elb_zq_bm_0003"></a><a name="elb_zq_bm_0003"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details of a Whitelist</h1>
|
|
<h4 class="sectiontitle">Function</h4><p class="msonormal" id="elb_zq_bm_0003__en-us_topic_0143878051_p47904522">This API is used to query details about a whitelist using its ID.</p>
|
|
|
|
<h4 class="sectiontitle">URI</h4><p class="msonormal" id="elb_zq_bm_0003__en-us_topic_0143878051_p55061034">GET /v2.0/lbaas/whitelists/{whitelist_id}</p>
|
|
|
|
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_bm_0003__en-us_topic_0143878051_table25787259" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="elb_zq_bm_0003__en-us_topic_0143878051_row48433782"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.2.3.2.5.1.1"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p30822233">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.121212121212121%" id="mcps1.3.2.3.2.5.1.2"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p13572982">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.2.3.2.5.1.3"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p25669747">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.515151515151516%" id="mcps1.3.2.3.2.5.1.4"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p65983608">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_zq_bm_0003__en-us_topic_0143878051_row43072046"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.5.1.1 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p66283708">whitelist_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.2.3.2.5.1.2 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p271307">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.2.3.2.5.1.3 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p21975939">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.2.3.2.5.1.4 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p35220619">Specifies the whitelist ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<h4 class="sectiontitle">Request</h4><p id="elb_zq_bm_0003__en-us_topic_0143878051_p43486789">None</p>
|
|
|
|
<h4 class="sectiontitle">Response</h4>
|
|
<table cellpadding="4" cellspacing="0" summary="" id="elb_zq_bm_0003__en-us_topic_0143878051_table47760062" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="elb_zq_bm_0003__en-us_topic_0143878051_row15270149"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.2.4.1.1"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p28922579">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.2.4.1.2"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p61027537">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63%" id="mcps1.3.4.2.2.4.1.3"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p44283431">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_zq_bm_0003__en-us_topic_0143878051_row30188158"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.2.4.1.1 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p29321725">whitelist</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.4.1.2 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p26249549">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.2.2.4.1.3 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p45838742">Specifies the whitelist. For details, see <a href="#elb_zq_bm_0003__en-us_topic_0143878051_table21950591">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a name="elb_zq_bm_0003__en-us_topic_0143878051_table21950591"></a><a name="en-us_topic_0143878051_table21950591"></a><table cellpadding="4" cellspacing="0" summary="" id="elb_zq_bm_0003__en-us_topic_0143878051_table21950591" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="elb_zq_bm_0003__en-us_topic_0143878051_b19767174972320">whitelist</strong> parameter description</caption><thead align="left"><tr id="elb_zq_bm_0003__en-us_topic_0143878051_row45839354"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.3.2.4.1.1"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p22000213">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_bm_0003__en-us_topic_0143878051_p37186841">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64%" id="mcps1.3.4.3.2.4.1.3"><p id="elb_zq_bm_0003__en-us_topic_0143878051_p59344108">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="elb_zq_bm_0003__en-us_topic_0143878051_row42143481"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p58178790">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p0581358125019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p62933377">Specifies the whitelist ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_bm_0003__en-us_topic_0143878051_row29529486"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p43078143">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_bm_0003__en-us_topic_0143878051_p66777590">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p40275672">Specifies the ID of the project where the forwarding rule is used.</p>
|
|
<p id="elb_zq_bm_0003__en-us_topic_0143878051_p1264211013318">The value contains a maximum of 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_bm_0003__en-us_topic_0143878051_row26936734"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p34391822">listener_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p83812145113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p24747384">Specifies the ID of the listener to which the whitelist is added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_bm_0003__en-us_topic_0143878051_row21399872"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p55668057">enable_whitelist</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p12818767">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p31687177">Specifies whether to enable access control.</p>
|
|
<p id="elb_zq_bm_0003__en-us_topic_0143878051_p07333135114"><strong id="elb_zq_bm_0003__en-us_topic_0143878051_b176871916576">true</strong>: Access control is enabled.</p>
|
|
<p id="elb_zq_bm_0003__en-us_topic_0143878051_p57393175115"><strong id="elb_zq_bm_0003__en-us_topic_0143878051_b1563012258534">false</strong>: Access control is disabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="elb_zq_bm_0003__en-us_topic_0143878051_row16749139"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.3.2.4.1.1 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p14503023">whitelist</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p33894211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.4.3.2.4.1.3 "><p id="elb_zq_bm_0003__en-us_topic_0143878051_p61076600">Specifies the IP addresses in the whitelist.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<h4 class="sectiontitle">Example Request</h4><ul id="elb_zq_bm_0003__en-us_topic_0143878051_ul17346134012225"><li id="elb_zq_bm_0003__en-us_topic_0143878051_li55836783">Example request: Querying details of a whitelist<pre class="screen" id="elb_zq_bm_0003__en-us_topic_0143878051_screen32769006">GET https://{Endpoint}/v2.0/lbaas/whitelists/09e64049-2ab0-4763-a8c5-f4207875dc3e</pre>
|
|
</li></ul>
|
|
|
|
<h4 class="sectiontitle">Example Response</h4><ul id="elb_zq_bm_0003__en-us_topic_0143878051_ul11933783411"><li id="elb_zq_bm_0003__en-us_topic_0143878051_li619314716345">Example response<pre class="screen" id="elb_zq_bm_0003__en-us_topic_0143878051_screen141934710349">{
|
|
"whitelist": {
|
|
"id": "eabfefa3fd1740a88a47ad98e132d238",
|
|
"listener_id": "eabfefa3fd1740a88a47ad98e132d238",
|
|
"tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
|
|
"enable_whitelist": true,
|
|
"whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
|
|
<h4 class="sectiontitle">Status Code</h4><p class="msonormal" id="elb_zq_bm_0003__en-us_topic_0143878051_p59786848">For details, see <a href="elb_gc_0002.html">HTTP Status Codes of Shared Load Balancers</a>.</p>
|
|
|
|
|
|
|
|
|
|
<strong>Parent topic:</strong> <a href="elb_zq_bm_0000.html">Whitelist</a>
|
|
|
|
|
|
|