doc-exports/docs/apig/api-ref/apig-api-20210402.html
Chen, Junjie c94ea402f5 APIG API 20230331 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2023-07-13 08:57:09 +00:00

442 lines
40 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="apig-api-20210402"></a><a name="apig-api-20210402"></a>
<h1 class="topictitle1">Supported Features</h1>
<div id="body8662426"><p id="apig-api-20210402__p207271902710">The following table lists the features that are supported by dedicated gateways.</p>
<div class="note" id="apig-api-20210402__en-us_topic_0281057028_note34931951184916"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-20210402__en-us_topic_0281057028_p1749305104912">If the gateway you use does not have specific features, contact technical support to upgrade your gateway.</p>
</div></div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="apig-api-20210402__en-us_topic_0281057028_table14286122810362" frame="border" border="1" rules="all"><thead align="left"><tr id="apig-api-20210402__en-us_topic_0281057028_row4284928143614"><th align="left" class="cellrowborder" valign="top" width="13.671367136713672%" id="mcps1.3.3.1.9.1.1"><p id="apig-api-20210402__en-us_topic_0281057028_p22865280366">Feature Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.471047104710472%" id="mcps1.3.3.1.9.1.2"><p id="apig-api-20210402__en-us_topic_0281057028_p1228717286367">Feature Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.071107110711074%" id="mcps1.3.3.1.9.1.3"><p id="apig-api-20210402__en-us_topic_0281057028_p1397344614456">Configurable</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.921292129212924%" id="mcps1.3.3.1.9.1.4"><p id="apig-api-20210402__en-us_topic_0281057028_p1828722863612">Feature Configuration Example</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.231223122312233%" id="mcps1.3.3.1.9.1.5"><p id="apig-api-20210402__en-us_topic_0281057028_p13287192803615">Configuration Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.271427142714272%" id="mcps1.3.3.1.9.1.6"><p id="apig-api-20210402__en-us_topic_0281057028_p1228911288367">Parameter Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.151215121512152%" id="mcps1.3.3.1.9.1.7"><p id="apig-api-20210402__en-us_topic_0281057028_p92891328203614">Default Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.211321132113213%" id="mcps1.3.3.1.9.1.8"><p id="apig-api-20210402__en-us_topic_0281057028_p529012284363">Value Range</p>
</th>
</tr>
</thead>
<tbody><tr id="apig-api-20210402__en-us_topic_0281057028_row128492810369"><td class="cellrowborder" rowspan="4" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p1029016288362">lts</p>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p12901282361">Reporting of Shubao access logs</p>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p936943354616">Yes</p>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p1929062813617">{"name":"lts","enable":true,"config": "{\"group_id\": ",\"topic_id\":\"\",\"log_group\":\"\",\"log_stream\":\"\"}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p829142817363">group_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p1529112818365">Log group ID.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p11898153815419">-</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p189071385414">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row20284182873619"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p329214282363">topic_id</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p22929283362">Log stream ID.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p1791510387417">-</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p1492210388412">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row3284122810366"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p10294162816367">log_group</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p1929512823617">Name of a log group.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p093083864117">-</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p19937183834114">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row15284152853616"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p1629632873610">log_stream</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p18296328203616">Name of a log stream.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p199441738194112">-</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p15950238104116">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row2530020124816"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p4172203144815">gateway_responses</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p191721931124813">Custom gateway responses</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p41721931134817">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p1795443684812">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p1961203664811">-</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p1296714367482">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p99741636194811">-</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p13981153616481">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row1528452833610"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p142978280361">ratelimit</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p14297628173613">Request throttling limit configuration</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p11161324164715">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p8297102815366">{"name":"ratelimit","enable":true,"config": "{\"api_limits\": 500}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p14298102815362">api_limits</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p1629820284360">Default request throttling value applied to all APIs. Set this parameter properly to meet service requirements. A small value may constantly throttle your services.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p122981128103614">200 calls per second</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p1529872893611">11,000,000 calls per second</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row7284172863618"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p202985283361">request_body_size</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p13299102823619">Configuration of the maximum request body size</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p916862464713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p5299628193616">{"name":"request_body_size","enable":true,"config": "104857600"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p4299152813367">request_body_size</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p15299132813618">Maximum size of the body allowed in an API request.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p33007283368">12 MB</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p183001028163619">19536 MB</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row528413280366"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p830062833610">backend_timeout</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p19300192843610">Backend timeout configuration</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p51753241478">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p430119289361">{"name":"backend_timeout","enable":true,"config": "{"max_timeout": 500}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p13301172815365">max_timeout</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p630112819368">Maximum timeout duration for APIC to access a backend service.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p14301162815367">60,000 ms</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p1230211289367">1-600,000 ms</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row1285142811364"><td class="cellrowborder" rowspan="5" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p93021128153613">app_token</p>
</td>
<td class="cellrowborder" rowspan="5" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p7302228113612">app_token authentication</p>
</td>
<td class="cellrowborder" rowspan="5" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p61455278478">Yes</p>
</td>
<td class="cellrowborder" rowspan="5" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p83021128183610">{"name":"app_token","enable":true,"config": "{\"enable\": \"on\", \"app_token_expire_time\": 3600, \"app_token_uri\": \"/v1/apigw/oauth2/token\", \"refresh_token_expire_time\": 7200}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p2030232813617">enable</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p33031528153615">Whether to enable app_token authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p8303152873619">Off</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p9303628113619">On/Off</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row6285172816365"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p5304162819362">app_token_expire_time</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p1130482813617">Validity period of the access token.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p1130402817360">3600s</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p11304152816361">172,000s</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row328552815365"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p1930512812369">refresh_token_expire_time</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p203052028143610">Validity period of the refresh token.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p133061028143614">7200s</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p1130615283360">172,000s</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row128562823616"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p11306152863611">app_token_uri</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p16307328163615">URI used for obtaining the token.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p15307628103615">/v1/apigw/oauth2/token</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p9307152823616">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row15285102815366"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p43081288364">app_token_key</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p0308728153618">Token encryption key.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p24238182421">-</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p17430171814217">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row42851282365"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p9309182818366">app_api_key</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p1330910284369">app_api_key authentication</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p15152132764718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p4309132814362">{"name":"app_api_key","enable":true,"config": "on"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p151541080432">-</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p1016118824310">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p13105283369">Off</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p1831042833614">On/Off</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row142857283367"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p33101428183616">app_basic</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p13310202873616">app_basic authentication</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p16159162711479">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p113116287363">{"name":"app_basic","enable":true,"config": "on"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p13168158164316">-</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p1617488114312">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p1531111281365">Off</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p8311128103610">On/Off</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row2285128163615"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p1931262873611">app_secret</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p193121528193619">app_secret authentication</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p1716652774720">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p831213280367">{"name":"app_secret","enable":true,"config": "on"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p171822834314">-</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p619020864316">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p73131328123613">Off</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p19313122819360">On/Off</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row1728552853617"><td class="cellrowborder" rowspan="2" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p33133286363">app_jwt</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p63131128133613">app_jwt authentication</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p13477103414711">Yes</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p1314132812362">{"name":"app_jwt","enable":true,"config": "{\"enable\": \"on\", \"auth_header\": \"Authorization\"}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p16314132815366">enable</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p15314228163619">Whether to enable app_jwt authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p1831412285363">Off</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p1731582811365">On/Off</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row17285628123616"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p103151428193616">auth_header</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p13315142817364">app_jwt authentication header.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p1931618287366">Authorization</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p112911728193611">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row028592814367"><td class="cellrowborder" rowspan="2" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p83161528133614">public_key</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p19316328173619">Public_key backend signatures</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p8484234154710">Yes</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p143161228133613">{"name":"public_key","enable":true,"config": "{\"enable\": \"on\", \"public_key_uri_prefix\": \"/apigw/authadv/v2/public-key/\"}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p3317162803618">enable</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p14317102843615">Whether to enable app_jwt authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p133171128133612">Off</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p93171728143617">On/Off</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row14285152811364"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p731852873611">public_key_uri_prefix</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p17318192873613">URI prefix used for obtaining the public key.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p113180286362">/apigw/authadv/v2/public-key/</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p2776135111437">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row728552823610"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p2319152818362">backend_token_allow</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p1931919282369">Allowing tenants to transparently transmit tokens to the backend</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p154912344479">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p19319142814368">{"name":"backend_token_allow","enable":true,"config": "{\"backend_token_allow_users\": [\"paas_apig_wwx548366_01\"]}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p10319112814369">backend_token_allow_users</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p173207280369">Regular expression for transparently transmitting the token to the common tenant whitelist of the tenant to match the domain name of the common tenant.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p096410187445">-</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p597019189449">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row2611115918485"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p1823771315495">sign_basic</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p1523731317496">Basic signature keys</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p13237013184911">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p9481171834913">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p348910189493">-</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p949631811495">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p165041018194914">-</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p9511131815498">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row1932395710484"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p2237161316499">multi_auth</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p192374136491">Two-factor authentication</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p623701316494">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p12518618124917">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p135264188494">-</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p4533318134910">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p11540191874913">-</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p5548418174915">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row728562818364"><td class="cellrowborder" rowspan="4" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p9320428143610">backend_client_certificate</p>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p133201328153615">Backend two-way authentication</p>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p20498634104716">Yes</p>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p3321102814366">{"name":"backend_client_certificate","enable":true,"config": "{\"enable\": \"on\",\"ca\": \"\",\"content\": \"\",\"key\": \"\"}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p832119288361">enable</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p532110288362">Whether to enable this feature.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p3321528133618">Off</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p1932214281361">On/Off</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row1728520282366"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p12323112812362">ca</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p20323528103613">CA file of two-way authentication.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p12138816144413">-</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p71441316144415">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row8285112813619"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p103241628173610">content</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p123248283365">Two-way authentication file.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p015017169440">-</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p121560165448">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row18285122815366"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p1232602817360">key</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p1532613283364">Private key of two-way authentication.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p1716371634419">-</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p1116921634415">-</p>
</td>
</tr>
<tr id="apig-api-20210402__en-us_topic_0281057028_row7285132863610"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__en-us_topic_0281057028_p1032618286367">ssl_ciphers</p>
</td>
<td class="cellrowborder" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__en-us_topic_0281057028_p33272028153615">HTTPS cipher suites</p>
</td>
<td class="cellrowborder" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__en-us_topic_0281057028_p1850543474718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__en-us_topic_0281057028_p12327112819361">{"name":"ssl_ciphers","enable":true,"config": "config": "{\"ssl_ciphers\": [\"ECDHE-ECDSA-AES256-GCM-SHA384\"]}"}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__en-us_topic_0281057028_p12327628183616">ssl_ciphers</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__en-us_topic_0281057028_p10327132819369">Encryption and decryption suites supported. The <strong id="apig-api-20210402__en-us_topic_0281057028_b7489119105412">ssl_ciphers</strong> parameter cannot be left blank and can contain only the options in the default value.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__en-us_topic_0281057028_p119884283448">-</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__en-us_topic_0281057028_p16328152863613">ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-RSA-AES128-GCM-SHA256,ECDHE-ECDSA-AES256-SHA384,ECDHE-RSA-AES256-SHA384,ECDHE-ECDSA-AES128-SHA256,ECDHE-RSA-AES128-SHA256</p>
</td>
</tr>
<tr id="apig-api-20210402__row3557190115011"><td class="cellrowborder" rowspan="2" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__p1592111616512">real_ip_from_xff</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="10.471047104710472%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__p992111675114"><strong id="apig-api-20210402__b2471624185112">X-Forwarded-For</strong> header for identifying IP addresses during access control and request throttling</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="11.071107110711074%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__p49211661519">Yes</p>
</td>
<td class="cellrowborder" rowspan="2" valign="top" width="12.921292129212924%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__p17921126155110">{"name": "real_ip_from_xff","enable": true,"config": {"enable": "on","xff_index": -1}}</p>
</td>
<td class="cellrowborder" valign="top" width="12.231223122312233%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20210402__p1792118613513">enable</p>
</td>
<td class="cellrowborder" valign="top" width="14.271427142714272%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20210402__p1792116135110">Whether to enable this feature.</p>
</td>
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20210402__p49228615110">Off</p>
</td>
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20210402__p7922196115115">On/Off</p>
</td>
</tr>
<tr id="apig-api-20210402__row1511573005017"><td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20210402__p79229665116">xff_index</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20210402__p09221662515">Sequence number of an IP address in the <strong id="apig-api-20210402__b76177574523">X-Forwarded-For</strong> header. The value of this parameter can be <strong id="apig-api-20210402__b6623757205217">0</strong> or a positive or negative number. If the value is <strong id="apig-api-20210402__b86232579528">0</strong> or a positive number, the IP address of the corresponding index is obtained from the <strong id="apig-api-20210402__b462325710524">X-Forwarded-For</strong> header. If the value is a negative number, the IP address in reverse index order is obtained from the <strong id="apig-api-20210402__b5623155765218">X-Forwarded-For</strong> header. For example, assume that the <strong id="apig-api-20210402__b3808102814532">X-Forwarded-For</strong> header of a request received by API gateway contains three IP addresses: IP1, IP2, and IP3. If the value of <strong id="apig-api-20210402__b20814182835317">xff_index</strong> is <strong id="apig-api-20210402__b1381432818538">0</strong>, IP1 is obtained. If the value of <strong id="apig-api-20210402__b1814182815316">xff_index</strong> is <strong id="apig-api-20210402__b1381412813534">1</strong>, IP2 is obtained. If the value of <strong id="apig-api-20210402__b118144288537">xff_index</strong> is <strong id="apig-api-20210402__b1781492865316">1</strong>, IP3 is obtained.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20210402__p1392217615114">-1</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20210402__p792210685113">Valid Int32 value</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-api-190529271.html">Appendix</a></div>
</div>
</div>