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_0063"></a><a name="waf_02_0063"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Web Tamper Protection Rule</h1>
|
|
<div id="body47706178"><div class="section" id="waf_02_0063__section30135943"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0063__p38995172">This API is used to query details about a web tamper protection rule.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0063__section2788037"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0063__ul4492379"><li id="waf_02_0063__li40431418">URI format<p id="waf_02_0063__p28338447"><a name="waf_02_0063__li40431418"></a><a name="li40431418"></a>GET /v1/{project_id}/waf/policy/{policy_id}/antitamper/{antitamper_rule_id}</p>
|
|
</li><li id="waf_02_0063__li53719435">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0063__table13712871" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0063__row62900404"><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_0063__p61767935"><strong id="waf_02_0063__b146175212588">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_0063__p37146843"><strong id="waf_02_0063__b122896619582">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_0063__p56104303"><strong id="waf_02_0063__b6741149165816">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_0063__p48154724"><strong id="waf_02_0063__b10558711185812">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0063__row8218594"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0063__p61726352">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_0063__p33778582">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_0063__p51710621">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_0063__p27810764">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0063__row48970291"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0063__p7170610">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_0063__p43948526">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_0063__p3060814">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_0063__p46599354">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0063__row16741009"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0063__p13844475">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_0063__p47660710">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_0063__p35312314">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_0063__p41725149">Specifies the ID of a web tamper protection rule.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0063__section25092333"><h4 class="sectiontitle">Request</h4><p id="waf_02_0063__p197331481154">Request parameters</p>
|
|
<p class="msonormal" id="waf_02_0063__p24293946">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0063__section24504410"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0063__p126182186520">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0063__table9030076" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0063__row65221839"><th align="left" class="cellrowborder" valign="top" width="24.467553244675532%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0063__p48477639"><strong id="waf_02_0063__b1648184519581">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="35.736426357364266%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0063__p34374671"><strong id="waf_02_0063__b19648144745810">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_0063__p32884943"><strong id="waf_02_0063__b9134105417581">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0063__row27529036"><td class="cellrowborder" valign="top" width="24.467553244675532%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0063__p15259444">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.736426357364266%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0063__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_0063__p57900178">Specifies the ID of a web tamper protection rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0063__row51339558"><td class="cellrowborder" valign="top" width="24.467553244675532%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0063__p64863513">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.736426357364266%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0063__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_0063__p32203104">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0063__row21392484"><td class="cellrowborder" valign="top" width="24.467553244675532%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0063__p55069611">hostname</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.736426357364266%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0063__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_0063__p64707792">Specifies the domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0063__row45499221"><td class="cellrowborder" valign="top" width="24.467553244675532%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0063__p61558251">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.736426357364266%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0063__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_0063__p22544449">Specifies the URL protected by the web tamper protection rule, excluding a domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0063__row1573456"><td class="cellrowborder" valign="top" width="24.467553244675532%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0063__p60341087">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.736426357364266%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0063__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_0063__p12128762">Specifies the time when the cache is refreshed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0063__section15436112218515"><h4 class="sectiontitle">Example</h4><p id="waf_02_0063__p152101421115711">Rule ID <strong id="waf_02_0063__b1574152210532">3a9b5c0f96784ec8abd8ba61a98064ef</strong> is used as an example.</p>
|
|
<div class="p" id="waf_02_0063__p11731127555">Response example<pre class="screen" id="waf_02_0063__screen16450422951">{
|
|
"id": "3a9b5c0f96784ec8abd8ba61a98064ef",
|
|
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
|
|
"hostname": "www.aaa.com",
|
|
"path": "/a",
|
|
"timestamp": 1499817600
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0063__section19213099"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0063__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0063__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 3</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0063__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0063__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_0063__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_0063__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_0063__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_0063__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0063__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_0063__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_0063__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_0063__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0063__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>
|
|
|