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>
334 lines
34 KiB
HTML
334 lines
34 KiB
HTML
<a name="waf_02_0015"></a><a name="waf_02_0015"></a>
|
|
|
|
<h1 class="topictitle1">Modifying the Configurations of a Domain Name</h1>
|
|
<div id="body44199318"><div class="section" id="waf_02_0015__section58977142"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0015__p23374969">This API is used to modify basic configurations of a domain name.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0015__section61032237"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0015__ul14324374"><li id="waf_02_0015__li61810505">URI format<p id="waf_02_0015__p19423635"><a name="waf_02_0015__li61810505"></a><a name="li61810505"></a>PUT /v1/{project_id}/waf/instance/{instance_id}</p>
|
|
</li><li id="waf_02_0015__li40594989">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0015__table29810584" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0015__row53142603"><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_0015__p9583549"><strong id="waf_02_0015__b166311362714">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_0015__p38070020"><strong id="waf_02_0015__b101787140273">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_0015__p63772808"><strong id="waf_02_0015__b194612154278">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_0015__p65323824"><strong id="waf_02_0015__b8881515112712">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0015__row56738405"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0015__p32408078">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_0015__p7808660">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_0015__p28521694">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_0015__p28555860">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row55676156"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0015__p13474784">instance_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_0015__p17715749">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_0015__p25689587">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_0015__p481777">Specifies the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0015__section12419223"><h4 class="sectiontitle">Request</h4><div class="p" id="waf_02_0015__p1789175119310">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0015__table61405329" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter description</caption><thead align="left"><tr id="waf_02_0015__row58888607"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.1.2.5.1.1"><p id="waf_02_0015__p5247824"><strong id="waf_02_0015__b147061432122716">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.3.2.1.2.5.1.2"><p id="waf_02_0015__p22420594"><strong id="waf_02_0015__b1674612330272">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.3.2.1.2.5.1.3"><p id="waf_02_0015__p4128812"><strong id="waf_02_0015__b4824173417273">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.3.2.1.2.5.1.4"><p id="waf_02_0015__p65998375"><strong id="waf_02_0015__b169721035152715">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0015__row44268171"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0015__p28952062">certificate_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0015__p63415723">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0015__p36399928">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0015__p62713037">Specifies the certificate ID. This parameter is not required when <span class="parmname" id="waf_02_0015__parmname97183673816"><b>client_protocol</b></span> is set to <strong id="waf_02_0015__b15739115919478">HTTP</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row27546427"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0015__p16668080">server</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0015__p7937217">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0015__p38934872">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0015__p12362191310286">Specifies the origin server information, including the <strong id="waf_02_0015__b960413271392">client_protocol</strong>, <strong id="waf_02_0015__b3605112723913">server_protocol</strong>, <strong id="waf_02_0015__b5605627193911">address</strong>, and <strong id="waf_02_0015__b116067278391">port</strong> fields.</p>
|
|
<ul id="waf_02_0015__ul5701341115010"><li id="waf_02_0015__li17054155011"><span class="parmvalue" id="waf_02_0015__parmvalue5429103163913"><b>client_protocol</b></span>: protocol type of the client. The options are <strong id="waf_02_0015__b889454497">HTTP</strong> and <strong id="waf_02_0015__b15891456494">HTTPS</strong>.</li><li id="waf_02_0015__li990315485514"><strong id="waf_02_0015__b11892173915394">server_protocol</strong>: protocol used by WAF to forward client requests to the server. The options are <strong id="waf_02_0015__b547169134910">HTTP</strong> and <strong id="waf_02_0015__b94718934919">HTTPS</strong>.</li><li id="waf_02_0015__li20838353135014"><strong id="waf_02_0015__b916292921813">address</strong>: public IP address or domain name of the web server that the client accesses</li><li id="waf_02_0015__li2125193121813"><strong id="waf_02_0015__b56621433151810">port</strong>: port number used by the web server. The value ranges from <strong id="waf_02_0015__b19662103318187">0</strong> to <strong id="waf_02_0015__b1766293371815">65535</strong>, for example, <strong id="waf_02_0015__b0662113317189">8080</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row63581104"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0015__p49795776">proxy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0015__p6926065">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0015__p24140394">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0015__p9214932">Specifies whether a proxy is configured.</p>
|
|
<ul id="waf_02_0015__ul1189171615367"><li id="waf_02_0015__li191893163361"><strong id="waf_02_0015__b19830161304918">true</strong>: A proxy is configured.</li><li id="waf_02_0015__li21891416163615"><strong id="waf_02_0015__b105678449496">false</strong>: No proxy is configured.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row1631512311233"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0015__p63151923102314">sip_header_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0015__p231572352318">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0015__p1331572392314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0015__p8843143191518">Specifies the type of the source IP header. This parameter is required only when <strong id="waf_02_0015__b15170142152310">proxy</strong> is set to <strong id="waf_02_0015__b191708272312">true</strong>.</p>
|
|
<p id="waf_02_0015__p122363442313">The options are as follows: <strong id="waf_02_0015__b610714183495">default</strong>, <strong id="waf_02_0015__b151221918144913">cloudflare</strong>, <strong id="waf_02_0015__b8122218134910">akamai</strong>, and <strong id="waf_02_0015__b20122161816491">custom</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row4830172582314"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0015__p108311025182319">sip_header_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0015__p7831825122318">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0015__p168311925182315">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0015__p1962095241420">Specifies the HTTP request header for identifying the real source IP address. This parameter is required only when <strong id="waf_02_0015__b13498178152318">proxy</strong> is set to <strong id="waf_02_0015__b174985816238">true</strong>.</p>
|
|
<ul id="waf_02_0015__ul1757412912176"><li id="waf_02_0015__li559942011710">If <strong id="waf_02_0015__b423281072319">sip_header_name</strong> is <strong id="waf_02_0015__b9232161032313">default</strong>, <strong id="waf_02_0015__b13232710192314">sip_header_list</strong> is <strong id="waf_02_0015__b223241092313">["X-Forwarded-For"]</strong>.</li><li id="waf_02_0015__li135749919177">If <strong id="waf_02_0015__b96434579549">sip_header_name</strong> is <strong id="waf_02_0015__b264385795412">cloudflare</strong>, <strong id="waf_02_0015__b6643125755419">sip_header_list</strong> is <strong id="waf_02_0015__b16643145735419">["CF-Connecting-IP", "X-Forwarded-For"]</strong>.</li><li id="waf_02_0015__li1342283018171">If <strong id="waf_02_0015__b11839195113117">sip_header_name</strong> is <strong id="waf_02_0015__b15839951121113">akamai</strong>, <strong id="waf_02_0015__b4839751131117">sip_header_list</strong> is <strong id="waf_02_0015__b1083995110115">["True-Client-IP"]</strong>.</li><li id="waf_02_0015__li1957416961712">If <strong id="waf_02_0015__b10521161712236">sip_header_name</strong> is <strong id="waf_02_0015__b20521317132319">custom</strong>, you can customize a value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row1158713235818"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0015__p195886231883">tls</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0015__p137617481583">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0015__p1176548981">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0015__p1378145014189">Specifies the minimum TLS version for accessing the protected domain name. This parameter is available if <strong id="waf_02_0015__b152809554349">client_protocol</strong> is set to <strong id="waf_02_0015__b6281145553411">HTTPS</strong>.</p>
|
|
<ul id="waf_02_0015__ul821342191911"><li id="waf_02_0015__waf_02_0015_li12424132017588"><strong id="waf_02_0015__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_0015__waf_02_0015_li94241420205814"><strong id="waf_02_0015__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_0015__row250418534817"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0015__p87548217912">cipher</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0015__p3754621793">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0015__p075462599">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0015__p75751618111913">Specifies the cipher suite supported by the protected domain name. This parameter is available if <strong id="waf_02_0015__b6158194133215">client_protocol</strong> is set to <strong id="waf_02_0015__b516911493213">HTTPS</strong>.</p>
|
|
<ul id="waf_02_0015__ul115661223184410"><li id="waf_02_0015__waf_02_0015_li19425152085820"><strong id="waf_02_0015__waf_02_0015_b01037714711">cipher_default</strong>: (Default) Good browser compatibility, most clients supported, sufficient for most scenarios</li><li id="waf_02_0015__waf_02_0015_li1342522016582"><strong id="waf_02_0015__waf_02_0015_b761885418460">cipher_1</strong>: (Recommended) Best combination of compatibility and security</li><li id="waf_02_0015__waf_02_0015_li64251120145817"><strong id="waf_02_0015__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_0015__waf_02_0015_li10425162014583"><strong id="waf_02_0015__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_0015__section44664151"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0015__p1853871753219">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0015__table57985477" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request parameter description</caption><thead align="left"><tr id="waf_02_0015__row6696138"><th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0015__p5516328"><strong id="waf_02_0015__b7739133422810">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_0015__p44169398"><strong id="waf_02_0015__b9568735132819">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_0015__p20951452"><strong id="waf_02_0015__b20310173622814">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0015__row54345344"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p39896734">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_0015__p10410025">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_0015__p37905672">Specifies the domain ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row5606731"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p51492036">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_0015__p10105349">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_0015__p8980385">Specifies the domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row102041951183518"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p820435117357">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_0015__p12204151153517">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_0015__p4371234161716">Specifies the CNAME value. For example, <strong id="waf_02_0015__b171451387014">efec1196267b41c399f2980ea4048517.waf.cloud.com</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row122121655183513"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p421345518358">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_0015__p1021385519357">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_0015__p1549244121814">Specifies the TXT record. This parameter is returned only when <strong id="waf_02_0015__b131621730145016">proxy</strong> is set to <strong id="waf_02_0015__b716233019507">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row1129619073614"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p1129612011363">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_0015__p1529620193613">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_0015__p673423131814">Specifies the subdomain name. This parameter is returned only when <strong id="waf_02_0015__b7754126105112">proxy</strong> is set to <strong id="waf_02_0015__b675410645114">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row30818691"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p13286080">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_0015__p2430685">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_0015__p62667778">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row27139096"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p50783133">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_0015__p19793086">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_0015__p8515133844011">Specifies the WAF mode.</p>
|
|
<ul id="waf_02_0015__ul137579456408"><li id="waf_02_0015__li1275714514017"><strong id="waf_02_0015__b65782041182">0</strong>: disabled.</li><li id="waf_02_0015__li27578453409"><strong id="waf_02_0015__b1425419278555">1</strong>: enabled.</li><li id="waf_02_0015__li5499161714310"><span class="parmvalue" id="waf_02_0015__parmvalue1023875662014"><b>-1</b></span>: bypassed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row754573"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p61120437">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_0015__p51808341">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_0015__p19585656134117">Specifies whether a domain name is connected to WAF.</p>
|
|
<ul id="waf_02_0015__ul39582516425"><li id="waf_02_0015__li995815514425"><strong id="waf_02_0015__b197744176015">0</strong>: The domain name is not connected to WAF.</li><li id="waf_02_0015__li1395815114211"><strong id="waf_02_0015__b73364211508">1</strong>: The domain name is connected to WAF.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row53099466"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p6089503">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_0015__p23487720">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_0015__p23457166">Specifies the protocol type. The options are <strong id="waf_02_0015__b2311174020112">HTTP</strong>, <strong id="waf_02_0015__b153118401912">HTTPS</strong>, and <span class="parmvalue" id="waf_02_0015__parmvalue13678161104010"><b>HTTP,HTTPS</b></span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row9787903"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p54622650">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_0015__p62358534">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_0015__p17876490">Specifies the certificate ID. This parameter is returned only when <strong id="waf_02_0015__b192544511">protocol</strong> is set to <strong id="waf_02_0015__b12926441617">HTTPS</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row26670689"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p12842221">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_0015__p33587014">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_0015__p36193619">Specifies the origin server information, including the <strong id="waf_02_0015__b696551314212">client_protocol</strong>, <strong id="waf_02_0015__b496541314217">server_protocol</strong>, <strong id="waf_02_0015__b69652013126">address</strong>, and <strong id="waf_02_0015__b1965181310219">port</strong> fields.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row57307121"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p11365224">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_0015__p48167943">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_0015__p10924103854314">Specifies whether a proxy is configured.</p>
|
|
<ul id="waf_02_0015__ul16743155117444"><li id="waf_02_0015__li4743175124414"><strong id="waf_02_0015__b16618225135011">true</strong>: A proxy is configured.</li><li id="waf_02_0015__li2743115154420"><strong id="waf_02_0015__b163017298504">false</strong>: No proxy is configured.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row46256269250"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p10626132613253">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_0015__p462652617256">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_0015__p6626926142515">Specifies the type of the source IP header. This parameter is returned only when <strong id="waf_02_0015__b01631203239">proxy</strong> is set to <strong id="waf_02_0015__b111701920112316">true</strong>.</p>
|
|
<p id="waf_02_0015__p20672019124820">The options are as follows: <strong id="waf_02_0015__b461813273385">default</strong>, <strong id="waf_02_0015__b1161862716380">cloudflare</strong>, <strong id="waf_02_0015__b761814274382">akamai</strong>, and <strong id="waf_02_0015__b6618142733811">custom</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row1434123116252"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p1341123113252">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_0015__p17342183115258">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_0015__p123092211264">Specifies the HTTP request header for identifying the real source IP address. This parameter is returned only when <strong id="waf_02_0015__b3179102612316">proxy</strong> is set to <strong id="waf_02_0015__b13179726102316">true</strong>.</p>
|
|
<ul id="waf_02_0015__ul13577174214502"><li id="waf_02_0015__li95801142155013">If <strong id="waf_02_0015__b940412814236">sip_header_name</strong> is <strong id="waf_02_0015__b16404228112316">default</strong>, <strong id="waf_02_0015__b13404102819233">sip_header_list</strong> is <strong id="waf_02_0015__b1540442815236">["X-Forwarded-For"]</strong>.</li><li id="waf_02_0015__li658944215010">If <strong id="waf_02_0015__b194721914557">sip_header_name</strong> is <strong id="waf_02_0015__b1847901195513">cloudflare</strong>, <strong id="waf_02_0015__b44796195517">sip_header_list</strong> is <strong id="waf_02_0015__b74795155510">["CF-Connecting-IP", "X-Forwarded-For"]</strong>.</li><li id="waf_02_0015__li2059811423506">If <strong id="waf_02_0015__b317120651215">sip_header_name</strong> is <strong id="waf_02_0015__b417196131220">akamai</strong>, <strong id="waf_02_0015__b15179106201217">sip_header_list</strong> is <strong id="waf_02_0015__b171793631218">["True-Client-IP"]</strong>.</li><li id="waf_02_0015__li1604442125014">If <strong id="waf_02_0015__b1845535132317">sip_header_name</strong> is <strong id="waf_02_0015__b84512351232">custom</strong>, you can customize a value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row16495157"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__p61039329">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_0015__p45238577">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_0015__p40446093">Specifies the time when a domain name is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0015__row11890150161212"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__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_0015__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_0015__p15424120195818">Specifies the minimum TLS version for accessing the protected domain name. This parameter is returned only when <span class="parmname" id="waf_02_0015__parmname8201329183410"><b>client_protocol</b></span> is set to <strong id="waf_02_0015__b106561718732">HTTPS</strong>.</p>
|
|
<ul id="waf_02_0015__ul104241320175816"><li id="waf_02_0015__li12424132017588"><strong id="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_0015__li94241420205814"><strong id="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_0015__row15771456151115"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0015__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_0015__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_0015__p11424122012581">Specifies the cipher suite supported by the protected domain name. This parameter is returned only when <span class="parmname" id="waf_02_0015__parmname1055524193415"><b>client_protocol</b></span> is set to <strong id="waf_02_0015__b185652463412">HTTPS</strong>.</p>
|
|
<ul id="waf_02_0015__ul1942562011585"><li id="waf_02_0015__li19425152085820"><strong id="waf_02_0015__b01037714711">cipher_default</strong>: (Default) Good browser compatibility, most clients supported, sufficient for most scenarios</li><li id="waf_02_0015__li1342522016582"><strong id="waf_02_0015__b761885418460">cipher_1</strong>: (Recommended) Best combination of compatibility and security</li><li id="waf_02_0015__li64251120145817"><strong id="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_0015__li10425162014583"><strong id="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_0015__section9725142733211"><h4 class="sectiontitle">Examples</h4><p id="waf_02_0015__p19848743102417"><strong id="waf_02_0015__b116971018174319">www.a.com</strong> is used as an example.</p>
|
|
<ul id="waf_02_0015__ul1750162743213"><li id="waf_02_0015__li197483278325">Request example<pre class="screen" id="waf_02_0015__screen12748132714326">{
|
|
"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"],
|
|
"cipher": "cipher_1",
|
|
"tls": "TLS v1.1"
|
|
}</pre>
|
|
</li><li id="waf_02_0015__li275010274325">Response example<pre class="screen" id="waf_02_0015__screen1575092716327">{
|
|
"id": "388a7789d55b41d1918b3088a8f1e7f3",
|
|
"hostname": "www.a.com",
|
|
|
|
"cname": "3249d21e5eb34d21be12fdc817fcb67d.wafcloud.com",
|
|
"txt_code": "3249d21e5eb34d21be12fdc817fcb67d",
|
|
"sub_domain": "3249d21e5eb34d21be12fdc817fcb67d.www.a.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_0015__section66433045"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0015__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0015__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0015__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0015__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_0015__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_0015__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_0015__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_0015__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0015__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_0015__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_0015__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_0015__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0015__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>
|
|
|