forked from docs/doc-exports
Li, Qiao
914011d51b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
198 lines
15 KiB
HTML
198 lines
15 KiB
HTML
<a name="waf_02_0017"></a><a name="waf_02_0017"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Source IP Header</h1>
|
|
<div id="body1547540588547"><div class="section" id="waf_02_0017__section2348991"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0017__p37482227">This API is used to query the source IP header.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0017__section21140920"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0017__ul16161510"><li id="waf_02_0017__li11235870">URI format<p id="waf_02_0017__p34013971"><a name="waf_02_0017__li11235870"></a><a name="li11235870"></a>GET /v1/{project_id}/waf/map/sipheader?lang={lang}</p>
|
|
</li><li id="waf_02_0017__li37690286">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0017__table3668256" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0017__row13281129"><th align="left" class="cellrowborder" valign="top" width="30.930000000000003%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0017__p2029696"><strong id="waf_02_0017__b85051959164116">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0017__p30187650"><strong id="waf_02_0017__b1179516094213">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.430000000000001%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0017__p29280601"><strong id="waf_02_0017__b1592841174214">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.02%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0017__p22918509"><strong id="waf_02_0017__b556162174217">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0017__row44459941"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0017__p44485482">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0017__p46554275">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0017__p12799929">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0017__p30161299">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0017__row3016237"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0017__p42988649">lang</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0017__p59528541">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0017__p57082546">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0017__p60283536">Specifies the language configuration. The options are <strong id="waf_02_0017__b10940161594515">zh-cn</strong> and <strong id="waf_02_0017__b1794031594515">en-us</strong>. The default value is <strong id="waf_02_0017__b4940181534510">en-us</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0017__section56050555"><h4 class="sectiontitle">Request</h4><p id="waf_02_0017__p137906108914">Request parameters</p>
|
|
<p class="msonormal" id="waf_02_0017__p51128222">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0017__section34692954"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0017__p125267214916">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0017__table42162795" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0017__row59545267"><th align="left" class="cellrowborder" valign="top" width="36.20637936206379%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0017__p58437292"><strong id="waf_02_0017__b1876425194216">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.997600239976002%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0017__p35800173"><strong id="waf_02_0017__b99351725194216">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0017__p14132895"><strong id="waf_02_0017__b2897126204217">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0017__row60087193"><td class="cellrowborder" valign="top" width="36.20637936206379%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0017__p35224503">sipheadermap</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.997600239976002%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0017__p229951334915"><a href="#waf_02_0017__table10363184164611">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0017__p52149544">Specifies the list of source IP headers.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0017__row66692715"><td class="cellrowborder" valign="top" width="36.20637936206379%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0017__p33400872">locale</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.997600239976002%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0017__p1865142714918"><a href="#waf_02_0017__table5644135016296">Table 4</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0017__p32682602">Specifies additional information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0017__table10363184164611"></a><a name="table10363184164611"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0017__table10363184164611" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="waf_02_0017__b3535102617318">sipheadermap</strong></caption><thead align="left"><tr id="waf_02_0017__row153652046460"><th align="left" class="cellrowborder" valign="top" width="36.236376362363764%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0017__p136610484618"><strong id="waf_02_0017__b18458605449">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.967603239676034%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0017__p1136784104617"><strong id="waf_02_0017__b280218154414">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0017__p43671345468"><strong id="waf_02_0017__b1859918216442">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0017__row1499039124610"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0017__p116411451194918">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0017__p19988142919502">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0017__p6159944612">Specifies the default HTTP request header to identify the real source IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0017__row999018918466"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0017__p111729124610">cloudflare</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0017__p17176918462">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0017__p91810920462">Specifies the HTTP request header used by Cloudflare to identify the real source IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0017__row99909994619"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0017__p15934118115010">akamai</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0017__p14211799464">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0017__p72219934613">Specifies the HTTP request header used by Akamai to identify the real source IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0017__row10786142191711"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0017__p27865426177">custom</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0017__p97861342161715">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0017__p578634271720">Specifies the custom HTTP request header to identify the real source IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0017__table5644135016296"></a><a name="table5644135016296"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0017__table5644135016296" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="waf_02_0017__b188481439133116">locale</strong></caption><thead align="left"><tr id="waf_02_0017__row06502503297"><th align="left" class="cellrowborder" valign="top" width="36.236376362363764%" id="mcps1.3.4.4.2.4.1.1"><p id="waf_02_0017__p465010506292"><strong id="waf_02_0017__b191201527605">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.967603239676034%" id="mcps1.3.4.4.2.4.1.2"><p id="waf_02_0017__p8652155032917"><strong id="waf_02_0017__b1141216121304">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.4.4.2.4.1.3"><p id="waf_02_0017__p18654350172918"><strong id="waf_02_0017__b376414245020">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0017__row206554501298"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0017__p20658175015297">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0017__p16658550162912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0017__p4661175011295">The value is <strong id="waf_02_0017__b1974928103416">Default</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0017__row10663185012295"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0017__p16663135018290">cloudflare</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0017__p196651350112919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0017__p666725010296">The value is <strong id="waf_02_0017__b15169154253416">CloudFlare</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0017__row1166716506298"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0017__p37409101321">akamai</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0017__p96731950152912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0017__p3675165020293">The value is <strong id="waf_02_0017__b3390163217147">Akamai</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0017__row967565014293"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0017__p1676155052920">custom</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0017__p36789507293">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0017__p067885015291">The value is <strong id="waf_02_0017__b2920184018354">Custom</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0017__section182891739095"><h4 class="sectiontitle">Example</h4><p id="waf_02_0017__p155331434164712"></p>
|
|
<div class="p" id="waf_02_0017__p167564311916">Response example<pre class="screen" id="waf_02_0017__screen638014398912">{
|
|
"sipheadermap": {
|
|
"default": ["X-Forwarded-For"],
|
|
"cloudflare": ["CF-Connecting-IP", "X-Forwarded-For"],
|
|
"akamai": ["True-Client-IP"],
|
|
"custom": []
|
|
},
|
|
"locale": {
|
|
"default": "Default",
|
|
"cloudflare": "CloudFlare",
|
|
"akamai": "Akamai",
|
|
"custom": "Custom"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0017__section43801132"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0017__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0017__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 5</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0017__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0017__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="waf_02_0017__waf_02_0012_r3d6e2f205c444705bdbb9daaac74e575"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.6.2.2.2.4.1.1"><p id="waf_02_0017__waf_02_0012_af3c4073076f24eca88d94e3fa1effdc6">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.41%" id="mcps1.3.6.2.2.2.4.1.2"><p id="waf_02_0017__waf_02_0012_en-us_topic_0144911667_p4531342288">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.589999999999996%" id="mcps1.3.6.2.2.2.4.1.3"><p id="waf_02_0017__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0017__waf_02_0012_rc7b2adc390904a1ba79e303017797786"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="waf_02_0017__waf_02_0012_a93f3895d44bb4226934cc626ac50e37b">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.41%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="waf_02_0017__waf_02_0012_en-us_topic_0144911667_p7538425819">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="waf_02_0017__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0017__waf_02_0012_en-us_topic_0144911667_p482819399522">For details about error status codes, see <a href="waf_02_0085.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="waf_02_0090.html">Obtaining Option Details</a></div>
|
|
</div>
|
|
</div>
|
|
|