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>
317 lines
29 KiB
HTML
317 lines
29 KiB
HTML
<a name="waf_02_0014"></a><a name="waf_02_0014"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Domain Name</h1>
|
|
<div id="body16385058"><div class="section" id="waf_02_0014__section15255239"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0014__p52121326">This API is used to query details about a domain name.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0014__section3079425"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0014__ul61077874"><li id="waf_02_0014__li12829961">URI format<p id="waf_02_0014__p48360791"><a name="waf_02_0014__li12829961"></a><a name="li12829961"></a>GET /v1/{project_id}/waf/instance/{instance_id}</p>
|
|
</li><li id="waf_02_0014__li32593941">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0014__table24910021" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0014__row56986579"><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_0014__p52510190"><strong id="waf_02_0014__b86911019172">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_0014__p25466973"><strong id="waf_02_0014__b194711121715">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_0014__p49558921"><strong id="waf_02_0014__b99841119179">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_0014__p54849625"><strong id="waf_02_0014__b1394502161718">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0014__row13634613"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0014__p30661894">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_0014__p585524">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_0014__p47427494">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_0014__p16421829">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row13578736"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0014__p26135869">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_0014__p36630634">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_0014__p14291359">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_0014__p16749445">Specifies the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0014__section27714832"><h4 class="sectiontitle">Request</h4><p id="waf_02_0014__p20151185911233">Request parameters</p>
|
|
<p class="msonormal" id="waf_02_0014__p14527811">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0014__section48106900"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0014__p0479924153111">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0014__table22387562" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="waf_02_0014__row5105955"><th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0014__p10929212"><strong id="waf_02_0014__b6281112421713">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_0014__p12851014"><strong id="waf_02_0014__b1312112591713">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_0014__p34299241"><strong id="waf_02_0014__b33110268173">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0014__row40257715"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p39649453">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_0014__p57489107">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_0014__p26106127">Specifies the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row33628551"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p39558140">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_0014__p50092794">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_0014__p30984488">Specifies the domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row13252189236"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p6325518202315">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_0014__p5325101817231">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_0014__p4371234161716">Specifies the CNAME value. For example, <strong id="waf_02_0014__b84254427588">efec1196267b41c399f2980ea4048517.waf.cloud.com</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row1061123613237"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p76111836172320">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_0014__p186113367236">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_0014__p1549244121814">Specifies the TXT record. This parameter is returned only when <strong id="waf_02_0014__b16886185603417">proxy</strong> is set to <strong id="waf_02_0014__b1688613562344">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row13187202562410"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p618772592414">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_0014__p6187112511242">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_0014__p673423131814">Specifies the subdomain name. This parameter is returned only when <strong id="waf_02_0014__b1896310417351">proxy</strong> is set to <strong id="waf_02_0014__b8972646353">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row61883492"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p46506973">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_0014__p8968438">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_0014__p55354839">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row28431506"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p21250675">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_0014__p43583153">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_0014__p357818332332">Specifies the WAF mode.</p>
|
|
<ul id="waf_02_0014__ul1373411430338"><li id="waf_02_0014__li17734243183317"><strong id="waf_02_0014__b157181631132019">0</strong>: disabled.</li><li id="waf_02_0014__li3734184314336"><strong id="waf_02_0014__b8191614133514">1</strong>: enabled.</li><li id="waf_02_0014__li2996349311"><span class="parmvalue" id="waf_02_0014__parmvalue144051534142011"><b>-1</b></span>: bypassed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row29626322"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p50921845">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_0014__p31028818">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_0014__p78861505348">Specifies whether a domain name is connected to WAF.</p>
|
|
<ul id="waf_02_0014__ul74320843410"><li id="waf_02_0014__li543268143419"><strong id="waf_02_0014__b501859155819">0</strong>: The domain name is not connected to WAF.</li><li id="waf_02_0014__li184322873420"><strong id="waf_02_0014__b1425715320595">1</strong>: The domain name is connected to WAF.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row4321417"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p14490490">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_0014__p32879007">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_0014__p45953888">Specifies the protocol type. The options are <strong id="waf_02_0014__b7379610181819">HTTP</strong>, <strong id="waf_02_0014__b81341314171816">HTTPS</strong>, and <span class="parmvalue" id="waf_02_0014__parmvalue13678161104010"><b>HTTP,HTTPS</b></span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row10931815"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p13061855">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_0014__p51377319">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_0014__p813287">Specifies the certificate ID. This parameter is returned only when <span class="parmname" id="waf_02_0014__parmname8201329183410"><b>client_protocol</b></span> is set to <strong id="waf_02_0014__b106561718732">HTTPS</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row7319588"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p56015756">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_0014__p40982401">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_0014__p2055605">Specifies the origin server information, including the <strong id="waf_02_0014__b31981217203812">client_protocol</strong>, <strong id="waf_02_0014__b1519871711380">server_protocol</strong>, <strong id="waf_02_0014__b121991175384">address</strong>, and <strong id="waf_02_0014__b1199161783816">port</strong> fields.</p>
|
|
<ul id="waf_02_0014__ul5701341115010"><li id="waf_02_0014__li17054155011"><span class="parmvalue" id="waf_02_0014__parmvalue19392228383"><b>client_protocol</b></span>: protocol type of the client. The options are <strong id="waf_02_0014__b756418155367">HTTP</strong> and <strong id="waf_02_0014__b756411154364">HTTPS</strong>.</li><li id="waf_02_0014__li990315485514"><strong id="waf_02_0014__b486515125010">server_protocol</strong>: protocol used by WAF to forward client requests to the server. The options are <strong id="waf_02_0014__b1951782273611">HTTP</strong> and <strong id="waf_02_0014__b851772203610">HTTPS</strong>.</li><li id="waf_02_0014__li20838353135014"><strong id="waf_02_0014__b1535137181713">address</strong>: public IP address or domain name of the web server that the client accesses</li><li id="waf_02_0014__li2125193121813"><strong id="waf_02_0014__b132544453177">port</strong>: port number used by the web server. The value ranges from <strong id="waf_02_0014__b825414451176">0</strong> to <strong id="waf_02_0014__b172541459179">65535</strong>, for example, <strong id="waf_02_0014__b112548451173">8080</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row12726078"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p24179377">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_0014__p12372492">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_0014__p32316963618">Specifies whether a proxy is configured.</p>
|
|
<ul id="waf_02_0014__ul1189171615367"><li id="waf_02_0014__li191893163361"><strong id="waf_02_0014__b31813819205">true</strong>: A proxy is configured.</li><li id="waf_02_0014__li21891416163615"><strong id="waf_02_0014__b19631822200">false</strong>: No proxy is configured.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row9980155952118"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p19980459162112">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_0014__p39804595216">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_0014__p18980135915210">Specifies the type of the source IP header. This parameter is returned only when <strong id="waf_02_0014__b758185915216">proxy</strong> is set to <strong id="waf_02_0014__b1758114599217">true</strong>.</p>
|
|
<p id="waf_02_0014__p122363442313">The options are as follows: <strong id="waf_02_0014__b434311116417">default</strong>, <strong id="waf_02_0014__b1634317112414">cloudflare</strong>, <strong id="waf_02_0014__b173511111743">akamai</strong>, and <strong id="waf_02_0014__b835110111845">custom</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row49071420222"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p59076222211">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_0014__p7907228225">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_0014__p1962095241420">Specifies the HTTP request header for identifying the real source IP address. This parameter is returned only when <strong id="waf_02_0014__b1339271422219">proxy</strong> is set to <strong id="waf_02_0014__b14011914162213">true</strong>.</p>
|
|
<ul id="waf_02_0014__ul1757412912176"><li id="waf_02_0014__li559942011710">If <strong id="waf_02_0014__b156811118172213">sip_header_name</strong> is <strong id="waf_02_0014__b1668111842211">default</strong>, <strong id="waf_02_0014__b1669019188229">sip_header_list</strong> is <strong id="waf_02_0014__b126901318192214">["X-Forwarded-For"]</strong>.</li><li id="waf_02_0014__li135749919177">If <strong id="waf_02_0014__b169704012541">sip_header_name</strong> is <strong id="waf_02_0014__b397194010544">cloudflare</strong>, <strong id="waf_02_0014__b1597240135414">sip_header_list</strong> is <strong id="waf_02_0014__b3978408545">["CF-Connecting-IP", "X-Forwarded-For"]</strong>.</li><li id="waf_02_0014__li1342283018171">If <strong id="waf_02_0014__b192561721141111">sip_header_name</strong> is <strong id="waf_02_0014__b12256521111114">akamai</strong>, <strong id="waf_02_0014__b11256821201114">sip_header_list</strong> is <strong id="waf_02_0014__b025652113115">["True-Client-IP"]</strong>.</li><li id="waf_02_0014__li1957416961712">If <strong id="waf_02_0014__b1212824272213">sip_header_name</strong> is <strong id="waf_02_0014__b312864219224">custom</strong>, you can customize a value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row26959292"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p36219011">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_0014__p48058799">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_0014__p448680">Specifies the time when a domain name is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row1574317531718"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__p1355441491715">block_page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0014__p65541114151717"><a href="#waf_02_0014__table16354185321711">BlockPage</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0014__p1355491412172">Alarm page configuration</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row417510613447"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__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_0014__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_0014__p15424120195818">Specifies the minimum TLS version for accessing the protected domain name. This parameter is returned only when <span class="parmname" id="waf_02_0014__parmname141621656144016"><b>client_protocol</b></span> is set to <strong id="waf_02_0014__b2163155610402">HTTPS</strong>.</p>
|
|
<ul id="waf_02_0014__ul104241320175816"><li id="waf_02_0014__waf_02_0015_li12424132017588"><strong id="waf_02_0014__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_0014__waf_02_0015_li94241420205814"><strong id="waf_02_0014__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_0014__row199969105441"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0014__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_0014__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_0014__p11424122012581">Specifies the cipher suite supported by the protected domain name. This parameter is returned only when <span class="parmname" id="waf_02_0014__parmname1625153204111"><b>client_protocol</b></span> is set to <strong id="waf_02_0014__b22521374113">HTTPS</strong>.</p>
|
|
<ul id="waf_02_0014__ul1942562011585"><li id="waf_02_0014__waf_02_0015_li19425152085820"><strong id="waf_02_0014__waf_02_0015_b01037714711">cipher_default</strong>: (Default) Good browser compatibility, most clients supported, sufficient for most scenarios</li><li id="waf_02_0014__waf_02_0015_li1342522016582"><strong id="waf_02_0014__waf_02_0015_b761885418460">cipher_1</strong>: (Recommended) Best combination of compatibility and security</li><li id="waf_02_0014__waf_02_0015_li64251120145817"><strong id="waf_02_0014__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_0014__waf_02_0015_li10425162014583"><strong id="waf_02_0014__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 class="tablenoborder"><a name="waf_02_0014__table16354185321711"></a><a name="table16354185321711"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0014__table16354185321711" frame="border" border="1" rules="all"><caption><b>Table 3 </b>BlockPage</caption><thead align="left"><tr id="waf_02_0014__row1435565313175"><th align="left" class="cellrowborder" valign="top" width="24.14241424142414%" id="mcps1.3.4.2.2.2.4.1.1"><p id="waf_02_0014__p0355653171711">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.391839183918393%" id="mcps1.3.4.2.2.2.4.1.2"><p id="waf_02_0014__p1835535301711">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.46574657465746%" id="mcps1.3.4.2.2.2.4.1.3"><p id="waf_02_0014__p435511535176">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0014__row135505313175"><td class="cellrowborder" valign="top" width="24.14241424142414%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="waf_02_0014__p1993413813203">template</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.391839183918393%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="waf_02_0014__p393414388209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.46574657465746%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="waf_02_0014__p13934203842019">Template name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row163551153201712"><td class="cellrowborder" valign="top" width="24.14241424142414%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="waf_02_0014__p2093433842019">custom_page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.391839183918393%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="waf_02_0014__p199341138112019"><a href="#waf_02_0014__table11717326142414">CustomPage</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.46574657465746%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="waf_02_0014__p393433810200">Custom alarm page</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row235595312172"><td class="cellrowborder" valign="top" width="24.14241424142414%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="waf_02_0014__p493519387205">redirect_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.391839183918393%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="waf_02_0014__p1593523822011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.46574657465746%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="waf_02_0014__p13935123813204">URL</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0014__table11717326142414"></a><a name="table11717326142414"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0014__table11717326142414" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CustomPage</caption><thead align="left"><tr id="waf_02_0014__row271872662416"><th align="left" class="cellrowborder" valign="top" width="24.14241424142414%" id="mcps1.3.4.2.3.2.4.1.1"><p id="waf_02_0014__p1077404814247">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.152215221522155%" id="mcps1.3.4.2.3.2.4.1.2"><p id="waf_02_0014__p1777584820244">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.70537053705371%" id="mcps1.3.4.2.3.2.4.1.3"><p id="waf_02_0014__p167751148102417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0014__row871822618246"><td class="cellrowborder" valign="top" width="24.14241424142414%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="waf_02_0014__p25091110142516">status_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.152215221522155%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="waf_02_0014__p1550919102251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.70537053705371%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="waf_02_0014__p16509810122513">Status code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row271812616242"><td class="cellrowborder" valign="top" width="24.14241424142414%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="waf_02_0014__p2050941082514">content_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.152215221522155%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="waf_02_0014__p1950971012257">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.70537053705371%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="waf_02_0014__p6509201092514">The content type of the custom alarm page. The value can be <strong id="waf_02_0014__b1864638192013">text/html</strong>, <strong id="waf_02_0014__b18365428207">text/xml</strong>, or <strong id="waf_02_0014__b0815114672017">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0014__row1171882610241"><td class="cellrowborder" valign="top" width="24.14241424142414%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="waf_02_0014__p35095105259">content</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.152215221522155%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="waf_02_0014__p13509710162520">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.70537053705371%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="waf_02_0014__p650912103251">Configure the page content based on the value for <strong id="waf_02_0014__b792141112219">content_type</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0014__section15404202913319"><h4 class="sectiontitle">Example</h4><p id="waf_02_0014__p4595123618219"><strong id="waf_02_0014__b8618175283818">www.a.com</strong> is used as an example.</p>
|
|
<div class="p" id="waf_02_0014__p197984073110">Response example<pre class="screen" id="waf_02_0014__screen54205290314">{
|
|
"id": "388a7789d55b41d1918b3088a8f1e7f3",
|
|
"hostname": "www.a.com",
|
|
|
|
"cname": "3249d21e5eb34d21be12fdc817fcb67d.waf.cloud.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,
|
|
"block_page" : {
|
|
"template" : "default"
|
|
},
|
|
"cipher": "cipher_1",
|
|
"tls": "TLS v1.1"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0014__section30308918"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0014__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0014__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 5</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0014__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0014__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="waf_02_0014__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_0014__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_0014__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_0014__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0014__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_0014__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_0014__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_0014__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0014__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>
|
|
|