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
13 KiB
HTML
141 lines
13 KiB
HTML
<a name="waf_02_0081"></a><a name="waf_02_0081"></a>
|
|
|
|
<h1 class="topictitle1">Querying Alarm Notification Configurations</h1>
|
|
<div id="body25440094"><div class="section" id="waf_02_0081__section26619133"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0081__p47381735">This API is used to query alarm notification configurations.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0081__section8666197"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0081__ul23311348"><li id="waf_02_0081__li8475542">URI format<p id="waf_02_0081__p9171015"><a name="waf_02_0081__li8475542"></a><a name="li8475542"></a>GET /v1/{project_id}/waf/config/alert</p>
|
|
</li><li id="waf_02_0081__li15430272">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0081__table4654722" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0081__row28022645"><th align="left" class="cellrowborder" valign="top" width="17.528247175282473%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0081__p55241806"><strong id="waf_02_0081__b1524615412475">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.58804119588041%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0081__p45401307"><strong id="waf_02_0081__b16472443184715">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.58804119588041%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0081__p53627269"><strong id="waf_02_0081__b8571845164717">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.295670432956705%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0081__p48841523"><strong id="waf_02_0081__b9370204654718">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0081__row63849294"><td class="cellrowborder" valign="top" width="17.528247175282473%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0081__p4410301">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.58804119588041%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0081__p21690089">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.58804119588041%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0081__p12066745">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.295670432956705%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0081__p37882261">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0081__section10886911"><h4 class="sectiontitle">Request</h4><p id="waf_02_0081__p8391152121616">Request parameters</p>
|
|
<p class="litext" id="waf_02_0081__p48564326">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0081__section30873341"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0081__p138328115163">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0081__table64771846" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0081__row64088200"><th align="left" class="cellrowborder" valign="top" width="17.169999999999998%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0081__p23761692"><strong id="waf_02_0081__b1149711596471">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.189999999999998%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0081__p45648893"><strong id="waf_02_0081__b999714253816">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.63999999999999%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0081__p6572818"><strong id="waf_02_0081__b1829416213480">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0081__row62636227"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0081__p40369658">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0081__p48716828">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.63999999999999%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0081__p53749011">Specifies the unique ID of an alarm configuration.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0081__row13979058"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0081__p58561923">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0081__p45895324">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.63999999999999%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0081__p26533798">Specifies whether to send an alarm notification.</p>
|
|
<ul id="waf_02_0081__ul11892104301314"><li id="waf_02_0081__li1689211436134"><strong id="waf_02_0081__b1352145117598">true</strong>: Send the alarm notification.</li><li id="waf_02_0081__li11612188201419"><strong id="waf_02_0081__b19132619013">false</strong>: Do not send the alarm notification.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0081__row37477597"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0081__p15786515">topic_urn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0081__p3639309">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.63999999999999%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0081__p26348595">Specifies the SMN topic to which an alarm is sent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0081__row35810771"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0081__p14991335">sendfreq</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0081__p6338652">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.63999999999999%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0081__p43668826">Specifies the minimum interval between two alarms in minutes. The options are <strong id="waf_02_0081__b1979114262719">5</strong>, <strong id="waf_02_0081__b580418428279">15</strong>, <strong id="waf_02_0081__b148041542202715">30</strong>, and <strong id="waf_02_0081__b48051342172711">60</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0081__row57475115"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0081__p24972744">times</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0081__p9526402">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.63999999999999%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0081__p33441088">Specifies the alarm threshold. Alarm notifications are sent when the number of attacks is greater than or equal to the threshold within the configured period. This value is greater than or equal to <strong id="waf_02_0081__b17919112795614">1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0081__row32534340"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0081__p18035908">threat</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0081__p51622461">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.63999999999999%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0081__p14124143915312">Specifies the list of event types.</p>
|
|
<ul id="waf_02_0081__ul527919447315"><li id="waf_02_0081__li171963573210"><strong id="waf_02_0081__b737141018283">all</strong> refers to all types of events.</li><li id="waf_02_0081__li19621591320"><span class="parmvalue" id="waf_02_0081__parmvalue141323227217"><b>cc</b></span> refers to CC attack.</li><li id="waf_02_0081__li1388451193217"><span class="parmvalue" id="waf_02_0081__parmvalue651717257219"><b>cmdi</b></span> refers to command injection.</li><li id="waf_02_0081__li1940231473216"><span class="parmvalue" id="waf_02_0081__parmvalue1477420416349"><b><span id="waf_02_0081__text177211341910">custom</span></b></span> refers to Precise Protection events.</li><li id="waf_02_0081__li8753131816327"><span class="parmvalue" id="waf_02_0081__parmvalue5959183316211"><b>illegal</b></span> refers to invalid requests.</li><li id="waf_02_0081__li2523192283217"><span class="parmvalue" id="waf_02_0081__parmvalue1286431010316"><b>sqli</b></span> refers to SQL injection.</li><li id="waf_02_0081__li965492411328"><span class="parmvalue" id="waf_02_0081__parmvalue667213141837"><b>lfi</b></span> refers to local file inclusion.</li><li id="waf_02_0081__li2420122611320"><strong id="waf_02_0081__b793672616318">robot</strong> refers to malicious crawlers.</li><li id="waf_02_0081__li7313142833213"><span class="parmvalue" id="waf_02_0081__parmvalue1977255016319"><b>antitamper</b></span> refers to Web Tamper Protection events.</li><li id="waf_02_0081__li6286930183216"><span class="parmvalue" id="waf_02_0081__parmvalue11677254436"><b>rfi</b></span> refers to remote file inclusion.</li><li id="waf_02_0081__li81331934133216"><span class="parmvalue" id="waf_02_0081__parmvalue194921581238"><b>vuln</b></span> refers to other types of attacks.</li><li id="waf_02_0081__li1145873753210"><span class="parmvalue" id="waf_02_0081__parmvalue518820212412"><b>xss</b></span> refers to XSS attack.</li><li id="waf_02_0081__li19608239183220"><span class="parmvalue" id="waf_02_0081__parmvalue1615281413355"><b><span id="waf_02_0081__text154249505594">whiteblackip</span></b></span> refers to Blacklist and Whitelist events.</li><li id="waf_02_0081__li627911445311"><span class="parmvalue" id="waf_02_0081__parmvalue2017838943"><b>webshell</b></span> refers to webshells.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0081__row51810310"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0081__p35885554">locale</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0081__p21048787">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.63999999999999%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0081__p27230225">Specifies the language configuration. Only <strong id="waf_02_0081__b1453333516457">zh-cn</strong> and <strong id="waf_02_0081__b8541203516457">en-us</strong> are supported. The default value is <strong id="waf_02_0081__b254113534515">en-us</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0081__section107161616131618"><h4 class="sectiontitle">Example</h4><p id="waf_02_0081__p223044125816"></p>
|
|
<div class="p" id="waf_02_0081__p212132110162">Response example<pre class="screen" id="waf_02_0081__screen1772421615163">{
|
|
"id": "37b4bbe8a562453aa0163a96e6b71dd6",
|
|
"enabled": true,
|
|
"topic_urn": "urn:smn:eude:fca6f667ac5f4d9798d1641dfd38106b:wbtest",
|
|
"sendfreq": 5,
|
|
"times": 200,
|
|
"threat": ["xss", "sqli", "cmdi"],
|
|
"locale": "en-us"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0081__section9424614"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0081__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0081__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 3</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0081__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0081__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_0081__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_0081__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_0081__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_0081__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0081__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_0081__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_0081__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_0081__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0081__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_0079.html">Alarm Notification</a></div>
|
|
</div>
|
|
</div>
|
|
|