forked from docs/doc-exports
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: qinweiwei <qinweiwei@huawei.com> Co-committed-by: qinweiwei <qinweiwei@huawei.com>
567 lines
49 KiB
HTML
567 lines
49 KiB
HTML
<a name="CreateIgnoreRule"></a><a name="CreateIgnoreRule"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Global Protection Whitelist (Formerly False Alarm Masking) Rule</h1>
|
|
<div id="body1708331107508"><div class="section" id="CreateIgnoreRule__topic1591000000"><h4 class="sectiontitle">Function</h4><p id="CreateIgnoreRule__topic1591000002">This API is used to create a global protection whitelist (formerly false alarm masking) rule.</p>
|
|
</div>
|
|
<div class="section" id="CreateIgnoreRule__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="CreateIgnoreRule__topic1591000004">POST /v1/{project_id}/waf/policy/{policy_id}/ignore</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__topic1591000005" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateIgnoreRule__topic1591000015">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateIgnoreRule__topic1591000017">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateIgnoreRule__topic1591000019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateIgnoreRule__topic1591000021">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000023"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000025">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000027">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000029">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000031">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000032"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000034">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000036">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000038">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000040">Policy ID. It can be obtained by calling the <strong id="CreateIgnoreRule__topic1591000041">ListPolicy</strong> API.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateIgnoreRule__topic1591000042"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000051"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateIgnoreRule__topic1591000053">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateIgnoreRule__topic1591000055">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateIgnoreRule__topic1591000057">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateIgnoreRule__topic1591000059">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000061"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000063">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000065">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000067">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000069">User token</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000070"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000072">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000074">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000076">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000078">Content type</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__request_CreateIgnoreRuleRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000086"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateIgnoreRule__topic1591000088">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateIgnoreRule__topic1591000090">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateIgnoreRule__topic1591000092">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateIgnoreRule__topic1591000094">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000098">domain</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000100">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000102">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000104">Domain names to be protected. If the array length is <strong id="CreateIgnoreRule__topic1591000105">0</strong>, this rule will take effect for all domain names that are protected by the policies this rule belongs to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000106"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000108">conditions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000110">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000112">Array of <a href="#CreateIgnoreRule__request_CreateCondition">CreateCondition</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000115">Condition list</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000118">mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000120">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000122">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000124">The value is fixed at <strong id="CreateIgnoreRule__topic1591000125">1 </strong>, indicating v2 false alarm masking rules. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000126"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000128">rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000130">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000132">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000134">Items to be masked. You can provide multiple items and separate them with semicolons (;).</p>
|
|
<ul id="CreateIgnoreRule__topic1591000135"><li id="CreateIgnoreRule__topic1591000136"><p id="CreateIgnoreRule__topic1591000137"><a name="CreateIgnoreRule__topic1591000136"></a><a name="topic1591000136"></a>If you want to disable a specific built-in rule for a domain name, the value of this parameter is the rule ID. When requests are blocked against a certain built-in rule while you do not want this rule to block requests later, you can query the rule in the <strong id="CreateIgnoreRule__topic1591000138">Events</strong> page on the console and find its rule ID in the <strong id="CreateIgnoreRule__topic1591000139">Hit Rule</strong> column. Then, you can disk the rule by its ID (including 6 digits).</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000140"><p id="CreateIgnoreRule__topic1591000141"><a name="CreateIgnoreRule__topic1591000140"></a><a name="topic1591000140"></a>If you want to mask a type of basic web protection rules, set this parameter to the name of the type of basic web protection rules. <strong id="CreateIgnoreRule__topic1591000142">xss</strong>: XSS attacks</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000143"><p id="CreateIgnoreRule__topic1591000144"><a name="CreateIgnoreRule__topic1591000143"></a><a name="topic1591000143"></a>To bypass the basic web protection, set this parameter to <strong id="CreateIgnoreRule__topic1591000145">all</strong>.</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000146"><p id="CreateIgnoreRule__topic1591000147"><a name="CreateIgnoreRule__topic1591000146"></a><a name="topic1591000146"></a>To bypass all WAF protection, set this parameter to <strong id="CreateIgnoreRule__topic1591000148">bypass</strong>.</p>
|
|
</li></ul>
|
|
<p id="CreateIgnoreRule__topic1591000149"><strong id="CreateIgnoreRule__topic1591000150">webshell</strong>: Web shells</p>
|
|
<p id="CreateIgnoreRule__topic1591000151"><strong id="CreateIgnoreRule__topic1591000152">vuln</strong>: Other types of attacks</p>
|
|
<p id="CreateIgnoreRule__topic1591000153"><strong id="CreateIgnoreRule__topic1591000154">sqli</strong>: SQL injection attack</p>
|
|
<p id="CreateIgnoreRule__topic1591000155"><strong id="CreateIgnoreRule__topic1591000156">robot</strong>: Malicious crawlers</p>
|
|
<p id="CreateIgnoreRule__topic1591000157"><strong id="CreateIgnoreRule__topic1591000158">rfi</strong>: Remote file inclusion</p>
|
|
<p id="CreateIgnoreRule__topic1591000159"><strong id="CreateIgnoreRule__topic1591000160">lfi</strong>: Local file inclusion</p>
|
|
<p id="CreateIgnoreRule__topic1591000161"><strong id="CreateIgnoreRule__topic1591000162">cmdi</strong>: Command injection attack</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000163"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000165">advanced</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000167">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000169">Array of <a href="#CreateIgnoreRule__request_Advanced">Advanced</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000172">To ignore attacks of a specific field, specify the field in the Advanced settings area. After you add the rule, WAF will stop blocking attacks of the specified field. This parameter is not included if all modules are bypassed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000175">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000177">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000179">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000181">Description of the rule</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateIgnoreRule__request_CreateCondition"></a><a name="request_CreateCondition"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__request_CreateCondition" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CreateCondition</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000189"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateIgnoreRule__topic1591000191">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateIgnoreRule__topic1591000193">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateIgnoreRule__topic1591000195">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateIgnoreRule__topic1591000197">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000199"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000201">category</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000203">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000205">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000207">Field type. The value can be <strong id="CreateIgnoreRule__topic1591000208">url</strong>, <strong id="CreateIgnoreRule__topic1591000209">ip</strong>, <strong id="CreateIgnoreRule__topic1591000210">params</strong>, <strong id="CreateIgnoreRule__topic1591000211">cookie</strong>, or <strong id="CreateIgnoreRule__topic1591000212">header</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000215">contents</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000217">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000219">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000221">Content. The array length is limited to <strong id="CreateIgnoreRule__topic1591000222">1</strong>. The content format varies depending on the field type. For example, if the field type is <strong id="CreateIgnoreRule__topic1591000223">ip</strong>, the value must be an IP address or IP address range. If the field type is <strong id="CreateIgnoreRule__topic1591000224">url</strong>, the value must be in the standard URL format. IF the field type is <strong id="CreateIgnoreRule__topic1591000225">params</strong>, <strong id="CreateIgnoreRule__topic1591000226">cookie</strong>, or <strong id="CreateIgnoreRule__topic1591000227">header</strong>, the content format is not limited.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000230">logic_operation</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000232">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000234">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000236">The matching logic varies depending on the field type. For example, if the field type is <strong id="CreateIgnoreRule__topic1591000237">ip</strong>, the logic can be <strong id="CreateIgnoreRule__topic1591000238">equal</strong> or <strong id="CreateIgnoreRule__topic1591000239">not_equal</strong>. If the field type is <strong id="CreateIgnoreRule__topic1591000240">url</strong>, <strong id="CreateIgnoreRule__topic1591000241">params</strong>, <strong id="CreateIgnoreRule__topic1591000242">cookie</strong>, or <strong id="CreateIgnoreRule__topic1591000243">header</strong>, the logic can be <strong id="CreateIgnoreRule__topic1591000244">equal</strong>, <strong id="CreateIgnoreRule__topic1591000245">not_equal</strong>, <strong id="CreateIgnoreRule__topic1591000246">contain</strong>, <strong id="CreateIgnoreRule__topic1591000247">not_contain</strong>, <strong id="CreateIgnoreRule__topic1591000248">prefix</strong>, <strong id="CreateIgnoreRule__topic1591000249">not_prefix</strong>, <strong id="CreateIgnoreRule__topic1591000250">suffix</strong>, <strong id="CreateIgnoreRule__topic1591000251">not_suffix</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000252"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000254">index</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000256">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000258">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000260">If the field type is <strong id="CreateIgnoreRule__topic1591000261">ip</strong> and the subfield is the client IP address, the <strong id="CreateIgnoreRule__topic1591000262">index</strong> parameter is not required. If the subfield type is <strong id="CreateIgnoreRule__topic1591000263">X-Forwarded-For</strong>, the value is <strong id="CreateIgnoreRule__topic1591000264">x-forwarded-for</strong>; If the field type is <strong id="CreateIgnoreRule__topic1591000265">params</strong>, <strong id="CreateIgnoreRule__topic1591000266">header</strong>, or <strong id="CreateIgnoreRule__topic1591000267">cookie</strong>, and the subfield is user-defined, the value of <strong id="CreateIgnoreRule__topic1591000268">index</strong> is the user-defined subfield.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateIgnoreRule__request_Advanced"></a><a name="request_Advanced"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__request_Advanced" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Advanced</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000276"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="CreateIgnoreRule__topic1591000278">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="CreateIgnoreRule__topic1591000280">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="CreateIgnoreRule__topic1591000282">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="CreateIgnoreRule__topic1591000284">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000288">index</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000290">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000292">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000294">Field type. The following field types are supported: Params, Cookie, Header, Body, and Multipart.</p>
|
|
<ul id="CreateIgnoreRule__topic1591000295"><li id="CreateIgnoreRule__topic1591000296"><p id="CreateIgnoreRule__topic1591000297"><a name="CreateIgnoreRule__topic1591000296"></a><a name="topic1591000296"></a>When you select <strong id="CreateIgnoreRule__topic1591000298">Params</strong>, <strong id="CreateIgnoreRule__topic1591000299">Cookie</strong>, or <strong id="CreateIgnoreRule__topic1591000300">Header</strong>, you can set this parameter to <strong id="CreateIgnoreRule__topic1591000301">all</strong> or configure subfields as required.</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000302"><p id="CreateIgnoreRule__topic1591000303"><a name="CreateIgnoreRule__topic1591000302"></a><a name="topic1591000302"></a>When you select <strong id="CreateIgnoreRule__topic1591000304">Body</strong> or <strong id="CreateIgnoreRule__topic1591000305">Multipart</strong>, set this parameter to <strong id="CreateIgnoreRule__topic1591000306">all</strong>.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000307"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateIgnoreRule__topic1591000309">contents</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateIgnoreRule__topic1591000311">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateIgnoreRule__topic1591000313">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateIgnoreRule__topic1591000315">Subfield of the specified field type. The default value is <strong id="CreateIgnoreRule__topic1591000316">all</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateIgnoreRule__topic1591000317"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateIgnoreRule__topic1591000319"><strong id="CreateIgnoreRule__topic1591000320">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__response_CreateIgnoreRuleResponseBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000327"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateIgnoreRule__topic1591000329">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateIgnoreRule__topic1591000331">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateIgnoreRule__topic1591000333">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000335"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000337">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000341">Rule ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000342"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000344">policyid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000346">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000348">Policy ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000349"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000351">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000353">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000355">Timestamp the rule was created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000358">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000360">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000362">Rule Description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000363"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000365">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000367">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000369">Rule status. The value can be <strong id="CreateIgnoreRule__topic1591000370">0</strong> or <strong id="CreateIgnoreRule__topic1591000371">1</strong>.</p>
|
|
<ul id="CreateIgnoreRule__topic1591000372"><li id="CreateIgnoreRule__topic1591000373"><p id="CreateIgnoreRule__topic1591000374"><a name="CreateIgnoreRule__topic1591000373"></a><a name="topic1591000373"></a><strong id="CreateIgnoreRule__topic1591000375">0</strong>: The rule is disabled.</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000376"><p id="CreateIgnoreRule__topic1591000377"><a name="CreateIgnoreRule__topic1591000376"></a><a name="topic1591000376"></a><strong id="CreateIgnoreRule__topic1591000378">1</strong>: The rule is enabled.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000379"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000381">rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000383">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000385">Items to be masked. You can provide multiple items and separate them with semicolons (;).</p>
|
|
<ul id="CreateIgnoreRule__topic1591000386"><li id="CreateIgnoreRule__topic1591000387"><p id="CreateIgnoreRule__topic1591000388"><a name="CreateIgnoreRule__topic1591000387"></a><a name="topic1591000387"></a>If you want to disable a specific built-in rule for a domain name, the value of this parameter is the rule ID. When requests are blocked against a certain built-in rule while you do not want this rule to block requests later, you can query the rule in the <strong id="CreateIgnoreRule__topic1591000389">Events</strong> page on the console and find its rule ID in the <strong id="CreateIgnoreRule__topic1591000390">Hit Rule</strong> column. Then, you can disk the rule by its ID (including 6 digits).</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000391"><p id="CreateIgnoreRule__topic1591000392"><a name="CreateIgnoreRule__topic1591000391"></a><a name="topic1591000391"></a>If you want to mask a type of basic web protection rules, set this parameter to the name of the type of basic web protection rules. <strong id="CreateIgnoreRule__topic1591000393">xss</strong>: XSS attacks</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000394"><p id="CreateIgnoreRule__topic1591000395"><a name="CreateIgnoreRule__topic1591000394"></a><a name="topic1591000394"></a>To bypass the basic web protection, set this parameter to <strong id="CreateIgnoreRule__topic1591000396">all</strong>.</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000397"><p id="CreateIgnoreRule__topic1591000398"><a name="CreateIgnoreRule__topic1591000397"></a><a name="topic1591000397"></a>To bypass all WAF protection, set this parameter to <strong id="CreateIgnoreRule__topic1591000399">bypass</strong>.</p>
|
|
</li></ul>
|
|
<p id="CreateIgnoreRule__topic1591000400"><strong id="CreateIgnoreRule__topic1591000401">webshell</strong>: Web shells</p>
|
|
<p id="CreateIgnoreRule__topic1591000402"><strong id="CreateIgnoreRule__topic1591000403">vuln</strong>: Other types of attacks</p>
|
|
<p id="CreateIgnoreRule__topic1591000404"><strong id="CreateIgnoreRule__topic1591000405">sqli</strong>: SQL injection attack</p>
|
|
<p id="CreateIgnoreRule__topic1591000406"><strong id="CreateIgnoreRule__topic1591000407">robot</strong>: Malicious crawlers</p>
|
|
<p id="CreateIgnoreRule__topic1591000408"><strong id="CreateIgnoreRule__topic1591000409">rfi</strong>: Remote file inclusion</p>
|
|
<p id="CreateIgnoreRule__topic1591000410"><strong id="CreateIgnoreRule__topic1591000411">lfi</strong>: Local file inclusion</p>
|
|
<p id="CreateIgnoreRule__topic1591000412"><strong id="CreateIgnoreRule__topic1591000413">cmdi</strong>: Command injection attack</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000416">mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000418">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000420">The value is fixed at <strong id="CreateIgnoreRule__topic1591000421">1</strong>, indicating v2 false alarm masking rules are used.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000422"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000424">conditions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000426">Array of <a href="#CreateIgnoreRule__response_Condition">Condition</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000429">Condition list</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000430"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000432">advanced</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000434">Array of <a href="#CreateIgnoreRule__response_Advanced">Advanced</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000437">Advanced settings</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000438"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000440">domain</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000442">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000444">Domain names to be protected. If the array length is <strong id="CreateIgnoreRule__topic1591000445">0</strong>, this rule will take effect for all domain names that are protected by the policies this rule belongs to.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateIgnoreRule__response_Condition"></a><a name="response_Condition"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__response_Condition" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Condition</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000452"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="CreateIgnoreRule__topic1591000454">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="CreateIgnoreRule__topic1591000456">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="CreateIgnoreRule__topic1591000458">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000460"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000462">category</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000464">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000466">Field type. The value can be <strong id="CreateIgnoreRule__topic1591000467">ip</strong>, <strong id="CreateIgnoreRule__topic1591000468">url</strong>, <strong id="CreateIgnoreRule__topic1591000469">params</strong>, <strong id="CreateIgnoreRule__topic1591000470">cookie</strong>, or <strong id="CreateIgnoreRule__topic1591000471">header</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000472"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000474">contents</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000476">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000478">Content. The array length must be 1. The content format varies depending on field types. For example, if the field type is ip, the value must be an IP address or IP address range. If the field type is url, the value must be a URL in standard format. If the field type is params, cookie, or header, the content format is not limited.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000479"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000481">logic_operation</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000485">The matching logic varies depending on the field type. For example, if the field type is <strong id="CreateIgnoreRule__topic1591000486">ip</strong>, the logic can be <strong id="CreateIgnoreRule__topic1591000487">equal</strong> or <strong id="CreateIgnoreRule__topic1591000488">not_equal</strong>. If the field type is <strong id="CreateIgnoreRule__topic1591000489">url</strong>, <strong id="CreateIgnoreRule__topic1591000490">params</strong>, <strong id="CreateIgnoreRule__topic1591000491">cookie</strong>, or <strong id="CreateIgnoreRule__topic1591000492">header</strong>, the logic can be <strong id="CreateIgnoreRule__topic1591000493">equal</strong>, <strong id="CreateIgnoreRule__topic1591000494">not_equal</strong>, <strong id="CreateIgnoreRule__topic1591000495">contain</strong>, <strong id="CreateIgnoreRule__topic1591000496">not_contain</strong>, <strong id="CreateIgnoreRule__topic1591000497">prefix</strong>, <strong id="CreateIgnoreRule__topic1591000498">not_prefix</strong>, <strong id="CreateIgnoreRule__topic1591000499">suffix</strong>, <strong id="CreateIgnoreRule__topic1591000500">not_suffix</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000501"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000503">check_all_indexes_logic</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000505">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000507">This parameter is reserved and can be ignored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000508"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000510">index</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000514">If the field type is <strong id="CreateIgnoreRule__topic1591000515">ip</strong> and the subfield is the client IP address, the <strong id="CreateIgnoreRule__topic1591000516">index</strong> parameter does not exist. If the subfield type is <strong id="CreateIgnoreRule__topic1591000517">X-Forwarded-For</strong>, the value is <strong id="CreateIgnoreRule__topic1591000518">x-forwarded-for</strong>. If the field type is <strong id="CreateIgnoreRule__topic1591000519">params</strong>, <strong id="CreateIgnoreRule__topic1591000520">header</strong>, or <strong id="CreateIgnoreRule__topic1591000521">cookie</strong>, and the subfield is user-defined, the value of <strong id="CreateIgnoreRule__topic1591000522">index</strong> is the user-defined subfield.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateIgnoreRule__response_Advanced"></a><a name="response_Advanced"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__response_Advanced" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Advanced</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000529"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="CreateIgnoreRule__topic1591000531">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="CreateIgnoreRule__topic1591000533">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="CreateIgnoreRule__topic1591000535">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000537"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000539">index</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000543">Field type. The following field types are supported: Params, Cookie, Header, Body, and Multipart.</p>
|
|
<ul id="CreateIgnoreRule__topic1591000544"><li id="CreateIgnoreRule__topic1591000545"><p id="CreateIgnoreRule__topic1591000546"><a name="CreateIgnoreRule__topic1591000545"></a><a name="topic1591000545"></a>When you select <strong id="CreateIgnoreRule__topic1591000547">Params</strong>, <strong id="CreateIgnoreRule__topic1591000548">Cookie</strong>, or <strong id="CreateIgnoreRule__topic1591000549">Header</strong>, you can set this parameter to <strong id="CreateIgnoreRule__topic1591000550">all</strong> or configure subfields as required.</p>
|
|
</li><li id="CreateIgnoreRule__topic1591000551"><p id="CreateIgnoreRule__topic1591000552"><a name="CreateIgnoreRule__topic1591000551"></a><a name="topic1591000551"></a>When you select <strong id="CreateIgnoreRule__topic1591000553">Body</strong> or <strong id="CreateIgnoreRule__topic1591000554">Multipart</strong>, set this parameter to <strong id="CreateIgnoreRule__topic1591000555">all</strong>.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000556"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000558">contents</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000560">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000562">Subfield of the specified field type. The default value is <strong id="CreateIgnoreRule__topic1591000563">all</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateIgnoreRule__topic1591000564"><strong id="CreateIgnoreRule__topic1591000565">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__response_RestErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000572"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="CreateIgnoreRule__topic1591000574">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="CreateIgnoreRule__topic1591000576">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="CreateIgnoreRule__topic1591000578">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000580"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000582">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000584">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000586">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000587"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000589">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000591">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000593">Error message</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateIgnoreRule__topic1591000594"><strong id="CreateIgnoreRule__topic1591000595">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__response_RestErrorResponse_1" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000602"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="CreateIgnoreRule__topic1591000604">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="CreateIgnoreRule__topic1591000606">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="CreateIgnoreRule__topic1591000608">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000610"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000612">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000616">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000619">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000621">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000623">Error message</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateIgnoreRule__topic1591000624"><strong id="CreateIgnoreRule__topic1591000625">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__response_RestErrorResponse_2" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="CreateIgnoreRule__topic1591000632"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.1"><p id="CreateIgnoreRule__topic1591000634">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.2"><p id="CreateIgnoreRule__topic1591000636">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.11.2.4.1.3"><p id="CreateIgnoreRule__topic1591000638">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000640"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000642">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000644">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000646">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000647"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateIgnoreRule__topic1591000649">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateIgnoreRule__topic1591000651">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateIgnoreRule__topic1591000653">Error message</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateIgnoreRule__topic1591000654"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="CreateIgnoreRule__topic1591000656">POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?
|
|
|
|
{
|
|
"domain" : [ "www.example.com" ],
|
|
"mode" : 1,
|
|
"description" : "",
|
|
"conditions" : [ {
|
|
"category" : "ip",
|
|
"logic_operation" : "equal",
|
|
"index" : null,
|
|
"contents" : [ "x.x.x.x" ]
|
|
} ],
|
|
"rule" : "091004"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateIgnoreRule__topic1591000657"><h4 class="sectiontitle">Example Responses</h4><p id="CreateIgnoreRule__topic1591000659"><strong id="CreateIgnoreRule__topic1591000660">Status code: 200</strong></p>
|
|
<p id="CreateIgnoreRule__topic1591000661">Request succeeded.</p>
|
|
<pre class="screen" id="CreateIgnoreRule__topic1591000662">{
|
|
"id" : "40484384970948d79fffe4e4ae1fc54d",
|
|
"policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
|
|
"timestamp" : 1650512535222,
|
|
"description" : "demo",
|
|
"status" : 1,
|
|
"rule" : "091004",
|
|
"mode" : 1,
|
|
"conditions" : [ {
|
|
"category" : "ip",
|
|
"contents" : [ "x.x.x.x" ],
|
|
"logic_operation" : "equal"
|
|
} ],
|
|
"domain" : [ "www.example.com" ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateIgnoreRule__topic1591000663"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateIgnoreRule__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateIgnoreRule__topic1591000669"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateIgnoreRule__topic1591000671">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateIgnoreRule__topic1591000673">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateIgnoreRule__topic1591000675"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateIgnoreRule__topic1591000677">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateIgnoreRule__topic1591000679">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000680"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateIgnoreRule__topic1591000682">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateIgnoreRule__topic1591000684">Request failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000685"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateIgnoreRule__topic1591000687">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateIgnoreRule__topic1591000689">The token does not have required permissions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateIgnoreRule__topic1591000690"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateIgnoreRule__topic1591000692">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateIgnoreRule__topic1591000694">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateIgnoreRule__topic1591000695"><h4 class="sectiontitle">Error Codes</h4><p id="CreateIgnoreRule__topic1591000697">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Rule Management</a></div>
|
|
</div>
|
|
</div>
|
|
|