vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/waf/api-ref/waf_02_0042.html
Li, Qiao 914011d51b waf_api_1109 
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>
2022-11-16 15:31:27 +00:00

365 lines
30 KiB
HTML
Raw Blame History

<a name="waf_02_0042"></a><a name="waf_02_0042"></a>
<h1 class="topictitle1">Querying CC Attack Protection Rules</h1>
<div id="body34869966"><div class="section" id="waf_02_0042__section727444"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0042__p5894975">This API is used to query all CC attack protection rules in a policy.</p>
</div>
<div class="section" id="waf_02_0042__section58923012"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0042__ul22231064"><li id="waf_02_0042__li65861854">URI format<p id="waf_02_0042__p55885775"><a name="waf_02_0042__li65861854"></a><a name="li65861854"></a>GET /v1/{project_id}/waf/policy/{policy_id}/cc?offset={offset}&amp;limit={limit}</p>
</li><li id="waf_02_0042__li33209934">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0042__table30453955" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0042__row66019173"><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_0042__p45952776"><strong id="waf_02_0042__b149068539305">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_0042__p31187347"><strong id="waf_02_0042__b1249213284295">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_0042__p43147183"><strong id="waf_02_0042__b780011364291">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_0042__p5260931"><strong id="waf_02_0042__b379313381291">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0042__row23482296"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0042__p23017846">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_0042__p52506212">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_0042__p25144746">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_0042__p23458545">Specifies the project ID.</p>
</td>
</tr>
<tr id="waf_02_0042__row9800316"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0042__p55628135">policy_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_0042__p9585062">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_0042__p38192546">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_0042__p6588482">Specifies the policy ID.</p>
</td>
</tr>
<tr id="waf_02_0042__row59296339"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0042__p38274149">offset</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_0042__p13198351">No</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_0042__p62433530">Long</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_0042__p21617533">Specifies the number of returned pages. Its value ranges from <strong id="waf_02_0042__b14950253113319">0</strong> to <strong id="waf_02_0042__b20950165363317">65535</strong>. The default value is <strong id="waf_02_0042__b1795019536338">0</strong>.</p>
</td>
</tr>
<tr id="waf_02_0042__row14234046"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0042__p12107073">limit</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_0042__p41148865">No</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_0042__p44723749">Long</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_0042__p25357967">Specifies the maximum number of records displayed on each page. Its value ranges from <strong id="waf_02_0042__b15826145517335">0</strong> to <strong id="waf_02_0042__b7826135523314">50</strong>. The default value is <strong id="waf_02_0042__b15826755153314">10</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="waf_02_0042__section60545062"><h4 class="sectiontitle">Request</h4><p id="waf_02_0042__p8880124584717">Request parameters</p>
<p class="msonormal" id="waf_02_0042__p32566459">None</p>
</div>
<div class="section" id="waf_02_0042__section8034648"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0042__p10809165615476">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0042__table61024835" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0042__row2629376"><th align="left" class="cellrowborder" valign="top" width="33.2966703329667%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0042__p11652904"><strong id="waf_02_0042__b73157016351">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.90730926907309%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0042__p4361181"><strong id="waf_02_0042__b13411175183510">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0042__p17711366"><strong id="waf_02_0042__b018010718357">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0042__row25184570"><td class="cellrowborder" valign="top" width="33.2966703329667%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0042__p26684269">total</p>
</td>
<td class="cellrowborder" valign="top" width="26.90730926907309%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0042__p13942152">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0042__p55572532">Specifies the total number of CC attack protection rules in a policy.</p>
</td>
</tr>
<tr id="waf_02_0042__row30390744"><td class="cellrowborder" valign="top" width="33.2966703329667%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0042__p45731167">items</p>
</td>
<td class="cellrowborder" valign="top" width="26.90730926907309%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0042__p13237067"><a href="#waf_02_0042__table16394183011019">Table 3</a></p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0042__p1603648">Specifies the CC attack protection rule objects.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="waf_02_0042__table16394183011019"></a><a name="table16394183011019"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0042__table16394183011019" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="waf_02_0042__b312671202917">items</strong></caption><thead align="left"><tr id="waf_02_0042__row939613301015"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0042__p039873016013"><strong id="waf_02_0042__b191193914421">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0042__p183997301406"><strong id="waf_02_0042__b194141142174212">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0042__p839973013010"><strong id="waf_02_0042__b05921943204220">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0042__row3521132912545"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p1550711285549">id</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p12511152855417">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p851272816548">Specifies the ID of a CC attack protection rule.</p>
</td>
</tr>
<tr id="waf_02_0042__row1152119292547"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p16515142865410">policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p651882835414">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p18520162895410">Specifies the ID of the policy to which the rule belongs.</p>
</td>
</tr>
<tr id="waf_02_0042__row652142915419"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p15221228115415">path</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p752312814546">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p13524152875412">Specifies the URL to which the rule applies, excluding a domain name.</p>
<ul id="waf_02_0042__ul20810143683616"><li id="waf_02_0042__li3815173693615">Prefix match: The path ending with * indicates that the path is used as a prefix.<p id="waf_02_0042__li315614594312p0"><a name="waf_02_0042__li3815173693615"></a><a name="li3815173693615"></a>For example, if the path to be protected is <strong id="waf_02_0042__b1620175592313">/admin/test.php</strong> or <strong id="waf_02_0042__b1662055542315">/adminabc</strong>, set <strong id="waf_02_0042__b1062010551237">Path</strong> to <span class="parmvalue" id="waf_02_0042__parmvalue4620105513234"><b>/admin*</b></span>.</p>
</li><li id="waf_02_0042__li28421136193614">Exact match: The path to be entered must match the path to be protected.<p id="waf_02_0042__p1285333620361"><a name="waf_02_0042__li28421136193614"></a><a name="li28421136193614"></a>If the path to be protected is <span class="parmvalue" id="waf_02_0042__parmvalue8970171414552"><b>/admin</b></span>, set <strong id="waf_02_0042__b1697081419556">url</strong> to <span class="parmvalue" id="waf_02_0042__parmvalue7970151414550"><b>/admin</b></span>.</p>
</li></ul>
</td>
</tr>
<tr id="waf_02_0042__row55211629115411"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p185271828155419">limit_num</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p135281286547">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p11530228185415">Specifies the number of requests allowed from a web visitor in a rate limiting period.</p>
</td>
</tr>
<tr id="waf_02_0042__row11521529165419"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p1953319288548">limit_period</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p13535152875415">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p853642817546">Specifies the rate limiting period.</p>
</td>
</tr>
<tr id="waf_02_0042__row65211529175417"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p115391228205410">lock_time</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p1254142865411">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p154452819543">Specifies the lock duration. The value ranges from <strong id="waf_02_0042__b4469437151015">0</strong> seconds to <strong id="waf_02_0042__b846973771011">2</strong><strong id="waf_02_0042__b16477193715107"><sup id="waf_02_0042__sup104771137131015">32</sup></strong> seconds.</p>
</td>
</tr>
<tr id="waf_02_0042__row2052110298543"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p654722885416">tag_type</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p554952835413">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p71571255171014">Specifies the rate limit mode.</p>
<ul id="waf_02_0042__ul555831610497"><li id="waf_02_0042__li12564151611492"><span class="parmvalue" id="waf_02_0042__parmvalue20113112417553"><b>ip</b></span>: A web visitor is identified by the IP address.</li><li id="waf_02_0042__li1577111613495"><span class="parmvalue" id="waf_02_0042__parmvalue797704317587"><b>cookie</b></span>: A web visitor is identified by the cookie key value.</li><li id="waf_02_0042__li250118018588"><span class="parmvalue" id="waf_02_0042__parmvalue9409202895518"><b>other</b></span>: A web visitor is identified by the Referer field (user-defined request source).</li></ul>
</td>
</tr>
<tr id="waf_02_0042__row1352142911542"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p1355482885412">tag_index</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p755522845411">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p16557142835414">If <span class="parmvalue" id="waf_02_0042__parmvalue940418231916"><b>tag_type</b></span> is set to <strong id="waf_02_0042__b144041523214">cookie</strong>, this parameter indicates cookie name.</p>
</td>
</tr>
<tr id="waf_02_0042__row2521192975413"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p195608285544">tag_condition</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p4562102810547"><a href="#waf_02_0042__table1897210413559">Table 4</a></p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p155661828165416">Specifies the <strong id="waf_02_0042__b1185818219215">Referer</strong> (customized request source) field. This field is returned when <span class="parmvalue" id="waf_02_0042__parmvalue118581429213"><b>tag_type</b></span> is set to <span class="parmvalue" id="waf_02_0042__parmvalue1185872172115"><b>other</b></span>.</p>
</td>
</tr>
<tr id="waf_02_0042__row4521229135413"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p25843288546">action</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p658672815413"><a href="#waf_02_0042__table3660351175718">Table 5</a></p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p11588142825415">Specifies the action taken when the number of requests reaches the upper limit.</p>
</td>
</tr>
<tr id="waf_02_0042__row14520182920540"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p463052825418">timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p1863182820543">Long</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p4632202885411">Specifies the time when a CC attack protection rule is added.</p>
</td>
</tr>
<tr id="waf_02_0042__row1331174518134"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0042__p13111845101314">default</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0042__p1311245121318">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0042__p153111545121310">Specifies whether the rule is the default CC attack protection rule.</p>
<ul id="waf_02_0042__ul1248751619599"><li id="waf_02_0042__li14489191675919"><strong id="waf_02_0042__b86402025123619">true</strong>: The rule is the default CC attack protection rule created by the system when creating a domain name.</li><li id="waf_02_0042__li24963163595"><strong id="waf_02_0042__b1248153224120">false</strong>: The rule is created by users.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="waf_02_0042__table1897210413559"></a><a name="table1897210413559"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0042__table1897210413559" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="waf_02_0042__b18148825112918">tag_condition</strong></caption><thead align="left"><tr id="waf_02_0042__row498264125512"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.4.2.4.1.1"><p id="waf_02_0042__p179858412553"><strong id="waf_02_0042__b12793177195613">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.4.2.4.1.2"><p id="waf_02_0042__p20987841105519"><strong id="waf_02_0042__b1409305331">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.4.2.4.1.3"><p id="waf_02_0042__p18992541175512"><strong id="waf_02_0042__b1651416917561">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0042__row316718559556"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0042__p129251153125517">category</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0042__p18928155325515">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0042__p169331053205518">Specifies the category. The value is <strong id="waf_02_0042__b128891959461">Referer</strong>.</p>
</td>
</tr>
<tr id="waf_02_0042__row816515556552"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0042__p159555533556">contents</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0042__p1895915385512">List</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0042__p29649538557">Specifies the category content. For example, <strong id="waf_02_0042__b1435138144117">http://www.</strong><em id="waf_02_0042__i11685154224119">xxx</em><strong id="waf_02_0042__b203331247194110">.com</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="waf_02_0042__table3660351175718"></a><a name="table3660351175718"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0042__table3660351175718" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="waf_02_0042__b127203814298">action</strong></caption><thead align="left"><tr id="waf_02_0042__row13670125155718"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.5.2.4.1.1"><p id="waf_02_0042__p166741051165714"><strong id="waf_02_0042__b15441388113">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.5.2.4.1.2"><p id="waf_02_0042__p1868015111574"><strong id="waf_02_0042__b113353359">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.5.2.4.1.3"><p id="waf_02_0042__p16684751165717"><strong id="waf_02_0042__b13264591562">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0042__row487919825816"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.5.2.4.1.1 "><p id="waf_02_0042__p9786157105816">category</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.5.2.4.1.2 "><p id="waf_02_0042__p0791171581">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.5.2.4.1.3 "><p id="waf_02_0042__p154031329171813">Specifies the action. The default value is <span class="parmvalue" id="waf_02_0042__parmvalue1419013502810"><b>block</b></span>.</p>
<ul id="waf_02_0042__ul661483971811"><li id="waf_02_0042__li13968134481819"><strong id="waf_02_0042__b2080181405715">block</strong>: block the requests.</li><li id="waf_02_0042__li0614153913187"><span class="parmvalue" id="waf_02_0042__parmvalue10306151065715"><b>captcha</b></span>: Verification code. The user needs to enter the correct verification code after blocking to restore the correct access page.</li></ul>
<p id="waf_02_0042__p2139345162813">The default value is <strong id="waf_02_0042__b842352706102157_1">block</strong>.</p>
</td>
</tr>
<tr id="waf_02_0042__row15877178135818"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.5.2.4.1.1 "><p id="waf_02_0042__p2799197175818">detail</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.5.2.4.1.2 "><p id="waf_02_0042__p178031872584"><a href="#waf_02_0042__table1060217107105">Table 6</a></p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.5.2.4.1.3 "><p id="waf_02_0042__p880513714586">Specifies the action details. If <strong id="waf_02_0042__b163751012194614">detail</strong> is <strong id="waf_02_0042__b143758126467">null</strong>, the default block page is displayed by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="waf_02_0042__table1060217107105"></a><a name="table1060217107105"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0042__table1060217107105" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="waf_02_0042__b0413105114298">detail</strong></caption><thead align="left"><tr id="waf_02_0042__row1861251018106"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.6.2.4.1.1"><p id="waf_02_0042__p14615101021017"><strong id="waf_02_0042__b126344184572">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.6.2.4.1.2"><p id="waf_02_0042__p2619141061016"><strong id="waf_02_0042__b1320075064">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.6.2.4.1.3"><p id="waf_02_0042__p10622171001012"><strong id="waf_02_0042__b1795352114576">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0042__row1142418101020"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0042__p159981716141015">response</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0042__p62517141010"><a href="#waf_02_0042__table671153413914">Table 7</a></p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0042__p651517191019">Specifies the returned page.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="waf_02_0042__table671153413914"></a><a name="table671153413914"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0042__table671153413914" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="waf_02_0042__b623104113015">response</strong></caption><thead align="left"><tr id="waf_02_0042__row87235341695"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.7.2.4.1.1"><p id="waf_02_0042__p117313341294"><strong id="waf_02_0042__b2775142818579">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.7.2.4.1.2"><p id="waf_02_0042__p107346349917"><strong id="waf_02_0042__b979329439">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.7.2.4.1.3"><p id="waf_02_0042__p773818346918"><strong id="waf_02_0042__b19673183018570">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0042__row46995451391"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.7.2.4.1.1 "><p id="waf_02_0042__p26435443911">content_type</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.7.2.4.1.2 "><p id="waf_02_0042__p76471144794">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.7.2.4.1.3 "><p id="waf_02_0042__p1265017441999">Specifies the type of the returned page.</p>
<p id="waf_02_0042__p6652244595">The options are <strong id="waf_02_0042__b3140104598">application/json</strong>, <strong id="waf_02_0042__b7121171313593">text/html</strong>, and <strong id="waf_02_0042__b193898189599">text/xml</strong>.</p>
</td>
</tr>
<tr id="waf_02_0042__row1669964520912"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.7.2.4.1.1 "><p id="waf_02_0042__p86555442914">content</p>
</td>
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.7.2.4.1.2 "><p id="waf_02_0042__p1365811441899">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.7.2.4.1.3 "><p id="waf_02_0042__p186601448918">Specifies the content of the returned page.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="waf_02_0042__section23104218489"><h4 class="sectiontitle">Example</h4><p id="waf_02_0042__p469211481117"><strong id="waf_02_0042__b84322334620">total</strong> with a value of <strong id="waf_02_0042__b545102334618">2</strong> is used as an example.</p>
<div class="p" id="waf_02_0042__p7184101034815">Response example<pre class="screen" id="waf_02_0042__screen433411284810">{
"total": 2,
"items": [{
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
"policy_id": "9tre832yf96784ec8abd8ba61a98064ef",
"path": "/abc1",
"limit_num": 10,
"limit_period": 60,
"lock_time": 10,
"tag_type": "cookie",
"tag_index": "sesssionid",
"action": {
"category": "block",
"detail": {
"response": {
"content_type": "application/json",
"content": "{\"error\":\"forbidden\"}"
}
}
},
"timestamp": 1499817600,
"default": true
}, {
"id": "3d7bea768b10480984f98c6b69d43d0f",
"policy_id": "9tre832yf96784ec8abd8ba61a98064ef",
"path": "/efgh",
"limit_num": 10,
"limit_period": 60,
"lock_time": 5,
"tag_type": "other",
"tag_condition":{
"category": "referer",
"contents": ["http://www.example.com"]
}
"action": {
"category": "block",
},
"timestamp": 1499817600,
"default": true
}
]
}</pre>
</div>
</div>
<div class="section" id="waf_02_0042__section5202971"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0042__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0042__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 8</a> describes the normal status code returned by the API.
<div class="tablenoborder"><a name="waf_02_0042__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0042__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Status code</caption><thead align="left"><tr id="waf_02_0042__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_0042__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_0042__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_0042__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0042__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_0042__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_0042__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_0042__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="waf_02_0042__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_0041.html">CC Attack Protection Rules</a></div>
</div>
</div>
View Git Blame Copy Permalink