yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/ces/api-ref/ces_03_0069.html
qiujiandong1 e9265fb6b0 CES API Update -20250521 version 
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2025-12-05 10:48:24 +00:00

374 lines
35 KiB
HTML
Raw Blame History

<a name="ces_03_0069"></a><a name="ces_03_0069"></a>
<h1 class="topictitle1">Modifying an Alarm Rule</h1>
<div id="body1606895824428"><div class="section" id="ces_03_0069__section690717184830"><h4 class="sectiontitle">Function</h4><p id="ces_03_0069__p55948112184830">This API is used to modify an alarm rule.</p>
</div>
<div class="section" id="ces_03_0069__section33770965184830"><h4 class="sectiontitle">URI</h4><p id="ces_03_0069__p640311391915">PUT /V1.0/{project_id}/alarms/{alarm_id}</p>
<ul id="ces_03_0069__ul51093634184830"><li id="ces_03_0069__li1839861184830">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0069__table16558749184830" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0069__row13099266184830"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="ces_03_0069__p54407610184830">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.41%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="ces_03_0069__p44940266184830">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.199999999999996%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="ces_03_0069__p16282939184830">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0069__row43849684184830"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0069__p62163550184830">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0069__p2082817184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60.199999999999996%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0069__p42316702175455">Specifies the project ID.</p>
<p id="ces_03_0069__p191415137612">For details about how to obtain the project ID, see <a href="ces_03_0057.html">Obtaining a Project ID</a>.</p>
<p id="ces_03_0069__en-us_topic_0000001646899046_p18100524114814">Minimum: <strong id="ces_03_0069__b149200951243820">1</strong></p>
<p id="ces_03_0069__en-us_topic_0000001646899046_p81001524104817">Maximum: <strong id="ces_03_0069__b179182819383228">64</strong></p>
<p id="ces_03_0069__p4697184133915"><strong id="ces_03_0069__b18080768825016">Regular expression matching</strong>: ^[a-zA-Z0-9-]{1,64}$</p>
</td>
</tr>
<tr id="ces_03_0069__row33641621125512"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0069__p8615227161818">alarm_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0069__p15365321185512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60.199999999999996%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0069__p6365921175520">Specifies the alarm rule ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="ces_03_0069__ul42264495184830"><li id="ces_03_0069__li44836139184830">Example<pre class="screen" id="ces_03_0069__screen1381185164515">PUT https://{Cloud Eye endpoint}/V1.0/{project_id}/alarms/{alarm_id}</pre>
</li></ul>
</div>
<div class="section" id="ces_03_0069__section7848679184830"><h4 class="sectiontitle">Request</h4><ul id="ces_03_0069__ul31763230184830"><li id="ces_03_0069__li17433620184830">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0069__table31681753175455" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0069__row39882175175455"><th align="left" class="cellrowborder" valign="top" width="18.38%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="ces_03_0069__p9230722175455">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="8.08%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="ces_03_0069__p86831127133418">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.24%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="ces_03_0069__p9490989175455">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.300000000000004%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="ces_03_0069__p30572649175455">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0069__row60465501175455"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0069__p11201125513240">alarm_name</p>
</td>
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0069__p1568362713419">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0069__p02011355122416">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.300000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0069__p172011455142414">Specifies the alarm rule name. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
<tr id="ces_03_0069__row53812216202217"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0069__p12201115510244">alarm_description</p>
</td>
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0069__p6683727133410">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0069__p6201195582415">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.300000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0069__p152011455172417">Provides supplementary information about the alarm rule. Enter 0 to 256 characters.</p>
</td>
</tr>
<tr id="ces_03_0069__row12199713125613"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0069__p10201205514247">condition</p>
</td>
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0069__p8683182773417">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0069__p19201135515240">Condition object</p>
</td>
<td class="cellrowborder" valign="top" width="54.300000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0069__p9201755172412">Specifies the alarm policy set in the alarm rule.</p>
<p id="ces_03_0069__p6131185113719">For details, see <a href="#ces_03_0069__table159417407300">Table 3</a>.</p>
</td>
</tr>
<tr id="ces_03_0069__row37532261569"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0069__p4201155542420">alarm_action_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0069__p1468342711345">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0069__p10201455182415">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="54.300000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0069__p16201185510245">Specifies whether to enable the action to be triggered by an alarm. The default value is <strong id="ces_03_0069__b1224551225151640">true</strong>.</p>
<div class="note" id="ces_03_0069__note115101114162819"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0069__p11510101418285">If you set <strong id="ces_03_0069__b842352706151715">alarm_action_enabled</strong> to <strong id="ces_03_0069__b1217916568233">true</strong>, you must specify either <strong id="ces_03_0069__b842352706151730">alarm_actions</strong> or <strong id="ces_03_0069__b842352706151739">ok_actions</strong>. If <strong id="ces_03_0069__b842352706151842">alarm_actions</strong> and <strong id="ces_03_0069__b84235270615195">ok_actions</strong> coexist, their <strong id="ces_03_0069__b842352706152748">notificationList</strong> must be the same.</p>
</div></div>
</td>
</tr>
<tr id="ces_03_0069__row11333122911561"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0069__p920195542420">alarm_level</p>
</td>
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0069__p17683142711342">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0069__p1520115513248">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.300000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0069__p162013556243">Specifies the alarm severity, which can be <strong id="ces_03_0069__b2047151410264">1</strong>, <strong id="ces_03_0069__b548151432614">2</strong> (default), <strong id="ces_03_0069__b849111452610">3</strong> or <strong id="ces_03_0069__b1449514192612">4</strong>, indicating critical, major, minor, and informational, respectively.</p>
</td>
</tr>
<tr id="ces_03_0069__row88451431165618"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0069__p0201125515242">alarm_type</p>
</td>
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0069__p15683112733413">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0069__p182012558241">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.300000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0069__p3266195132210">Specifies the alarm rule type. The value cannot be changed and must be the same as the alarm type of the current alarm rule.</p>
</td>
</tr>
<tr id="ces_03_0069__row1434913465615"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0069__p8201125511244">alarm_actions</p>
</td>
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0069__p4683152743417">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0069__p6201125516244">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="54.300000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0069__p170793672817">Specifies the action to be triggered by an alarm. The structure is as follows: { "type": "notification","notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }</p>
<p id="ces_03_0069__p1642734472811">Possible values of <strong id="ces_03_0069__b14528738192919">type</strong> are as follows:</p>
<p id="ces_03_0069__p5844194622812"><strong id="ces_03_0069__b15952389283153">notification</strong>: A notification will be sent.</p>
<p id="ces_03_0069__p52011455192419"><strong id="ces_03_0069__b6097968531654">autoscaling</strong>: A scaling action will be triggered.</p>
<p id="ces_03_0069__p1597901916379">For details, see <a href="#ces_03_0069__table359064073020">Table 4</a>.</p>
</td>
</tr>
<tr id="ces_03_0069__row136898395569"><td class="cellrowborder" valign="top" width="18.38%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0069__p320165592413">ok_actions</p>
</td>
<td class="cellrowborder" valign="top" width="8.08%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0069__p36834277344">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0069__p820165522412">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="54.300000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0069__p17201855152418">Specifies the action to be triggered after the alarm is cleared.</p>
<p id="ces_03_0069__p1050711243374">For details, see <a href="#ces_03_0069__table1859144073012">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0069__table159417407300"></a><a name="table159417407300"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0069__table159417407300" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0069__b1919164810295">condition</strong> data structure description</caption><thead align="left"><tr id="ces_03_0069__row175923401303"><th align="left" class="cellrowborder" valign="top" width="19.211921192119213%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="ces_03_0069__p8592184020306">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="8.230823082308232%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="ces_03_0069__p2307195983720">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.941294129412942%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="ces_03_0069__p759220403308">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.615961596159615%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="ces_03_0069__p1592124010305">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0069__row859212406308"><td class="cellrowborder" valign="top" width="19.211921192119213%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0069__p14592164013013">period</p>
</td>
<td class="cellrowborder" valign="top" width="8.230823082308232%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0069__p03071759123714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.941294129412942%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0069__p1592540163016">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="59.615961596159615%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0069__p4175457395641">Specifies how often Cloud Eye aggregates data, which can be</p>
<ul id="ces_03_0069__ul22530818141337"><li id="ces_03_0069__li648561116318"><strong id="ces_03_0069__b67521414245">0</strong>: Event alarms are triggered immediately.</li><li id="ces_03_0069__li1450776141337"><strong id="ces_03_0069__b173901211301">1</strong>: Cloud Eye performs no aggregation and displays raw data.</li></ul>
<ul id="ces_03_0069__ul5025435916374"><li id="ces_03_0069__li1144664916374"><strong id="ces_03_0069__b1023515353011">300</strong>: Cloud Eye aggregates data every 5 minutes.</li><li id="ces_03_0069__li2310812316374"><strong id="ces_03_0069__b397813311306">1200</strong>: Cloud Eye aggregates data every 20 minutes.</li><li id="ces_03_0069__li1347195716374"><strong id="ces_03_0069__b376594113016">3600</strong>: Cloud Eye aggregates data every hour.</li><li id="ces_03_0069__li713876916374"><strong id="ces_03_0069__b1256418515305">14400</strong>: Cloud Eye aggregates data every 4 hours.</li><li id="ces_03_0069__li6259003216374"><strong id="ces_03_0069__b531046123016">86400</strong>: Cloud Eye aggregates data every 24 hours.</li></ul>
</td>
</tr>
<tr id="ces_03_0069__row12593134013307"><td class="cellrowborder" valign="top" width="19.211921192119213%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0069__p75931140123014">filter</p>
</td>
<td class="cellrowborder" valign="top" width="8.230823082308232%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0069__p1130711594373">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.941294129412942%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0069__p1859312409302">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.615961596159615%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0069__p2735918404">Specifies the data aggregation method. The value can be:</p>
<ul id="ces_03_0069__en-us_topic_0046434864_ul7891893153925"><li id="ces_03_0069__en-us_topic_0046434864_li43492545153925"><strong id="ces_03_0069__b198418780923311">average</strong>: average value of metric data within an aggregation period.</li><li id="ces_03_0069__li16199819381"><strong id="ces_03_0069__b13702412792346">max</strong>: maximum value of metric data in an aggregation period.</li><li id="ces_03_0069__li1664629123819"><strong id="ces_03_0069__b83175929524333">min</strong>: minimum value of metric data within an aggregation period.</li><li id="ces_03_0069__li9248811153817"><strong id="ces_03_0069__b159214419932211">sum</strong>: sum of metric data within an aggregation period.</li><li id="ces_03_0069__en-us_topic_0046434864_li48786427153939"><strong id="ces_03_0069__b135350985033232">variance</strong>: variance value of metric data within an aggregation period.</li></ul>
</td>
</tr>
<tr id="ces_03_0069__row11593174014301"><td class="cellrowborder" valign="top" width="19.211921192119213%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0069__p15593194018309">comparison_operator</p>
</td>
<td class="cellrowborder" valign="top" width="8.230823082308232%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0069__p20307135983710">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.941294129412942%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0069__p5593340113012">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.615961596159615%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0069__p135931040103011">Specifies the alarm threshold operator, which can be <strong id="ces_03_0069__b158818317329">&gt;</strong>, <strong id="ces_03_0069__b38814314325">=</strong>, <strong id="ces_03_0069__b18882133173212">&lt;</strong>, <strong id="ces_03_0069__b78821931193218">&gt;=</strong>, <strong id="ces_03_0069__b088283116322">&lt;=</strong>, or <strong id="ces_03_0069__b42814919256">!=</strong>.</p>
</td>
</tr>
<tr id="ces_03_0069__row1593040153018"><td class="cellrowborder" valign="top" width="19.211921192119213%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0069__p759394033014">value</p>
</td>
<td class="cellrowborder" valign="top" width="8.230823082308232%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0069__p18307125919374">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.941294129412942%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0069__p559324053017">Double</p>
</td>
<td class="cellrowborder" valign="top" width="59.615961596159615%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0069__p1630610303338">Specifies the alarm threshold.</p>
<p id="ces_03_0069__p91351827163315">Supported range: <strong id="ces_03_0069__b713542703310">0</strong> to <strong id="ces_03_0069__b18135627143317">Number. MAX_VALUE (1.7976931348623157e+108)</strong></p>
<p id="ces_03_0069__p105933404305">For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS <strong id="ces_03_0069__b1787022112305">cpu_util</strong> to <strong id="ces_03_0069__b58709212308">80</strong>.</p>
</td>
</tr>
<tr id="ces_03_0069__row25941440173013"><td class="cellrowborder" valign="top" width="19.211921192119213%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0069__p105931440173016">unit</p>
</td>
<td class="cellrowborder" valign="top" width="8.230823082308232%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0069__p630705910377">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.941294129412942%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0069__p059394018301">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.615961596159615%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0069__p8790143581920">Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.</p>
<p id="ces_03_0069__p187901635101915">Minimum: <strong id="ces_03_0069__b129061783774737">0</strong></p>
<p id="ces_03_0069__p5790135171914">Maximum: <strong id="ces_03_0069__b15423364468158">32</strong></p>
</td>
</tr>
<tr id="ces_03_0069__row35945402309"><td class="cellrowborder" valign="top" width="19.211921192119213%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0069__p20594124010304">count</p>
</td>
<td class="cellrowborder" valign="top" width="8.230823082308232%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0069__p18307359153717">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.941294129412942%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0069__p75941740143016">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="59.615961596159615%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0069__p145946405309">Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: <strong id="ces_03_0069__b531627153015">1</strong> to <strong id="ces_03_0069__b165152719307">5</strong></p>
</td>
</tr>
<tr id="ces_03_0069__row17311115673811"><td class="cellrowborder" valign="top" width="19.211921192119213%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0069__p0332124033919">suppress_duration</p>
</td>
<td class="cellrowborder" valign="top" width="8.230823082308232%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0069__p1930835913715">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.941294129412942%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0069__p8332540143911">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="59.615961596159615%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0069__p11701836144514">Specifies the interval for triggering an alarm if the alarm persists. Possible intervals are as follows: </p>
<p id="ces_03_0069__p1920416434459"><strong id="ces_03_0069__b1720474344519">0</strong>: Cloud Eye triggers the alarm only once.</p>
<p id="ces_03_0069__p199641244204514"><strong id="ces_03_0069__b19964144419458">300</strong>: Cloud Eye triggers the alarm every 5 minutes.</p>
<p id="ces_03_0069__p14232144711454"><strong id="ces_03_0069__b1232104764517">600</strong>: Cloud Eye triggers the alarm every 10 minutes.</p>
<p id="ces_03_0069__p163371950134510"><strong id="ces_03_0069__b0336115014458">900</strong>: Cloud Eye triggers the alarm every 15 minutes.</p>
<p id="ces_03_0069__p789821104617"><strong id="ces_03_0069__b19898217468">1800</strong>: Cloud Eye triggers the alarm every 30 minutes.</p>
<p id="ces_03_0069__p13526165174619"><strong id="ces_03_0069__b052665104610">3600</strong>: Cloud Eye triggers the alarm every hour.</p>
<p id="ces_03_0069__p15101583465"><strong id="ces_03_0069__b1651019814465">10800</strong>: Cloud Eye triggers the alarm every 3 hours.</p>
<p id="ces_03_0069__p613681384610"><strong id="ces_03_0069__b1313651313468">21600</strong>: Cloud Eye triggers the alarm every 6 hours.</p>
<p id="ces_03_0069__p776321694610"><strong id="ces_03_0069__b37631816124616">43200</strong>: Cloud Eye triggers the alarm every 12 hours.</p>
<p id="ces_03_0069__p183321040173911"><strong id="ces_03_0069__b9994203023019">86400</strong>: Cloud Eye triggers the alarm every day.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0069__table359064073020"></a><a name="table359064073020"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0069__table359064073020" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0069__b18600532203011">alarm_actions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0069__row1258924033017"><th align="left" class="cellrowborder" valign="top" width="22.15%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="ces_03_0069__p135896407302">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.220000000000002%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="ces_03_0069__p14181533151718">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.329999999999998%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="ces_03_0069__p6589194012309">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.300000000000004%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="ces_03_0069__p7589340173016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0069__row18590840153020"><td class="cellrowborder" valign="top" width="22.15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="ces_03_0069__p4589154053013">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.220000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="ces_03_0069__p17806823205">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.329999999999998%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="ces_03_0069__p1258919407308">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><div class="p" id="ces_03_0069__p2059034043019">Specifies the alarm notification type.<ul id="ces_03_0069__ul10590940153014"><li id="ces_03_0069__li1589104016307"><strong id="ces_03_0069__b285519513153">notification</strong>: A notification will be sent.</li><li id="ces_03_0069__li105892040153018"><strong id="ces_03_0069__b62424262131654">autoscaling</strong>: A scaling action will be triggered.</li></ul>
</div>
</td>
</tr>
<tr id="ces_03_0069__row1859074017305"><td class="cellrowborder" valign="top" width="22.15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="ces_03_0069__p1459014406307">notificationList</p>
</td>
<td class="cellrowborder" valign="top" width="16.220000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="ces_03_0069__p1580611215205">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.329999999999998%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="ces_03_0069__p158120523224">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="46.300000000000004%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="ces_03_0069__p15808149648">Specifies the list of objects to be notified of alarm status changes. You can add up to 5 object IDs. You can obtain the <strong id="ces_03_0069__b142952049161915">topicUrn</strong> value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.</p>
<p id="ces_03_0069__p35901840113013">If you set <strong id="ces_03_0069__b84235270615753">type</strong> to <strong id="ces_03_0069__b84235270615758">notification</strong>, you must specify <strong id="ces_03_0069__b84235270615816">notificationList</strong>. If you set <strong id="ces_03_0069__b84235270615831">type</strong> to <strong id="ces_03_0069__b84235270615835">autoscaling</strong>, you must set <strong id="ces_03_0069__b2144678271151010">notificationList</strong> to <strong id="ces_03_0069__b84235270610178">[]</strong>.</p>
<div class="note" id="ces_03_0069__note3631127095920"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="ces_03_0069__ul13371203915152"><li id="ces_03_0069__li3567053165319">To make the AS alarm rules take effect, you must bind scaling policies. For details, see the <em id="ces_03_0069__i782913610133">Auto Scaling API Reference</em>.</li><li id="ces_03_0069__li28358439150">If you set <strong id="ces_03_0069__b10078106874462">alarm_action_enabled</strong> to <strong id="ces_03_0069__b2030648844462">true</strong>, you must specify either <strong id="ces_03_0069__b14661668974462">alarm_actions</strong> or <strong id="ces_03_0069__b778821074462">ok_actions</strong>.</li><li id="ces_03_0069__li16408345172713">If <strong id="ces_03_0069__b194733021344624">alarm_actions</strong> and <strong id="ces_03_0069__b62727372644624">ok_actions</strong> coexist, their <strong id="ces_03_0069__b102539135144624">notificationList</strong> must be the same.</li><li id="ces_03_0069__li8410144582719">The IDs in the list are strings.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0069__table1859144073012"></a><a name="table1859144073012"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0069__table1859144073012" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="ces_03_0069__b51088113324">ok_actions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0069__row1159014401302"><th align="left" class="cellrowborder" valign="top" width="22.06%" id="mcps1.3.3.2.1.4.2.5.1.1"><p id="ces_03_0069__p659084020309">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.31%" id="mcps1.3.3.2.1.4.2.5.1.2"><p id="ces_03_0069__p8604948181717">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.409999999999998%" id="mcps1.3.3.2.1.4.2.5.1.3"><p id="ces_03_0069__p13590144073018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.22%" id="mcps1.3.3.2.1.4.2.5.1.4"><p id="ces_03_0069__p559024053012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0069__row1259134016305"><td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="ces_03_0069__p1659024013014">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.31%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="ces_03_0069__p065914542016">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="ces_03_0069__p15911940183012">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.22%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><div class="p" id="ces_03_0069__p165918407306">Specifies the notification type when an alarm is triggered.<ul id="ces_03_0069__ul10591184093013"><li id="ces_03_0069__li2591040163019"><strong id="ces_03_0069__b21319430413153">notification</strong>: A notification will be sent.</li><li id="ces_03_0069__li9591174017304"><strong id="ces_03_0069__b199248060531654">autoscaling</strong>: A scaling action will be triggered.</li></ul>
</div>
</td>
</tr>
<tr id="ces_03_0069__row195911940183017"><td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="ces_03_0069__p115912405301">notificationList</p>
</td>
<td class="cellrowborder" valign="top" width="16.31%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="ces_03_0069__p19659175192011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="ces_03_0069__p8444165672211">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="46.22%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><p id="ces_03_0069__p11714622193">Specifies the list of objects to be notified if the alarm status changes. You can add up to 5 object IDs. You can obtain the <strong id="ces_03_0069__b1855516516214">topicUrn</strong> value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.</p>
<div class="note" id="ces_03_0069__note33010441244"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0069__p483516202151">If you set <strong id="ces_03_0069__b15159178124462">alarm_action_enabled</strong> to <strong id="ces_03_0069__b14855825714462">true</strong>, you must specify either <strong id="ces_03_0069__b15691085704462">alarm_actions</strong> or <strong id="ces_03_0069__b10926689384462">ok_actions</strong>.</p>
<p id="ces_03_0069__p15836820181517">If <strong id="ces_03_0069__b185214920344624">alarm_actions</strong> and <strong id="ces_03_0069__b114542833744624">ok_actions</strong> coexist, their <strong id="ces_03_0069__b108965775344624">notificationList</strong> must be the same.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="ces_03_0069__ul34750592184830"><li id="ces_03_0069__li44319877184830">Example request<pre class="screen" id="ces_03_0069__screen84610368402">{
"alarm_name": "alarm-update-test01",
"alarm_description": "alarm-update-test01",
"condition": {
"comparison_operator": "&gt;=",
"count": 3,
"filter": "average",
"period": 1,
"value": 95
},
"alarm_action_enabled": false,
"alarm_level": 2
}</pre>
</li></ul>
<div class="section" id="ces_03_0069__section55124147184830"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0069__ul35870885184830"><li id="ces_03_0069__li54402515184830">Normal<p id="ces_03_0069__p19860588184830"><a name="ces_03_0069__li54402515184830"></a><a name="li54402515184830"></a>204</p>
</li><li id="ces_03_0069__li44527571184830">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0069__table9852173623812" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0069__row985213612382"><th align="left" class="cellrowborder" valign="top" width="32.1%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="ces_03_0069__p1849030182924">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.9%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="ces_03_0069__p15553712182924">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0069__row4852193611387"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0069__p581987519168">400 Bad Request</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_0069__p164784039168">Request error.</p>
</td>
</tr>
<tr id="ces_03_0069__row188531636193819"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0069__p2691669168">401 Unauthorized</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_0069__p218024949168">The authentication information is not provided or is incorrect.</p>
</td>
</tr>
<tr id="ces_03_0069__row118531636123816"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0069__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_0069__p661449719168">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="ces_03_0069__row4853436123812"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0069__p355199299168">408 Request Timeout</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_0069__p585420329168">The request timed out.</p>
</td>
</tr>
<tr id="ces_03_0069__row1285303673812"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0069__p630127129168">429 Too Many Requests</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_0069__p37560249168">Concurrent requests are excessive.</p>
</td>
</tr>
<tr id="ces_03_0069__row1853336203811"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0069__p537873819168">500 Internal Server Error</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_0069__p618106189168">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="ces_03_0069__row38537365385"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0069__p298930079168">503 Service Unavailable</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_0069__p54144829168">The service is currently unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="ces_03_0069__section1618385104615"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0069__en-us_topic_0171212585_p91851023153416">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ces_03_0026.html">Alarm Rules</a></div>
</div>
</div>
View Git Blame Copy Permalink