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>
141 lines
10 KiB
HTML
141 lines
10 KiB
HTML
<a name="waf_02_0064"></a><a name="waf_02_0064"></a>
|
|
|
|
<h1 class="topictitle1">Refreshing the Web Tamper Protection Rule Cache</h1>
|
|
<div id="body28083180"><div class="section" id="waf_02_0064__section13997563"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0064__p60145139">This API is used to refresh cache in a web tamper protection rule in the event of changes on the protected webpage.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0064__section58869205"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0064__ul39918053"><li id="waf_02_0064__li23718163">URI format<p id="waf_02_0064__p12136876"><a name="waf_02_0064__li23718163"></a><a name="li23718163"></a>POST /v1/{project_id}/waf/policy/{policy_id}/antitamper/{antitamper_rule_id}/cache</p>
|
|
</li><li id="waf_02_0064__li42123027">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0064__table43562928" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0064__row65864810"><th align="left" class="cellrowborder" valign="top" width="30.930000000000003%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0064__p33449373"><strong id="waf_02_0064__b729451910111">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0064__p25044664"><strong id="waf_02_0064__b7382172418111">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.430000000000001%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0064__p15351908"><strong id="waf_02_0064__b1284116259110">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.02%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0064__p35545032"><strong id="waf_02_0064__b5310027817">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0064__row60575373"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0064__p7658203">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0064__p16334681">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0064__p48040751">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0064__p66095622">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0064__row57989689"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0064__p66653236">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0064__p30203011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0064__p30524815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0064__p56590911">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0064__row39556152"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0064__p49931738">antitamper_rule_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0064__p17938964">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0064__p43769999">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0064__p55709043">Specifies the ID of a web tamper protection rule.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0064__section60060800"><h4 class="sectiontitle">Request</h4><p id="waf_02_0064__p189647213620">Request parameters</p>
|
|
<p class="msonormal" id="waf_02_0064__p16138598">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0064__section3676294"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0064__p102916121760">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0064__table9030076" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0064__row65221839"><th align="left" class="cellrowborder" valign="top" width="30.15698430156984%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0064__p48477639"><strong id="waf_02_0064__b14580102843416">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.046995300469952%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0064__p34374671"><strong id="waf_02_0064__b58841029143420">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0064__p32884943"><strong id="waf_02_0064__b1814903115344">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0064__row27529036"><td class="cellrowborder" valign="top" width="30.15698430156984%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0064__p15259444">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.046995300469952%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0064__p28055465">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0064__p57900178">Specifies the ID of a web tamper protection rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0064__row51339558"><td class="cellrowborder" valign="top" width="30.15698430156984%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0064__p64863513">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.046995300469952%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0064__p19453172">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0064__p32203104">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0064__row21392484"><td class="cellrowborder" valign="top" width="30.15698430156984%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0064__p55069611">hostname</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.046995300469952%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0064__p31453527">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0064__p64707792">Specifies the domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0064__row45499221"><td class="cellrowborder" valign="top" width="30.15698430156984%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0064__p61558251">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.046995300469952%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0064__p20162434">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0064__p22544449">Specifies the URL protected by the web tamper protection rule, excluding a domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0064__row1573456"><td class="cellrowborder" valign="top" width="30.15698430156984%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0064__p60341087">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.046995300469952%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0064__p55789867">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0064__p22685339">Specifies the time when the cache is refreshed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0064__section19676101712612"><h4 class="sectiontitle">Example</h4><p id="waf_02_0064__p1198948195715"></p>
|
|
<div class="p" id="waf_02_0064__p2544122112619">Response example<pre class="screen" id="waf_02_0064__screen126828178619">{
|
|
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
|
|
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
|
|
"hostname": "www.aaa.com",
|
|
"path": "/a",
|
|
"timestamp": 1499817600
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0064__section33086646"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0064__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0064__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 3</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0064__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0064__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="waf_02_0064__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_0064__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_0064__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_0064__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0064__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_0064__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_0064__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_0064__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0064__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_0059.html">Web Tamper Protection Rules</a></div>
|
|
</div>
|
|
</div>
|
|
|