doc-exports/docs/waf/api-ref/waf_02_0080.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

215 lines
16 KiB
HTML

<a name="waf_02_0080"></a><a name="waf_02_0080"></a>
<h1 class="topictitle1">Querying Event Type in Alarm Notifications</h1>
<div id="body54315535"><div class="section" id="waf_02_0080__section2348991"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0080__p37482227">This API is used to query event type in an alarm notification.</p>
</div>
<div class="section" id="waf_02_0080__section21140920"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0080__ul16161510"><li id="waf_02_0080__li11235870">URI format<p id="waf_02_0080__p34013971"><a name="waf_02_0080__li11235870"></a><a name="li11235870"></a>GET /v1/{project_id}/waf/map/threat?lang={lang}</p>
</li><li id="waf_02_0080__li37690286">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0080__table3668256" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0080__row13281129"><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_0080__p2029696"><strong id="waf_02_0080__b14401121281618">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_0080__p30187650"><strong id="waf_02_0080__b1619251414161">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_0080__p29280601"><strong id="waf_02_0080__b11227316111615">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_0080__p22918509"><strong id="waf_02_0080__b5522171791617">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0080__row44459941"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0080__p44485482">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_0080__p46554275">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_0080__p12799929">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_0080__p30161299">Specifies the project ID.</p>
</td>
</tr>
<tr id="waf_02_0080__row3016237"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0080__p42988649">lang</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_0080__p59528541">No</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_0080__p57082546">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_0080__p60283536">Specifies the language configuration. The options are <strong id="waf_02_0080__b4580838911">zh-cn</strong> and <strong id="waf_02_0080__b75801338616">en-us</strong>. The default value is <strong id="waf_02_0080__b19580123817116">en-us</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="waf_02_0080__section56050555"><h4 class="sectiontitle">Request</h4><p id="waf_02_0080__p137906108914">Request parameters</p>
<p class="msonormal" id="waf_02_0080__p51128222">None</p>
</div>
<div class="section" id="waf_02_0080__section34692954"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0080__p125267214916">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0080__table42162795" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0080__row59545267"><th align="left" class="cellrowborder" valign="top" width="36.20637936206379%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0080__p58437292"><strong id="waf_02_0080__b1255515015179">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.997600239976002%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0080__p35800173"><strong id="waf_02_0080__b12630175">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_0080__p14132895"><strong id="waf_02_0080__b94036314175">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0080__row60087193"><td class="cellrowborder" valign="top" width="36.20637936206379%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0080__p35224503">threats</p>
</td>
<td class="cellrowborder" valign="top" width="23.997600239976002%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0080__p34612505">List</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0080__p52149544">Specifies the list of event types.</p>
</td>
</tr>
<tr id="waf_02_0080__row66692715"><td class="cellrowborder" valign="top" width="36.20637936206379%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0080__p33400872">locale</p>
</td>
<td class="cellrowborder" valign="top" width="23.997600239976002%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0080__p21116101"><a href="#waf_02_0080__table10363184164611">Table 3</a></p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0080__p32682602">Specifies event names.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="waf_02_0080__table10363184164611"></a><a name="table10363184164611"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0080__table10363184164611" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="waf_02_0080__b8198163493614">locale</strong></caption><thead align="left"><tr id="waf_02_0080__row153652046460"><th align="left" class="cellrowborder" valign="top" width="36.236376362363764%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0080__p136610484618"><strong id="waf_02_0080__b4167162875017">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.967603239676034%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0080__p1136784104617"><strong id="waf_02_0080__b328095578">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0080__p43671345468"><strong id="waf_02_0080__b985514337500">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0080__row1499039124610"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p71417914468">xss</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p14141696468">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p6159944612">Specifies XSS attack.</p>
</td>
</tr>
<tr id="waf_02_0080__row999018918466"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p111729124610">sqli</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p17176918462">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p91810920462">Specifies SQL injection.</p>
</td>
</tr>
<tr id="waf_02_0080__row99909994619"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p19209954613">cmdi</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p14211799464">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p72219934613">Specifies command injection.</p>
</td>
</tr>
<tr id="waf_02_0080__row10786142191711"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p27865426177">cc</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p97861342161715">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p578634271720">Specifies CC attack.</p>
</td>
</tr>
<tr id="waf_02_0080__row121151047101711"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p1632464641717">custom</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p153251146121714">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p1832684611718">Specifies Precise Protection.</p>
</td>
</tr>
<tr id="waf_02_0080__row1652495201710"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p17469125120179">illegal</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p7469135117175">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p847045141711">Specifies invalid requests.</p>
</td>
</tr>
<tr id="waf_02_0080__row1148625421716"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p16793185361716">lfi</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p1979405315173">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p117951153131716">Specifies local file inclusion.</p>
</td>
</tr>
<tr id="waf_02_0080__row193101356161712"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p17603185531720">robot</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p14604165541718">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p660585517172">Specifies malicious crawlers.</p>
</td>
</tr>
<tr id="waf_02_0080__row753558121714"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p3348145711711">antitamper</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p1634917572179">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p143501357161717">Specifies Web Tamper Protection.</p>
</td>
</tr>
<tr id="waf_02_0080__row283411712214"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p383461710220">rfi</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p8834141742214">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p138351317192213">Specifies remote file inclusion.</p>
</td>
</tr>
<tr id="waf_02_0080__row1651172232219"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p10654102112220">vuln</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p6655122113224">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p965713213222">Specifies other types of attacks.</p>
</td>
</tr>
<tr id="waf_02_0080__row1626142414227"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p12974102315223">whiteblackip</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p497612312212">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p297810239225">Specifies Blacklist and Whitelist.</p>
</td>
</tr>
<tr id="waf_02_0080__row175573263222"><td class="cellrowborder" valign="top" width="36.236376362363764%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0080__p14799025112217">webshell</p>
</td>
<td class="cellrowborder" valign="top" width="23.967603239676034%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0080__p19801525182212">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0080__p14803225192214">Specifies webshells.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="waf_02_0080__section182891739095"><h4 class="sectiontitle">Example</h4><p id="waf_02_0080__p155331434164712"></p>
<div class="p" id="waf_02_0080__p167564311916">Response example<pre class="screen" id="waf_02_0080__screen638014398912">{
"threats": ["xss", "sqli", "cmdi"],
"locale": {
"xss": "Cross Site Scripting",
"sqli": "SQL Injection",
"cmdi": "Command Injection"
}
}</pre>
</div>
</div>
<div class="section" id="waf_02_0080__section43801132"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0080__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0080__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
<div class="tablenoborder"><a name="waf_02_0080__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0080__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="waf_02_0080__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_0080__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_0080__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_0080__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0080__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_0080__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_0080__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_0080__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="waf_02_0080__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_0090.html">Obtaining Option Details</a></div>
</div>
</div>