forked from docs/doc-exports
Li, Qiao
c9ede6a90e
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
167 lines
12 KiB
HTML
167 lines
12 KiB
HTML
<a name="antiddos_02_0029"></a><a name="antiddos_02_0029"></a>
|
|
|
|
<h1 class="topictitle1">Querying Alarm Configuration</h1>
|
|
<div id="body40004924"><div class="section" id="antiddos_02_0029__section55096476"><h4 class="sectiontitle">Functions</h4><p id="antiddos_02_0029__p19173388">This API allows you to query alarm configuration, such as whether a certain type of alarms will be received, and whether alarms are received through SMS messages or emails.</p>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0029__section26106237"><h4 class="sectiontitle">URI</h4><ul id="antiddos_02_0029__ul9540605"><li id="antiddos_02_0029__li18756585">URI format<p id="antiddos_02_0029__p53512344152251"><a name="antiddos_02_0029__li18756585"></a><a name="li18756585"></a>GET /v2/{project_id}/warnalert/alertconfig/query</p>
|
|
</li><li id="antiddos_02_0029__li42888430">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0029__table51410791" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0029__row16041741"><th align="left" class="cellrowborder" valign="top" width="24.347565243475646%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="antiddos_02_0029__p24312641">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.10758924107589%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="antiddos_02_0029__p23166934">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.617938206179375%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="antiddos_02_0029__p64582388">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.92690730926907%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="antiddos_02_0029__p63790914">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="antiddos_02_0029__row66790376"><td class="cellrowborder" valign="top" width="24.347565243475646%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="antiddos_02_0029__p41311375">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.10758924107589%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="antiddos_02_0029__p57887070">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.617938206179375%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="antiddos_02_0029__p58341118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.92690730926907%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="antiddos_02_0029__p28010135">User ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0029__section33629549"><h4 class="sectiontitle">Request</h4><p id="antiddos_02_0029__p074135112212"><strong id="antiddos_02_0029__b188105207106">Request parameters</strong></p>
|
|
<p id="antiddos_02_0029__p1543175416215">None</p>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0029__section34230492"><h4 class="sectiontitle">Response</h4><ul id="antiddos_02_0029__ul48654403"><li id="antiddos_02_0029__li35236445">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0029__table48692557" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0029__row57013647"><th align="left" class="cellrowborder" valign="top" width="30.84%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="antiddos_02_0029__p54702703">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.58%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="antiddos_02_0029__p6231364">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.58%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="antiddos_02_0029__p34978441">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="antiddos_02_0029__row14681450"><td class="cellrowborder" valign="top" width="30.84%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0029__p48346833">warn_config</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.58%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0029__p47080266">List data structure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.58%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0029__p28885026">Alarm configuration</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row58638646"><td class="cellrowborder" valign="top" width="30.84%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0029__p52109899">topic_urn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.58%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0029__p40496186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.58%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0029__p58965604">ID of an alarm group</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row60928390"><td class="cellrowborder" valign="top" width="30.84%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0029__p36252562">display_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.58%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0029__p19248251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.58%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0029__p15604521">Specifies the name of the SMN topic used for sending alarm notifications.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="antiddos_02_0029__li6222962">Data structure description of <strong id="antiddos_02_0029__b84235270695528">warn_config</strong>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0029__table56006663" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0029__row16420978"><th align="left" class="cellrowborder" valign="top" width="27.287271272872708%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="antiddos_02_0029__p55030817">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.75832416758324%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="antiddos_02_0029__p11504285">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.954404559544045%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="antiddos_02_0029__p59431865">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="antiddos_02_0029__row49251786"><td class="cellrowborder" valign="top" width="27.287271272872708%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="antiddos_02_0029__p29971768">antiDDoS</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.75832416758324%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="antiddos_02_0029__p15802441">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="antiddos_02_0029__p4929340">DDoS attacks</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row44364065"><td class="cellrowborder" valign="top" width="27.287271272872708%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="antiddos_02_0029__p36719502">bruce_force</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.75832416758324%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="antiddos_02_0029__p62941481">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="antiddos_02_0029__p65095207">Brute force cracking (system logins, FTP, and DB)</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row48985959"><td class="cellrowborder" valign="top" width="27.287271272872708%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="antiddos_02_0029__p8439774">remote_login</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.75832416758324%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="antiddos_02_0029__p8544631">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="antiddos_02_0029__p21026539">Alarms about remote logins</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row55021127"><td class="cellrowborder" valign="top" width="27.287271272872708%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="antiddos_02_0029__p27526304">weak_password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.75832416758324%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="antiddos_02_0029__p10133581">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="antiddos_02_0029__p15513712">Weak passwords (system and database)</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row5405681"><td class="cellrowborder" valign="top" width="27.287271272872708%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="antiddos_02_0029__p35206999">high_privilege</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.75832416758324%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="antiddos_02_0029__p4416714">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="antiddos_02_0029__p22209574">Overly high rights of a database process</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row65668446"><td class="cellrowborder" valign="top" width="27.287271272872708%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="antiddos_02_0029__p17543884">back_doors</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.75832416758324%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="antiddos_02_0029__p13721689">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="antiddos_02_0029__p37715016">Webshells</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row3890831"><td class="cellrowborder" valign="top" width="27.287271272872708%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="antiddos_02_0029__p46721870">waf</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.75832416758324%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="antiddos_02_0029__p56009450">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="antiddos_02_0029__p40471574">Reserved field</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0029__row49427073194532"><td class="cellrowborder" valign="top" width="27.287271272872708%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="antiddos_02_0029__p63319096194541">send_frequency</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.75832416758324%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="antiddos_02_0029__p1789380615303">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="antiddos_02_0029__p33380830194541">Possible values:</p>
|
|
<ul id="antiddos_02_0029__ul31992022194541"><li id="antiddos_02_0029__li19492746194541"><span class="parmvalue" id="antiddos_02_0029__parmvalue555125744153957_3"><b>0</b></span>: indicates that alarms are sent once a day.</li><li id="antiddos_02_0029__li41216986194541"><span class="parmvalue" id="antiddos_02_0029__parmvalue42786548315404_3"><b>1</b></span>: indicates that alarms are sent once every half hour.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0029__section89859191230"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0029__ul194081258134219"><li id="antiddos_02_0029__li6137121012436">Example request<pre class="codeblock" id="antiddos_02_0029__codeblock4650234015244">GET /v2/67641fe6886f43fcb78edbbf0ad0b99f/warnalert/alertconfig/query</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="antiddos_02_0029__ul1986182018314"><li id="antiddos_02_0029__li10861220432">Example response<pre class="screen" id="antiddos_02_0029__screen1386020532">{
|
|
"warn_config": {
|
|
"antiDDoS": true,
|
|
"bruce_force": false,
|
|
"remote_login": false,
|
|
"weak_password": false,
|
|
"high_privilege": false,
|
|
"back_doors": false,
|
|
"waf": false
|
|
},
|
|
"topic_urn": "urn:smn:eu-de:67641fe6886f43fcb78edbbf0ad0b99f:test_soft",
|
|
"display_name": "group_1"
|
|
}</pre>
|
|
<div class="note" id="antiddos_02_0029__note108620200315"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="antiddos_02_0029__p14869206312">SFTP is more secure than FTP. To secure data transmission, use SFTP to transfer files.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
<div class="section" id="antiddos_02_0029__section39638980"><h4 class="sectiontitle">Status Code</h4><p id="antiddos_02_0029__p1504051">See <a href="antiddos_02_0031.html">Status Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="antiddos_02_0028.html">Alarm Reminding APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|