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>
313 lines
31 KiB
HTML
313 lines
31 KiB
HTML
<a name="waf_02_0013"></a><a name="waf_02_0013"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Domain Name</h1>
|
|
<div id="body61587329"><div class="section" id="waf_02_0013__section14920754"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0013__p22517768">This API is used to create a domain name.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0013__section69063"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0013__ul11999948"><li id="waf_02_0013__li40890672">URI format<p id="waf_02_0013__p32471732"><a name="waf_02_0013__li40890672"></a><a name="li40890672"></a>POST /v1/{project_id}/waf/instance</p>
|
|
</li><li id="waf_02_0013__li23810137">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0013__table12964649" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0013__row53015668"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0013__p66410720"><strong id="waf_02_0013__b4737184915504">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0013__p10559236"><strong id="waf_02_0013__b12972155075013">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0013__p49991817"><strong id="waf_02_0013__b1526185213508">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0013__p22805399"><strong id="waf_02_0013__b129716536502">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0013__row35298005"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0013__p40566123">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0013__p64630530">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0013__p581569">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0013__p47107153">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0013__section621568"><h4 class="sectiontitle">Request</h4><div class="p" id="waf_02_0013__p17372149183010">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0013__table33716739" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter description</caption><thead align="left"><tr id="waf_02_0013__row27649238"><th align="left" class="cellrowborder" valign="top" width="26.52734726527347%" id="mcps1.3.3.2.1.2.5.1.1"><p id="waf_02_0013__p24995816"><strong id="waf_02_0013__b843315113517">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.3.2.1.2.5.1.2"><p id="waf_02_0013__p11395239"><strong id="waf_02_0013__b16519222511">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.418558144185582%" id="mcps1.3.3.2.1.2.5.1.3"><p id="waf_02_0013__p50599162"><strong id="waf_02_0013__b8409858513">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.725727427257276%" id="mcps1.3.3.2.1.2.5.1.4"><p id="waf_02_0013__p4891466"><strong id="waf_02_0013__b66760685113">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0013__row60664446"><td class="cellrowborder" valign="top" width="26.52734726527347%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0013__p14873087">hostname</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0013__p63869364">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0013__p6035973">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.725727427257276%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0013__p19151836">Specifies the domain name.</p>
|
|
<p id="waf_02_0013__p78431657145217">For example, <strong id="waf_02_0013__b311114474614">www.example.com</strong> or <strong id="waf_02_0013__b15504164713466">*.example.com</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row38148796"><td class="cellrowborder" valign="top" width="26.52734726527347%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0013__p3044756">certificate_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0013__p45298660">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0013__p45312853">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.725727427257276%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0013__p46462478">Specifies the certificate ID. This parameter is mandatory when <strong id="waf_02_0013__b96208415244">client_protocol</strong> is set to <strong id="waf_02_0013__b7989984247">HTTPS</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row15509126"><td class="cellrowborder" valign="top" width="26.52734726527347%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0013__p48279679">server</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0013__p18339925">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0013__p9138927">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.725727427257276%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0013__p2055605">Specifies the origin server information, including the <strong id="waf_02_0013__b2440569499">client_protocol</strong>, <strong id="waf_02_0013__b144475611496">server_protocol</strong>, <strong id="waf_02_0013__b744145618493">address</strong>, and <strong id="waf_02_0013__b165115664913">port</strong> fields.</p>
|
|
<ul id="waf_02_0013__ul5701341115010"><li id="waf_02_0013__li17054155011"><span class="parmvalue" id="waf_02_0013__parmvalue179100402277"><b>client_protocol</b></span>: protocol type of the client. The options are <strong id="waf_02_0013__b890725042413">HTTP</strong> and <strong id="waf_02_0013__b3852454162414">HTTPS</strong>.</li><li id="waf_02_0013__li990315485514"><strong id="waf_02_0013__b842352706201043">server_protocol</strong>: protocol used by WAF to forward client requests to the server. The options are <strong id="waf_02_0013__b9279513192520">HTTP</strong> and <strong id="waf_02_0013__b3279313162513">HTTPS</strong>.</li><li id="waf_02_0013__li12436281211"><strong id="waf_02_0013__b1316614526555">address</strong>: public IP address or domain name of the web server that the client accesses</li><li id="waf_02_0013__li1632692135811"><strong id="waf_02_0013__b1953817195815">port</strong>: port number used by the web server. The value ranges from <strong id="waf_02_0013__b25341720586">0</strong> to <strong id="waf_02_0013__b10531417165818">65535</strong>, for example, <strong id="waf_02_0013__b195381717583">8080</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row18500453"><td class="cellrowborder" valign="top" width="26.52734726527347%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0013__p22141721">proxy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0013__p48649006">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0013__p48255436">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.725727427257276%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0013__p181572050193818">Specifies whether a proxy is configured.</p>
|
|
<ul id="waf_02_0013__ul125775813386"><li id="waf_02_0013__li1247312413393"><strong id="waf_02_0013__b18191715278">true</strong>: A proxy is configured.</li><li id="waf_02_0013__li145755819382"><strong id="waf_02_0013__b19821111882714">false</strong>: No proxy is configured.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row8400175801319"><td class="cellrowborder" valign="top" width="26.52734726527347%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0013__p104001658141317">sip_header_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0013__p44001058101316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0013__p1840010585132">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.725727427257276%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0013__p3687155611489">Specifies the type of the source IP header. This parameter is required only when <strong id="waf_02_0013__b2013517415615">proxy</strong> is set to <strong id="waf_02_0013__b1854277613">true</strong>.</p>
|
|
<p id="waf_02_0013__p63761813186">The options are as follows: <strong id="waf_02_0013__b135841836236">default</strong>, <strong id="waf_02_0013__b358416313237">cloudflare</strong>, <strong id="waf_02_0013__b1758423132314">akamai</strong>, and <strong id="waf_02_0013__b058410316239">custom</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row1797718111419"><td class="cellrowborder" valign="top" width="26.52734726527347%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0013__p29774120143">sip_header_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0013__p997712118143">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0013__p149779141420">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.725727427257276%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0013__p197771191414">Specifies the HTTP request header for identifying the real source IP address. This parameter is required only when <strong id="waf_02_0013__b944019187618">proxy</strong> is set to <strong id="waf_02_0013__b134481182613">true</strong>.</p>
|
|
<ul id="waf_02_0013__ul1757412912176"><li id="waf_02_0013__li559942011710">If <strong id="waf_02_0013__b1368922419617">sip_header_name</strong> is <strong id="waf_02_0013__b36891224269">default</strong>, <strong id="waf_02_0013__b18689024465">sip_header_list</strong> is <strong id="waf_02_0013__b0689192413613">["X-Forwarded-For"]</strong>.</li><li id="waf_02_0013__li135749919177">If <strong id="waf_02_0013__b9555161313548">sip_header_name</strong> is <strong id="waf_02_0013__b6555181316544">cloudflare</strong>, <strong id="waf_02_0013__b10555111325415">sip_header_list</strong> is <strong id="waf_02_0013__b3555813145418">["CF-Connecting-IP", "X-Forwarded-For"]</strong>.</li><li id="waf_02_0013__li1342283018171">If <strong id="waf_02_0013__b1779810355109">sip_header_name</strong> is <strong id="waf_02_0013__b18806535151010">akamai</strong>, <strong id="waf_02_0013__b108061135161015">sip_header_list</strong> is <strong id="waf_02_0013__b480613357108">["True-Client-IP"]</strong>.</li><li id="waf_02_0013__li1957416961712">If <strong id="waf_02_0013__b8261133520617">sip_header_name</strong> is <strong id="waf_02_0013__b112616351610">custom</strong>, you can customize a value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0013__section5594120"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0013__p17930218143016">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0013__table27490285" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter description</caption><thead align="left"><tr id="waf_02_0013__row66285160"><th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0013__p388852"><strong id="waf_02_0013__b1136721055510">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.349999999999998%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0013__p31497077"><strong id="waf_02_0013__b8515711205511">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.160000000000004%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0013__p1126483"><strong id="waf_02_0013__b332961215552">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0013__row10138352"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p15900196">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p12847463">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p34011620">Specifies the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row37669127"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p31300427">hostname</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p52306652">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p8980385">Specifies the domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row2371534191710"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p237173411719">cname</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p4371834191710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p4371234161716">Specifies the CNAME value. For example, <strong id="waf_02_0013__b1398922619566">efec1196267b41c399f2980ea4048517.waf.cloud.com</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row18492244185"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p1649294151819">txt_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p3492164151820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p1549244121814">Specifies the TXT record. This parameter is returned only when <strong id="waf_02_0013__b20853175115288">proxy</strong> is set to <strong id="waf_02_0013__b198535512287">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row6734163120182"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p37341531101820">sub_domain</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p177343313184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p673423131814">Specifies the subdomain name. This parameter is returned only when <strong id="waf_02_0013__b895610102919">proxy</strong> is set to <strong id="waf_02_0013__b199641419299">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row22290018"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p60661062">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p14598990">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p41667555">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row39463677"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p42441296">protect_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p15192931">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p18949775417">Specifies the WAF mode.</p>
|
|
<ul id="waf_02_0013__ul1029811519417"><li id="waf_02_0013__li102501856103012"><span class="parmvalue" id="waf_02_0013__parmvalue4702153915193"><b>-1</b></span>: bypassed.</li><li id="waf_02_0013__li17298131534116"><strong id="waf_02_0013__b18764195091912">0</strong>: disabled.</li><li id="waf_02_0013__li8299131512416"><strong id="waf_02_0013__b552521212290">1</strong>: enabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row2684242"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p16097086">access_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p28795557">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p12249113014412">Specifies whether a domain name is connected to WAF.</p>
|
|
<ul id="waf_02_0013__ul45972388415"><li id="waf_02_0013__li1759753814117"><strong id="waf_02_0013__b12135202082919">0</strong>: The domain name is not connected to WAF.</li><li id="waf_02_0013__li559713894112"><strong id="waf_02_0013__b159792116291">1</strong>: The domain name is connected to WAF.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row53996033"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p11602527">proxy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p280597">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p53262117423">Specifies whether a proxy is configured.</p>
|
|
<ul id="waf_02_0013__ul18351173214216"><li id="waf_02_0013__li16351123274217"><strong id="waf_02_0013__b169061431142915">true</strong>: A proxy is configured.</li><li id="waf_02_0013__li2035216329426"><strong id="waf_02_0013__b588319329291">false</strong>: No proxy is configured.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row3228975"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p60220426">protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p46016313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p36333861">Specifies the protocol type of the client. The options are <strong id="waf_02_0013__b54781426308">HTTP</strong>, <strong id="waf_02_0013__b16781165163013">HTTPS</strong>, and <strong id="waf_02_0013__b17867089302">HTTP,HTTPS</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row58569293"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p46492254">certificate_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p7776224">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p653394019291">Specifies the certificate ID. This parameter is mandatory when <strong id="waf_02_0013__b114852013113016">client_protocol</strong> is set to <strong id="waf_02_0013__b1548541343019">HTTPS</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row31722960"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p19422978">server</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p29757409">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p61539924">Specifies the origin server information, including the <strong id="waf_02_0013__b16453827103012">client_protocol</strong>, <strong id="waf_02_0013__b16461112710305">server_protocol</strong>, <strong id="waf_02_0013__b164611827123010">address</strong>, and <strong id="waf_02_0013__b7461627153012">port</strong> fields.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row984303131517"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p1284393110156">sip_header_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p3843193112155">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p8843143191518">Specifies the type of the source IP header. This parameter is returned only when <strong id="waf_02_0013__b2369538269">proxy</strong> is set to <strong id="waf_02_0013__b133691938462">true</strong>.</p>
|
|
<p id="waf_02_0013__p122363442313">The options are as follows: <strong id="waf_02_0013__b12673154918103">default</strong>, <strong id="waf_02_0013__b8673649121017">cloudflare</strong>, <strong id="waf_02_0013__b1267304971019">akamai</strong>, and <strong id="waf_02_0013__b8673149181012">custom</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row1774735191513"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p127483531514">sip_header_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p174133521513">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p756019408495">Specifies the HTTP request header for identifying the real source IP address. This parameter is returned only when <strong id="waf_02_0013__b56564410615">proxy</strong> is set to <strong id="waf_02_0013__b2651844969">true</strong>.</p>
|
|
<ul id="waf_02_0013__ul2880124694920"><li id="waf_02_0013__li1393535214910">If <strong id="waf_02_0013__b141718451262">sip_header_name</strong> is <strong id="waf_02_0013__b84174453618">default</strong>, <strong id="waf_02_0013__b14249451465">sip_header_list</strong> is <strong id="waf_02_0013__b19424164516610">["X-Forwarded-For"]</strong>.</li><li id="waf_02_0013__li1888094613496">If <strong id="waf_02_0013__b152968222540">sip_header_name</strong> is <strong id="waf_02_0013__b14296122125412">cloudflare</strong>, <strong id="waf_02_0013__b1229612219544">sip_header_list</strong> is <strong id="waf_02_0013__b830418224545">["CF-Connecting-IP", "X-Forwarded-For"]</strong>.</li><li id="waf_02_0013__li42391058144917">If <strong id="waf_02_0013__b17901058161016">sip_header_name</strong> is <strong id="waf_02_0013__b879065861011">akamai</strong>, <strong id="waf_02_0013__b13790205820103">sip_header_list</strong> is <strong id="waf_02_0013__b479014582102">["True-Client-IP"]</strong>.</li><li id="waf_02_0013__li888015463492">If <strong id="waf_02_0013__b1697113511769">sip_header_name</strong> is <strong id="waf_02_0013__b0978165120616">custom</strong>, you can customize a value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row16988409"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p33883878">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p60239579">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p47567745">Specifies the time when a domain name is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row131272213144"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p31243197129">tls</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p10595163117127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p15424120195818">Specifies the minimum TLS version for accessing the protected domain name. This parameter is returned only when <span class="parmname" id="waf_02_0013__parmname676392912588"><b>client_protocol</b></span> is set to <strong id="waf_02_0013__b10764162995819">HTTPS</strong>.</p>
|
|
<ul id="waf_02_0013__ul104241320175816"><li id="waf_02_0013__waf_02_0015_li12424132017588"><strong id="waf_02_0013__waf_02_0015_b14502937184418">TLS v1.1</strong>: (Default) Only requests using TLS v1.1 or later can access the domain name.</li><li id="waf_02_0013__waf_02_0015_li94241420205814"><strong id="waf_02_0013__waf_02_0015_b168912265446">TLS v1.2</strong>: Only requests using TLS v1.2 or later can access the domain name.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0013__row15655112818142"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0013__p141248194121">cipher</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0013__p24191533101210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0013__p11424122012581">Specifies the cipher suite supported by the protected domain name. This parameter is returned only when <span class="parmname" id="waf_02_0013__parmname14751151754113"><b>client_protocol</b></span> is set to <strong id="waf_02_0013__b14752111764113">HTTPS</strong>.</p>
|
|
<ul id="waf_02_0013__ul1942562011585"><li id="waf_02_0013__waf_02_0015_li19425152085820"><strong id="waf_02_0013__waf_02_0015_b01037714711">cipher_default</strong>: (Default) Good browser compatibility, most clients supported, sufficient for most scenarios</li><li id="waf_02_0013__waf_02_0015_li1342522016582"><strong id="waf_02_0013__waf_02_0015_b761885418460">cipher_1</strong>: (Recommended) Best combination of compatibility and security</li><li id="waf_02_0013__waf_02_0015_li64251120145817"><strong id="waf_02_0013__waf_02_0015_b19259522184711">cipher_2</strong>: Strict compliance with forward secrecy requirements of PCI DSS and excellent protection, but earlier browsers may be unable to access the websites.</li><li id="waf_02_0013__waf_02_0015_li10425162014583"><strong id="waf_02_0013__waf_02_0015_b15769145864712">cipher_3</strong>: Support for ECDHE, DHE-GCM, and RSA-AES-GCM algorithms but not CBC</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0013__section19913183183016"><h4 class="sectiontitle">Examples</h4><p id="waf_02_0013__p16847459132316"><strong id="waf_02_0013__b1266495733516">www.b.com</strong> is used as an example.</p>
|
|
<ul id="waf_02_0013__ul1795119318300"><li id="waf_02_0013__li995114312306">Request example<pre class="screen" id="waf_02_0013__screen495123193017">{
|
|
"hostname": "www.b.com",
|
|
"certificate_id": "07fb6809a89241fca86ac6f69e34963d",
|
|
"server": [
|
|
{"client_protocol": "HTTPS", "server_protocol": "HTTP", "address": "X.X.X.X", "port": "8080"},
|
|
{"client_protocol": "HTTP", "server_protocol": "HTTP", "address": "X.X.X.X", "port": "80"}
|
|
],
|
|
"proxy": true,
|
|
"sip_header_name": "default",
|
|
"sip_header_list": ["X-Forwarded-For"]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="waf_02_0013__ul19951113163018"><li id="waf_02_0013__li89511931143016">Response example<pre class="screen" id="waf_02_0013__screen10951153173019">{
|
|
"id": "388a7789d55b41d1918b3088a8f1e7f3",
|
|
"hostname": "www.b.com",
|
|
"cname": "3249d21e5eb34d21be12fdc817fcb67d.waf.cloud.com",
|
|
"txt_code": "3249d21e5eb34d21be12fdc817fcb67d",
|
|
"sub_domain": "3249d21e5eb34d21be12fdc817fcb67d.www.b.com",
|
|
"policy_id": "xxxxxxxxxxxxxx",
|
|
"certificate_id": "xxxxxxxxxxxxxxxxxxx",
|
|
"protect_status": 0,
|
|
"access_status": 0,
|
|
"protocol": "HTTP,HTTPS",
|
|
"server": [
|
|
{"client_protocol": "HTTPS", "server_protocol":"HTTP", "address":"X.X.X.X", "port":443},
|
|
{"client_protocol": "HTTP", "server_protocol":"HTTP", "address":"X.X.X.X", "port":80}
|
|
],
|
|
"proxy": true,
|
|
"sip_header_name": "default",
|
|
"sip_header_list": ["X-Forwarded-For"],
|
|
"timestamp": 1499817600,
|
|
"cipher": "cipher_1",
|
|
"tls": "TLS v1.1"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0013__section50347087"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0013__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0013__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0013__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0013__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="waf_02_0013__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_0013__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_0013__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_0013__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0013__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_0013__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_0013__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_0013__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0013__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_0011.html">Domain Names</a></div>
|
|
</div>
|
|
</div>
|
|
|