yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

Update CES API -20240104 version

Browse Source 
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
This commit is contained in:
Dong, Qiu Jian
2024-05-07 11:19:42 +00:00
committed by zuul
parent 44a5966759
commit 95f84e7c3b
39 changed files with 1494 additions and 346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/ces/api-ref/ces_03_0027.html
View File

@ -1,7 +1,7 @@
<a name="ces_03_0027"></a><a name="ces_03_0027"></a>
<h1 class="topictitle1">Querying Alarm Rules</h1>
<div id="body1442972132817"><div class="section" id="ces_03_0027__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0027__p16876399496">This API is used to query the alarm rule list. You can specify the paging parameters to limit the number of query results displayed on a page. You can also set the sorting order of query results.</p>
<div id="body1442972132817"><div class="section" id="ces_03_0027__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0027__p16876399496">This API is used to query alarm rules. You can specify the paging parameters to limit the number of query results displayed on a page. You can also set the sorting order of query results.</p>
</div>
<div class="section" id="ces_03_0027__section62331491"><h4 class="sectiontitle">URI</h4><p id="ces_03_0027__p48490504">GET /V1.0/{project_id}/alarms</p>
<ul id="ces_03_0027__ul8883693"><li id="ces_03_0027__li33761356">Parameter description
@ -214,7 +214,7 @@
</tr>
<tr id="ces_03_0027__row145720371155"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p14561537101512">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p115613719157">long</p>
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p115613719157">Long</p>
</td>
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p115753721520">Specifies when the alarm status changed. The time is a UNIX timestamp and the unit is ms.</p>
</td>
@ -243,7 +243,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0027__p017765910397">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0027__p2687838193910">Query the namespace of a service. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0027__p2687838193910">Specifies the namespace of a service. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
</td>
</tr>
<tr id="ces_03_0027__row717815917396"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0027__p1517812598392">dimensions</p>
@ -369,7 +369,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="ces_03_0027__p167351915402">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p2735918404">Specifies the data rollup method. The following methods are supported:</p>
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p2735918404">Specifies the data rollup method, which can be</p>
<ul id="ces_03_0027__en-us_topic_0046434864_ul7891893153925"><li id="ces_03_0027__en-us_topic_0046434864_li43492545153925"><strong id="ces_03_0027__b1857491415713">average</strong>: Cloud Eye calculates the average value of metric data within a rollup period.</li><li id="ces_03_0027__li16199819381"><strong id="ces_03_0027__b12515131820715">max</strong>: Cloud Eye calculates the maximum value of metric data within a rollup period.</li><li id="ces_03_0027__li1664629123819"><strong id="ces_03_0027__b19904621278">min</strong>: Cloud Eye calculates the minimum value of metric data within a rollup period.</li><li id="ces_03_0027__li9248811153817"><strong id="ces_03_0027__b1961410258713">sum</strong>: Cloud Eye calculates the sum of metric data within a rollup period.</li><li id="ces_03_0027__en-us_topic_0046434864_li48786427153939"><strong id="ces_03_0027__b1492382714712">variance</strong>: Cloud Eye calculates the variance value of metric data within a rollup period.</li></ul>
</td>
</tr>
@ -377,7 +377,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="ces_03_0027__p15736191144014">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p1073613104013">Specifies the alarm threshold operator, which can be <strong id="ces_03_0027__b321715346439">&gt;</strong>, <strong id="ces_03_0027__b192186344436">=</strong>, <strong id="ces_03_0027__b192181434194315">&lt;</strong>, <strong id="ces_03_0027__b2021973416433">≥</strong>, or <strong id="ces_03_0027__b17219634154311">≤</strong>.</p>
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p1073613104013">Specifies the alarm threshold operator, which can be <strong id="ces_03_0027__b584014114445">&gt;</strong>, <strong id="ces_03_0027__b8840184119445">=</strong>, <strong id="ces_03_0027__b5841341144417">&lt;</strong>, <strong id="ces_03_0027__b13841114112447">&gt;=</strong>, or <strong id="ces_03_0027__b1841114116443">&lt;=</strong>.</p>
</td>
</tr>
<tr id="ces_03_0027__row11736131194014"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p177362134014">value</p>
@ -402,6 +402,24 @@
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p273713184014">Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: <strong id="ces_03_0027__b2097451112117">1</strong> to <strong id="ces_03_0027__b4975151112120">5</strong></p>
</td>
</tr>
<tr id="ces_03_0027__row156244211489"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p2028621125620">suppress_duration</p>
</td>
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="ces_03_0027__p3286121113563">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p154432743312">Specifies the interval for triggering an alarm if the alarm persists. </p>
<p id="ces_03_0027__p19499121013313">Possible intervals are as follows:</p>
<p id="ces_03_0027__p18656118193312"><strong id="ces_03_0027__b8656101819335">0</strong>: Cloud Eye triggers the alarm only once.</p>
<p id="ces_03_0027__p777192013338"><strong id="ces_03_0027__b07712202339">300</strong>: Cloud Eye triggers the alarm every 5 minutes.</p>
<p id="ces_03_0027__p997572218332"><strong id="ces_03_0027__b15975152273312">600</strong>: Cloud Eye triggers the alarm every 10 minutes.</p>
<p id="ces_03_0027__p101141725173310"><strong id="ces_03_0027__b16114152513319">900</strong>: Cloud Eye triggers the alarm every 15 minutes.</p>
<p id="ces_03_0027__p1013482733317"><strong id="ces_03_0027__b1813414272332">1800</strong>: Cloud Eye triggers the alarm every 30 minutes.</p>
<p id="ces_03_0027__p1526232903312"><strong id="ces_03_0027__b14262102943310">3600</strong>: Cloud Eye triggers the alarm every hour.</p>
<p id="ces_03_0027__p6362631193319"><strong id="ces_03_0027__b1936219314333">10800</strong>: Cloud Eye triggers the alarm every 3 hours.</p>
<p id="ces_03_0027__p11339173303316"><strong id="ces_03_0027__b1233953343315">21600</strong>: Cloud Eye triggers the alarm every 6 hours.</p>
<p id="ces_03_0027__p5441153615338"><strong id="ces_03_0027__b114415364337">43200</strong>: Cloud Eye triggers the alarm every 12 hours.</p>
<p id="ces_03_0027__p1869131612402"><strong id="ces_03_0027__b11367111219212">86400</strong>: Cloud Eye triggers the alarm every day.</p>
</td>
</tr>
</tbody>
</table>
</div>
@ -488,7 +506,8 @@
"comparison_operator": "&gt;=",
"value": 12,
"unit": "Byte/s",
"count": 3
"count": 3,
"suppress_duration": 1800
},
"alarm_enabled": true,
"alarm_level": 2,
@ -542,7 +561,7 @@
</tr>
<tr id="ces_03_0027__row86741912103710"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__p563264059168">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0027__p661449719168">You are forbidden to access the page requested.</p>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0027__p661449719168">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="ces_03_0027__row1367431214372"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__p355199299168">408 Request Timeout</p>
@ -575,7 +594,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ces_03_0026.html">Alarm Rule Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="ces_03_0026.html">Alarm Rules</a></div>
</div>
</div>