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

37
docs/ces/api-ref/ces_03_0028.html
View File

@ -1,7 +1,7 @@
<a name="ces_03_0028"></a><a name="ces_03_0028"></a>
<h1 class="topictitle1">Querying an Alarm Rule</h1>
<div id="body1467891755154"><div class="section" id="ces_03_0028__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0028__p16876399496">This API is used to query an alarm rule based on the alarm rule ID.</p>
<h1 class="topictitle1">Querying Details of an Alarm Rule</h1>
<div id="body1467891755154"><div class="section" id="ces_03_0028__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0028__p16876399496">This API is used to query details of an alarm rule based on its ID.</p>
</div>
<div class="section" id="ces_03_0028__section62331491"><h4 class="sectiontitle">URI</h4><p id="ces_03_0028__p48490504">GET /V1.0/{project_id}/alarms/{alarm_id}</p>
<ul id="ces_03_0028__ul8883693"><li id="ces_03_0028__li33761356">Parameter description
@ -142,7 +142,7 @@
</tr>
<tr id="ces_03_0028__row20584124023017"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p1658444017304">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="16.39163916391639%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0028__p4833115211216">long</p>
<td class="cellrowborder" valign="top" width="16.39163916391639%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0028__p4833115211216">Long</p>
</td>
<td class="cellrowborder" valign="top" width="62.90629062906291%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0028__p558414407303">Specifies when the alarm status changed. The time is a UNIX timestamp and the unit is ms.</p>
</td>
@ -171,7 +171,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_0028__p19586174017307">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_0028__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_0028__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_0028__row35879403303"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0028__p75865406307">dimensions</p>
@ -297,7 +297,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_0028__p1859312409302">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_0028__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_0028__p2735918404">Specifies the data rollup method, which can be</p>
<ul id="ces_03_0028__en-us_topic_0046434864_ul7891893153925"><li id="ces_03_0028__en-us_topic_0046434864_li43492545153925"><strong id="ces_03_0028__b44101937363">average</strong>: Cloud Eye calculates the average value of metric data within a rollup period.</li><li id="ces_03_0028__li16199819381"><strong id="ces_03_0028__b144809419613">max</strong>: Cloud Eye calculates the maximum value of metric data within a rollup period.</li><li id="ces_03_0028__li1664629123819"><strong id="ces_03_0028__b14502154319617">min</strong>: Cloud Eye calculates the minimum value of metric data within a rollup period.</li><li id="ces_03_0028__li9248811153817"><strong id="ces_03_0028__b119580462612">sum</strong>: Cloud Eye calculates the sum of metric data within a rollup period.</li><li id="ces_03_0028__en-us_topic_0046434864_li48786427153939"><strong id="ces_03_0028__b125965494619">variance</strong>: Cloud Eye calculates the variance value of metric data within a rollup period.</li></ul>
</td>
</tr>
@ -305,7 +305,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_0028__p5593340113012">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_0028__p135931040103011">Specifies the alarm threshold operator, which can be <strong id="ces_03_0028__b1048635212436">&gt;</strong>, <strong id="ces_03_0028__b12487352184317">=</strong>, <strong id="ces_03_0028__b144881052154319">&lt;</strong>, <strong id="ces_03_0028__b44887529433">≥</strong>, or <strong id="ces_03_0028__b34897521436">≤</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_0028__p135931040103011">Specifies the alarm threshold operator, which can be <strong id="ces_03_0028__b1048635212436">&gt;</strong>, <strong id="ces_03_0028__b12487352184317">=</strong>, <strong id="ces_03_0028__b144881052154319">&lt;</strong>, <strong id="ces_03_0028__b44887529433">&gt;=</strong>, or <strong id="ces_03_0028__b34897521436">&lt;=</strong>.</p>
</td>
</tr>
<tr id="ces_03_0028__row1593040153018"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0028__p759394033014">value</p>
@ -330,6 +330,24 @@
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0028__p273713184014">Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: <strong id="ces_03_0028__b83111657134315">1</strong> to <strong id="ces_03_0028__b831225716438">5</strong></p>
</td>
</tr>
<tr id="ces_03_0028__row1285141114565"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0028__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_0028__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_0028__p184926321">Specifies the interval for triggering an alarm if the alarm persists. </p>
<p id="ces_03_0028__p192521511322">Possible intervals are as follows:</p>
<p id="ces_03_0028__p852919715321"><strong id="ces_03_0028__b25291777320">0</strong>: Cloud Eye triggers the alarm only once.</p>
<p id="ces_03_0028__p47275133329"><strong id="ces_03_0028__b11727141319329">300</strong>: Cloud Eye triggers the alarm every 5 minutes.</p>
<p id="ces_03_0028__p1287619153327"><strong id="ces_03_0028__b19876141513329">600</strong>: Cloud Eye triggers the alarm every 10 minutes.</p>
<p id="ces_03_0028__p8760151733215"><strong id="ces_03_0028__b14760161712323">900</strong>: Cloud Eye triggers the alarm every 15 minutes.</p>
<p id="ces_03_0028__p122291520183218"><strong id="ces_03_0028__b122922063216">1800</strong>: Cloud Eye triggers the alarm every 30 minutes.</p>
<p id="ces_03_0028__p122222235321"><strong id="ces_03_0028__b1222216236329">3600</strong>: Cloud Eye triggers the alarm every hour.</p>
<p id="ces_03_0028__p114791626163213"><strong id="ces_03_0028__b4479526163211">10800</strong>: Cloud Eye triggers the alarm every 3 hours.</p>
<p id="ces_03_0028__p177101828113211"><strong id="ces_03_0028__b1271072873213">21600</strong>: Cloud Eye triggers the alarm every 6 hours.</p>
<p id="ces_03_0028__p114493333217"><strong id="ces_03_0028__b15143633173210">43200</strong>: Cloud Eye triggers the alarm every 12 hours.</p>
<p id="ces_03_0028__p1869131612402"><strong id="ces_03_0028__b116281435142613">86400</strong>: Cloud Eye triggers the alarm every day.</p>
</td>
</tr>
</tbody>
</table>
</div>
@ -358,7 +376,8 @@
"comparison_operator":"&gt;=",
"value":0,
"unit":"",
"count":1
"count":1,
"suppress_duration":1800
},
"alarm_enabled":true,
"alarm_level": 2,
@ -405,7 +424,7 @@
</tr>
<tr id="ces_03_0028__row181181533193720"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0028__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_0028__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_0028__p661449719168">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="ces_03_0028__row13118163363715"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0028__p355199299168">408 Request Timeout</p>
@ -438,7 +457,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>