AntiDDoS API Reference 20241026 version

Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>
This commit is contained in:
2025-02-27 14:10:40 +00:00
committed by zuul
parent ab5f2db011
commit 3fb78a3507
8 changed files with 88 additions and 242 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -6,15 +6,13 @@
<ul class="ullinks"> <ul class="ullinks">
<li class="ulchildlink"><strong><a href="antiddos_02_0017.html">Querying Optional Anti-DDoS Defense Policies</a></strong><br> <li class="ulchildlink"><strong><a href="antiddos_02_0017.html">Querying Optional Anti-DDoS Defense Policies</a></strong><br>
</li> </li>
<li class="ulchildlink"><strong><a href="antiddos_02_0018.html">Enabling Anti-DDoS</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="antiddos_02_0020.html">Querying Configured Anti-DDoS Defense Policies</a></strong><br> <li class="ulchildlink"><strong><a href="antiddos_02_0020.html">Querying Configured Anti-DDoS Defense Policies</a></strong><br>
</li> </li>
<li class="ulchildlink"><strong><a href="antiddos_02_0021.html">Updating Anti-DDoS Defense Policies</a></strong><br> <li class="ulchildlink"><strong><a href="antiddos_02_0021.html">Updating Anti-DDoS Defense Policies</a></strong><br>
</li> </li>
<li class="ulchildlink"><strong><a href="antiddos_02_0022.html">Querying Anti-DDoS Tasks</a></strong><br> <li class="ulchildlink"><strong><a href="antiddos_02_0022.html">Querying Anti-DDoS Tasks</a></strong><br>
</li> </li>
<li class="ulchildlink"><strong><a href="antiddos_02_0023.html">Querying the List of Defense Statuses of EIPs</a></strong><br> <li class="ulchildlink"><strong><a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a></strong><br>
</li> </li>
<li class="ulchildlink"><strong><a href="antiddos_02_0024.html">Querying the Defense Status of a Specified EIP</a></strong><br> <li class="ulchildlink"><strong><a href="antiddos_02_0024.html">Querying the Defense Status of a Specified EIP</a></strong><br>
</li> </li>

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
<a name="antiddos_02_0023"></a><a name="antiddos_02_0023"></a> <a name="antiddos_02_0023"></a><a name="antiddos_02_0023"></a>
<h1 class="topictitle1">Querying the List of Defense Statuses of EIPs</h1> <h1 class="topictitle1">Querying the List of EIP Defense Statuses</h1>
<div id="body25673664"><div class="section" id="antiddos_02_0023__section52441537"><h4 class="sectiontitle">Functions</h4><p id="antiddos_02_0023__p66300913">This API enables you to query the defense statuses of all EIPs, regardless whether an EIP has been bound to an Elastic Cloud Server (ECS) or not.</p> <div id="body25673664"><div class="section" id="antiddos_02_0023__section52441537"><h4 class="sectiontitle">Functions</h4><p id="antiddos_02_0023__p66300913">This API enables you to query the defense statuses of all EIPs, regardless whether an EIP has been bound to an Elastic Cloud Server (ECS) or not.</p>
</div> </div>
<div class="section" id="antiddos_02_0023__section2211792"><h4 class="sectiontitle">URI</h4><ul id="antiddos_02_0023__ul1664874"><li id="antiddos_02_0023__li14983874">URI format<p id="antiddos_02_0023__p2328887145811"><a name="antiddos_02_0023__li14983874"></a><a name="li14983874"></a>GET /v1/{project_id}/antiddos</p> <div class="section" id="antiddos_02_0023__section2211792"><h4 class="sectiontitle">URI</h4><ul id="antiddos_02_0023__ul1664874"><li id="antiddos_02_0023__li14983874">URI format<p id="antiddos_02_0023__p2328887145811"><a name="antiddos_02_0023__li14983874"></a><a name="li14983874"></a>GET /v1/{project_id}/antiddos</p>
@ -147,7 +147,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p43298646">String</p> <td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p43298646">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><div class="p" id="antiddos_02_0023__p17529450">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0023__ul23547322"><li id="antiddos_02_0023__li10599309"><span class="parmvalue" id="antiddos_02_0023__parmvalue1908468398"><b>normal</b></span>: indicates that the defense status is normal.</li><li id="antiddos_02_0023__li28284925"><span class="parmvalue" id="antiddos_02_0023__parmvalue2100351451"><b>configuring</b></span>: indicates that defense is being configured.</li><li id="antiddos_02_0023__li53237738"><span class="parmvalue" id="antiddos_02_0023__parmvalue181241444"><b>notConfig</b></span>: indicates that defense is not configured.</li><li id="antiddos_02_0023__li9377597"><span class="parmvalue" id="antiddos_02_0023__parmvalue1190858183"><b>packetcleaning</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0023__li17289511"><span class="parmvalue" id="antiddos_02_0023__parmvalue1630240370"><b>packetdropping</b></span>: indicates that traffic is discarded.</li></ul> <td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><div class="p" id="antiddos_02_0023__p17529450">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0023__ul23547322"><li id="antiddos_02_0023__li10599309"><span class="parmvalue" id="antiddos_02_0023__parmvalue1230565076"><b>normal</b></span>: indicates that the defense status is normal.</li><li id="antiddos_02_0023__li28284925"><span class="parmvalue" id="antiddos_02_0023__parmvalue477019951"><b>configuring</b></span>: indicates that defense is being configured.</li><li id="antiddos_02_0023__li53237738"><span class="parmvalue" id="antiddos_02_0023__parmvalue1131473574"><b>notConfig</b></span>: indicates that defense is not configured.</li><li id="antiddos_02_0023__li9377597"><span class="parmvalue" id="antiddos_02_0023__parmvalue1518160991"><b>packetcleaning</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0023__li17289511"><span class="parmvalue" id="antiddos_02_0023__parmvalue1660379527"><b>packetdropping</b></span>: indicates that traffic is discarded.</li></ul>
</div> </div>
</td> </td>
</tr> </tr>
@ -179,6 +179,34 @@
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p646212414311">HTTP traffic threshold</p> <td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p646212414311">HTTP traffic threshold</p>
</td> </td>
</tr> </tr>
<tr id="antiddos_02_0023__row5988647132316"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p13989134715236">traffic_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p129894474231">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p119891947112314">Traffic triggering parameter</p>
</td>
</tr>
<tr id="antiddos_02_0023__row02181153172311"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p52182532234">protect_capacity</p>
</td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p1521885320236">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p16218155315233">Protection capacity. The value <span class="parmvalue" id="antiddos_02_0023__parmvalue395571616327"><b>0</b></span> indicates that protection is not supported.</p>
</td>
</tr>
<tr id="antiddos_02_0023__row466735117235"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p126671951172319">current_usage</p>
</td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p15667165111238">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p1966717516233">Used protection capacity. The value <span class="parmvalue" id="antiddos_02_0023__parmvalue184968810381"><b>0</b></span> indicates that protection is not supported.</p>
</td>
</tr>
<tr id="antiddos_02_0023__row19843154911239"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p2843249102314">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p118431549192315">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p1884312499236">Enterprise project ID</p>
</td>
</tr>
</tbody> </tbody>
</table> </table>
</div> </div>

View File

@ -2,15 +2,25 @@
<h1 class="topictitle1">Change History</h1> <h1 class="topictitle1">Change History</h1>
<div id="body1477278042389"> <div id="body1477278042389">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0034__table63136454111444" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0034__en-us_topic_0040422987_row2942532716410"><th align="left" class="cellrowborder" valign="top" width="27.33%" id="mcps1.3.1.1.3.1.1"><p id="antiddos_02_0034__en-us_topic_0040422987_p5627845516410"><strong id="antiddos_02_0034__b856695530">Release Date</strong></p> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0034__table63136454111444" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0034__en-us_topic_0040422987_row2942532716410"><th align="left" class="cellrowborder" valign="top" width="27.33%" id="mcps1.3.1.1.3.1.1"><p id="antiddos_02_0034__en-us_topic_0040422987_p5627845516410"><strong id="antiddos_02_0034__b620013998">Release Date</strong></p>
</th> </th>
<th align="left" class="cellrowborder" valign="top" width="72.67%" id="mcps1.3.1.1.3.1.2"><p id="antiddos_02_0034__en-us_topic_0040422987_p2382284816410"><strong id="antiddos_02_0034__en-us_topic_0040422987_b3316380216410">Description</strong></p> <th align="left" class="cellrowborder" valign="top" width="72.67%" id="mcps1.3.1.1.3.1.2"><p id="antiddos_02_0034__en-us_topic_0040422987_p2382284816410"><strong id="antiddos_02_0034__en-us_topic_0040422987_b3316380216410">Description</strong></p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="antiddos_02_0034__row1842237134719"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p4422279474">2024-09-13</p> <tbody><tr id="antiddos_02_0034__row19105101411014"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p21055144012">2025-01-21</p>
</td> </td>
<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p1742247154713">Updated the response parameters for <span class="filepath" id="antiddos_02_0034__filepath1395414468474"><b>Querying the list of defense statuses of EIPs</b></span>.</p> <td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><ul id="antiddos_02_0034__ul1157249104117"><li id="antiddos_02_0034__li15198215114211">Updated response parameters in <a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a>.</li><li id="antiddos_02_0034__li125725918414">Optimized the title of section <a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a>.</li><li id="antiddos_02_0034__li146331312416">Optimized the example request in <a href="antiddos_02_0037.html">Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses</a>.</li><li id="antiddos_02_0034__li1931015515512">Optimized the example request in <a href="antiddos_02_0038.html">Configuring the Default Protection Policy for Newly Purchased Public IP Addresses</a>.</li></ul>
</td>
</tr>
<tr id="antiddos_02_0034__row533003615444"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p133314362446">2024-10-25</p>
</td>
<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p2033143615443">Deleted section "Enabling Anti-DDoS".</p>
</td>
</tr>
<tr id="antiddos_02_0034__row1842237134719"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p4422279474">2024-09-13</p>
</td>
<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p1742247154713">Updated the response parameters in section "Querying the List of EIP Defense Statuses".</p>
</td> </td>
</tr> </tr>
<tr id="antiddos_02_0034__row181611243749"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p121611143845">2024-03-29</p> <tr id="antiddos_02_0034__row181611243749"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p121611143845">2024-03-29</p>

View File

@ -82,7 +82,7 @@
</div> </div>
</li></ul> </li></ul>
</div> </div>
<div class="section" id="antiddos_02_0037__section11157820583"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0037__ul194081258134219"><li id="antiddos_02_0037__li6137121012436">Example request<pre class="codeblock" id="antiddos_02_0037__codeblock4650234015244">GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default/config</pre> <div class="section" id="antiddos_02_0037__section11157820583"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0037__ul194081258134219"><li id="antiddos_02_0037__li6137121012436">Example request<pre class="codeblock" id="antiddos_02_0037__codeblock4650234015244">GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default-config</pre>
</li></ul> </li></ul>
</div> </div>
<ul id="antiddos_02_0037__ul01288818584"><li id="antiddos_02_0037__li212816816584">Example response<pre class="screen" id="antiddos_02_0037__screen13128198105819">{ <ul id="antiddos_02_0037__ul01288818584"><li id="antiddos_02_0037__li212816816584">Example response<pre class="screen" id="antiddos_02_0037__screen13128198105819">{

View File

@ -127,7 +127,7 @@
</div> </div>
</li></ul> </li></ul>
</div> </div>
<div class="section" id="antiddos_02_0038__section1487315209019"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0038__ul25933367"><li id="antiddos_02_0038__li32073719">Example request<pre class="codeblock" id="antiddos_02_0038__codeblock6023557611459">POST /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default/config </pre> <div class="section" id="antiddos_02_0038__section1487315209019"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0038__ul25933367"><li id="antiddos_02_0038__li32073719">Example request<pre class="codeblock" id="antiddos_02_0038__codeblock6023557611459">POST /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default-config </pre>
<pre class="screen" id="antiddos_02_0038__screen43109556114535">{ <pre class="screen" id="antiddos_02_0038__screen43109556114535">{
"enable_L7":true, "enable_L7":true,
"traffic_pos_id":1, "traffic_pos_id":1,