vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ces/api-ref/ces_03_0031.html
Yang, Tong d75e275491 CES API 20241015 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>
2024-10-22 11:17:42 +00:00

569 lines
47 KiB
HTML
Raw Blame History

<a name="ces_03_0031"></a><a name="ces_03_0031"></a>
<h1 class="topictitle1">Creating an Alarm Rule</h1>
<div id="body1500447594894"><div class="section" id="ces_03_0031__section690717184830"><h4 class="sectiontitle">Function</h4><p id="ces_03_0031__p55948112184830">This API is used to create an alarm rule.</p>
</div>
<div class="section" id="ces_03_0031__section33770965184830"><h4 class="sectiontitle">URI</h4><p id="ces_03_0031__p44943671184830">POST /V1.0/{project_id}/alarms</p>
<ul id="ces_03_0031__ul51093634184830"><li id="ces_03_0031__li1839861184830">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table16558749184830" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0031__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_0031__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_0031__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_0031__p16282939184830">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row43849684184830"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0031__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_0031__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_0031__p34490468184830">Specifies the project ID.</p>
<p id="ces_03_0031__p297103313620">For details about how to obtain the project ID, see <a href="ces_03_0057.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="ces_03_0031__ul42264495184830"><li id="ces_03_0031__li44836139184830">Example<pre class="screen" id="ces_03_0031__screen1381185164515">POST https://{Cloud Eye endpoint}/V1.0/{project_id}/alarms</pre>
</li></ul>
</div>
<div class="section" id="ces_03_0031__section7848679184830"><h4 class="sectiontitle">Request</h4><ul id="ces_03_0031__ul31763230184830"><li id="ces_03_0031__li17433620184830">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table22684858184830" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="ces_03_0031__row36700749184830"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="ces_03_0031__p19970684184830">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="ces_03_0031__p7012732184830">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="ces_03_0031__p31160437184830">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="ces_03_0031__p40967438184830">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row30028143184830"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p16360513184830">alarm_name</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p50133163184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p34254422184830">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p1343492116295">Specifies the alarm rule name.</p>
<p id="ces_03_0031__p5367528415826">Enter 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
<tr id="ces_03_0031__row6976698184830"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p28241661184830">alarm_description</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p5873213184830">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p37551225183318">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p13664210184830">Provides supplementary information about the alarm rule. Enter 0 to 256 characters.</p>
</td>
</tr>
<tr id="ces_03_0031__row55869026184830"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p29097264184830">metric</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p8068223184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p49546359184830">Object</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p53832127184830">Specifies the alarm metric.</p>
<p id="ces_03_0031__p1786753174815">For details, see <a href="#ces_03_0031__table1358724013016">Table 3</a>.</p>
</td>
</tr>
<tr id="ces_03_0031__row52573824184830"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p30621327184830">condition</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p64408411184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p640316326148">Object</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p66176839184830">Specifies the alarm triggering condition.</p>
<p id="ces_03_0031__p096312292486">For details, see <a href="#ces_03_0031__table159417407300">Table 7</a>.</p>
</td>
</tr>
<tr id="ces_03_0031__row33885327184830"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p60356933184830">alarm_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p57073404184830">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p59543003184830">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p37412483163151">Specifies whether to enable the alarm.</p>
<p id="ces_03_0031__p189105215826">The default value is <strong id="ces_03_0031__b842352706151625">true</strong>.</p>
</td>
</tr>
<tr id="ces_03_0031__row12209165924615"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p54337493184830">alarm_action_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p39260773184830">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p26006017184830">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p943645314418">Specifies whether to enable the action to be triggered by an alarm. The default value is <strong id="ces_03_0031__b1224551225151640">true</strong>.</p>
<div class="note" id="ces_03_0031__note11299541449"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0031__p163612549420">If you set <strong id="ces_03_0031__b976114349351">alarm_action_enabled</strong> to <strong id="ces_03_0031__b1976219343357">true</strong>, you must specify either <strong id="ces_03_0031__b15762434123510">alarm_actions</strong> or <strong id="ces_03_0031__b476223410351">ok_actions</strong>. (You do not need to configure the deprecated parameter <strong id="ces_03_0031__b676333413510">insufficientdata_actions</strong>.)</p>
<p id="ces_03_0031__p53917546419">If <strong id="ces_03_0031__b114019432353">alarm_actions</strong> and <strong id="ces_03_0031__b164104319352">ok_actions</strong> coexist, their <strong id="ces_03_0031__b44114363515">notificationList</strong> must be the same. (You do not need to configure the deprecated parameter <strong id="ces_03_0031__b342164319357">insufficientdata_actions</strong>.)</p>
</div></div>
</td>
</tr>
<tr id="ces_03_0031__row1681846154417"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p712670102310">alarm_level</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p557794642212">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p579215515141">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p8577114613229">Specifies the alarm severity, which can be <strong id="ces_03_0031__b745613314417">1</strong>, <strong id="ces_03_0031__b3456933194415">2</strong> (default), <strong id="ces_03_0031__b1645793344410">3</strong> or <strong id="ces_03_0031__b13457193314445">4</strong>, indicating critical, major, minor, and informational, respectively.</p>
</td>
</tr>
<tr id="ces_03_0031__row14879174844416"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p4769539104520">alarm_type</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p16257195454">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p271613117509">String</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p72513198454">Specifies the alarm rule type.</p>
<p id="ces_03_0031__p76085225163"><strong id="ces_03_0031__b1478815147316">EVENT.SYS</strong>: The alarm rule is created for system events. <strong id="ces_03_0031__b47881414103120">EVENT.CUSTOM</strong>: The alarm rule is created for custom events.</p>
</td>
</tr>
<tr id="ces_03_0031__row2110161020462"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p27735430184830">alarm_actions</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p4949951171213">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p40030552184830">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p21249241184830">Specifies the action to be triggered by an alarm.</p>
<p id="ces_03_0031__p51591767173216">An example structure is as follows:</p>
<p id="ces_03_0031__p61672725173216">{</p>
<p id="ces_03_0031__p18183618173216">"type": "notification","notificationList": ["urn:smn:region:68438a86d98e427e907e0097b7e35d47:sd"]</p>
<p id="ces_03_0031__p29434839173216">}</p>
<p id="ces_03_0031__p12410155017487">For details, see <a href="#ces_03_0031__table359064073020">Table 5</a>.</p>
</td>
</tr>
<tr id="ces_03_0031__row16804132918465"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="ces_03_0031__p40375810184830">ok_actions</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="ces_03_0031__p1228810557317">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="ces_03_0031__p27009365184830">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="ces_03_0031__p40274977184830">Specifies the action to be triggered after the alarm is cleared.</p>
<p id="ces_03_0031__p26930481184830">Its structure is:</p>
<p id="ces_03_0031__p22364435194918">{ "type": "notification","notificationList": ["urn:smn:region:68438a86d98e427e907e0097b7e35d47:sd"] }</p>
<p id="ces_03_0031__p3642155304811">For details, see <a href="#ces_03_0031__table1859144073012">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0031__table1358724013016"></a><a name="table1358724013016"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table1358724013016" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0031__b1159174116183">metric</strong> data structure description</caption><thead align="left"><tr id="ces_03_0031__row9586104013016"><th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="ces_03_0031__p1858674016307">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="ces_03_0031__p16694057179">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.101010101010102%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="ces_03_0031__p1958684013306">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.61616161616161%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="ces_03_0031__p16586840173017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row058694020301"><td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0031__p1458611403306">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0031__p869411512173">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0031__p7428193883310">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.61616161616161%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0031__p2687838193910">Specifies the namespace of a service. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
<p id="ces_03_0031__p17148866184830">The namespace must be in the <strong id="ces_03_0031__b099535494416">service.item</strong> format and contain 3 to 32 characters. <strong id="ces_03_0031__b159951254134419">service</strong> and <strong id="ces_03_0031__b16996155412442">item</strong> each must start with a letter and contain only letters, digits, and underscores (_).</p>
</td>
</tr>
<tr id="ces_03_0031__row35879403303"><td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0031__p75865406307">dimensions</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0031__p7864836151819">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0031__p19586164043017">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="61.61616161616161%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0031__p55861740143019">Specifies the metric dimension list. When <strong id="ces_03_0031__b109313306912">resource_group_id</strong> is not used, <strong id="ces_03_0031__b189256347917">dimensions</strong> is mandatory.</p>
<p id="ces_03_0031__p9586154053018">For details, see <a href="#ces_03_0031__table15589124016303">Table 4</a>.</p>
</td>
</tr>
<tr id="ces_03_0031__row1866844315406"><td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0031__p19274953184830">metric_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0031__p17767332184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0031__p1671144213316">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.61616161616161%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0031__p23711684162943">Specifies the metric name.</p>
<p id="ces_03_0031__p1779204015826">Start with a letter. Enter 1 to 64 characters. Only letters, digits, and underscores (_) are allowed.</p>
<p id="ces_03_0031__p2932950152517">For details, see the metric name queried in <a href="ces_03_0023.html">Querying Metrics</a>.</p>
</td>
</tr>
<tr id="ces_03_0031__row538813014452"><td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="ces_03_0031__p7683184320450">resource_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="ces_03_0031__p1568374315457">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="ces_03_0031__p103345543455">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.61616161616161%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="ces_03_0031__p1568311435453">Specifies the resource group ID selected during the alarm rule creation, for example, <strong id="ces_03_0031__b762929132812">rg1603786526428bWbVmk4rP</strong>.</p>
<div class="note" id="ces_03_0031__note8652270196"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0031__p206692720194">If you create alarm rules for resource groups, you must specify <strong id="ces_03_0031__b18788857094">resource_group_id</strong> and <strong id="ces_03_0031__b428020317102">name</strong>, enter at least one dimension for <strong id="ces_03_0031__b128167121115">dimensions</strong>, and set <strong id="ces_03_0031__b99470143113">alarm_type</strong> to <strong id="ces_03_0031__b9692132321110">RESOURCE_GROUP</strong>.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0031__table15589124016303"></a><a name="table15589124016303"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table15589124016303" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0031__b96067561189">dimensions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0031__row95871840183019"><th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="ces_03_0031__p155871640123019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="ces_03_0031__p1941162013172">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.101010101010102%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="ces_03_0031__p758714013304">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.61616161616161%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="ces_03_0031__p1958714018307">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row3588194053014"><td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="ces_03_0031__p9588164019308">name</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="ces_03_0031__p54112020151715">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="ces_03_0031__p42461077349">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.61616161616161%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="ces_03_0031__p228921325315">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0031__b15330810194013">instance_id</strong>. For details about the dimension of each service, see the <strong id="ces_03_0031__b578017178406">key</strong> column in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
<p id="ces_03_0031__p46761848125214">Start with a letter. Enter 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
<tr id="ces_03_0031__row6589124015301"><td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="ces_03_0031__p19588184023011">value</p>
</td>
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="ces_03_0031__p34111720161711">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="ces_03_0031__p62671010193418">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.61616161616161%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="ces_03_0031__p11371113251615">Specifies the dimension value, for example, an ECS ID.</p>
<p id="ces_03_0031__p1865644545312">Start with a letter or a digit. Enter 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0031__table359064073020"></a><a name="table359064073020"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table359064073020" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="ces_03_0031__b102461452161919">alarm_actions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0031__row1258924033017"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.4.2.5.1.1"><p id="ces_03_0031__p135896407302">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.4.2.5.1.2"><p id="ces_03_0031__p14181533151718">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.1.4.2.5.1.3"><p id="ces_03_0031__p6589194012309">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.3.2.1.4.2.5.1.4"><p id="ces_03_0031__p7589340173016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row18590840153020"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="ces_03_0031__p4589154053013">type</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="ces_03_0031__p17806823205">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="ces_03_0031__p1258919407308">String</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><div class="p" id="ces_03_0031__p2059034043019">Specifies the alarm notification type.<ul id="ces_03_0031__ul10590940153014"><li id="ces_03_0031__li1589104016307"><strong id="ces_03_0031__b9631112722010">notification</strong>: indicates that a notification will be sent.</li><li id="ces_03_0031__li105892040153018"><strong id="ces_03_0031__b4268828202018">autoscaling</strong>: indicates that a scaling action will be triggered.</li></ul>
</div>
</td>
</tr>
<tr id="ces_03_0031__row1859074017305"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="ces_03_0031__p1459014406307">notificationList</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="ces_03_0031__p1580611215205">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="ces_03_0031__p158120523224">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><p id="ces_03_0031__p15808149648">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_0031__b105881123133420">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_0031__p35901840113013">If you set <strong id="ces_03_0031__b41331571524">type</strong> to <strong id="ces_03_0031__b15134147115218">notification</strong>, you must specify <strong id="ces_03_0031__b913410710522">notificationList</strong>. If you set <strong id="ces_03_0031__b1113527185216">type</strong> to <strong id="ces_03_0031__b71351712525">autoscaling</strong>, you must set <strong id="ces_03_0031__b1613615714528">notificationList</strong> to <strong id="ces_03_0031__b111361775217">[]</strong>.</p>
<div class="note" id="ces_03_0031__note3631127095920"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="ces_03_0031__ul13371203915152"><li id="ces_03_0031__li3567053165319">To make the AS alarm rules take effect, you must bind scaling policies. For details, see the <em id="ces_03_0031__i782913610133">Auto Scaling API Reference</em>.</li><li id="ces_03_0031__li28358439150">If you set <strong id="ces_03_0031__b1436252023719">alarm_action_enabled</strong> to <strong id="ces_03_0031__b113641220163719">true</strong>, you must specify either <strong id="ces_03_0031__b163651920143710">alarm_actions</strong> or <strong id="ces_03_0031__b5366122093716">ok_actions</strong>. (You do not need to configure the deprecated parameter <strong id="ces_03_0031__b3367122093712">insufficientdata_actions</strong>.)</li><li id="ces_03_0031__li16408345172713">If <strong id="ces_03_0031__b139744353718">alarm_actions</strong> and <strong id="ces_03_0031__b18987432370">ok_actions</strong> coexist, their <strong id="ces_03_0031__b998343193714">notificationList</strong> must be the same. (You do not need to configure the deprecated parameter <strong id="ces_03_0031__b29904383718">insufficientdata_actions</strong>.)</li><li id="ces_03_0031__li8410144582719">The IDs in the list are strings.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0031__table1859144073012"></a><a name="table1859144073012"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table1859144073012" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="ces_03_0031__b20239616262">ok_actions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0031__row1159014401302"><th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.2.1.5.2.5.1.1"><p id="ces_03_0031__p659084020309">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.2.1.5.2.5.1.2"><p id="ces_03_0031__p8604948181717">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.891089108910892%" id="mcps1.3.3.2.1.5.2.5.1.3"><p id="ces_03_0031__p13590144073018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.396039603960396%" id="mcps1.3.3.2.1.5.2.5.1.4"><p id="ces_03_0031__p559024053012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row1259134016305"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.1.5.2.5.1.1 "><p id="ces_03_0031__p1659024013014">type</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.1.5.2.5.1.2 "><p id="ces_03_0031__p065914542016">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.3.2.1.5.2.5.1.3 "><p id="ces_03_0031__p15911940183012">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.3.2.1.5.2.5.1.4 "><div class="p" id="ces_03_0031__p165918407306">Specifies the notification type when an alarm is triggered.<ul id="ces_03_0031__ul10591184093013"><li id="ces_03_0031__li2591040163019"><strong id="ces_03_0031__b38811986265">notification</strong>: indicates that a notification will be sent.</li><li id="ces_03_0031__li9591174017304"><strong id="ces_03_0031__b756613962613">autoscaling</strong>: indicates that a scaling action will be triggered.</li></ul>
</div>
</td>
</tr>
<tr id="ces_03_0031__row195911940183017"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.1.5.2.5.1.1 "><p id="ces_03_0031__p115912405301">notificationList</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.1.5.2.5.1.2 "><p id="ces_03_0031__p19659175192011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.3.2.1.5.2.5.1.3 "><p id="ces_03_0031__p8444165672211">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.3.2.1.5.2.5.1.4 "><p id="ces_03_0031__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_0031__b112811211163519">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_0031__note33010441244"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0031__p483516202151">If you set <strong id="ces_03_0031__b03371313103815">alarm_action_enabled</strong> to <strong id="ces_03_0031__b17337913103816">true</strong>, you must specify either <strong id="ces_03_0031__b1633831373817">alarm_actions</strong> or <strong id="ces_03_0031__b1433831303813">ok_actions</strong>. (You do not need to configure the deprecated parameter <strong id="ces_03_0031__b19339151314388">insufficientdata_actions</strong>.)</p>
<p id="ces_03_0031__p15836820181517">If <strong id="ces_03_0031__b323652312383">alarm_actions</strong> and <strong id="ces_03_0031__b823762323811">ok_actions</strong> coexist, their <strong id="ces_03_0031__b11238123173810">notificationList</strong> must be the same. (You do not need to configure the deprecated parameter <strong id="ces_03_0031__b72419235385">insufficientdata_actions</strong>.)</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0031__table159417407300"></a><a name="table159417407300"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table159417407300" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="ces_03_0031__b18203928152617">condition</strong> data structure description</caption><thead align="left"><tr id="ces_03_0031__row175923401303"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.2.5.1.1"><p id="ces_03_0031__p8592184020306">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.2.5.1.2"><p id="ces_03_0031__p4552182712016">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.3.2.1.6.2.5.1.3"><p id="ces_03_0031__p759220403308">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.3.2.1.6.2.5.1.4"><p id="ces_03_0031__p1592124010305">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row859212406308"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.1 "><p id="ces_03_0031__p14592164013013">period</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.2 "><p id="ces_03_0031__p61281211184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.1.6.2.5.1.3 "><p id="ces_03_0031__p1592540163016">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.6.2.5.1.4 "><p id="ces_03_0031__p59336618163033">Specifies the period during which Cloud Eye determines whether to trigger an alarm. Unit: second</p>
<p id="ces_03_0031__p3506996615826">Possible periods are <strong id="ces_03_0031__b84235270614561">1</strong>, <strong id="ces_03_0031__b84235270614566">300</strong>, <strong id="ces_03_0031__b842352706145610">1200</strong>, <strong id="ces_03_0031__b842352706145615">3600</strong>, <strong id="ces_03_0031__b842352706145619">14400</strong>, and <strong id="ces_03_0031__b842352706145623">86400</strong>.</p>
<div class="note" id="ces_03_0031__note24513792172954"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="ces_03_0031__ul445821775119"><li id="ces_03_0031__li1545861714517">If you set <strong id="ces_03_0031__b121121519174112">period</strong> to <strong id="ces_03_0031__b10113201984113">1</strong>, Cloud Eye uses raw data to determine whether to trigger an alarm.</li></ul>
</div></div>
</td>
</tr>
<tr id="ces_03_0031__row12593134013307"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.1 "><p id="ces_03_0031__p75931140123014">filter</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.2 "><p id="ces_03_0031__p41234478184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.1.6.2.5.1.3 "><p id="ces_03_0031__p18409122743418">String</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.6.2.5.1.4 "><p id="ces_03_0031__p48422044163043">Specifies the data rollup method.</p>
<p id="ces_03_0031__p3113774115826">Possible methods are <strong id="ces_03_0031__b33978976115232">max</strong>, <strong id="ces_03_0031__b45429468115236">min</strong>, <strong id="ces_03_0031__b49903148115244">average</strong>, <strong id="ces_03_0031__b6359880115251">sum</strong>, or <strong id="ces_03_0031__b42328221115255">variance</strong>.</p>
</td>
</tr>
<tr id="ces_03_0031__row11593174014301"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.1 "><p id="ces_03_0031__p15593194018309">comparison_operator</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.2 "><p id="ces_03_0031__p54782444184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.1.6.2.5.1.3 "><p id="ces_03_0031__p7843029113415">String</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.6.2.5.1.4 "><p id="ces_03_0031__p12749146163055">Specifies the alarm threshold operator.</p>
<p id="ces_03_0031__p4278497915826">Possible operators are <strong id="ces_03_0031__b2449208162820">&gt;</strong>, <strong id="ces_03_0031__b22042877162820">=</strong>, <strong id="ces_03_0031__b64168165162820">&lt;</strong>, <strong id="ces_03_0031__b40642579162820">&gt;=</strong>, and <strong id="ces_03_0031__b30238895162820">&lt;=</strong>.</p>
</td>
</tr>
<tr id="ces_03_0031__row1593040153018"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.1 "><p id="ces_03_0031__p759394033014">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.2 "><p id="ces_03_0031__p16182070184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.1.6.2.5.1.3 "><p id="ces_03_0031__p1165182154518">Double</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.6.2.5.1.4 "><p id="ces_03_0031__p3139888416313">Specifies the alarm threshold.</p>
<p id="ces_03_0031__p6664421215826">Supported range: <strong id="ces_03_0031__b84235270615612">0</strong> to <strong id="ces_03_0031__b84235270615617">Number. MAX_VALUE (1.7976931348623157e+108)</strong></p>
<p id="ces_03_0031__p4166141145613">For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS <strong id="ces_03_0031__b1524514435439">cpu_util</strong> in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a> to <strong id="ces_03_0031__b16259249194314">80</strong>.</p>
</td>
</tr>
<tr id="ces_03_0031__row25941440173013"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.1 "><p id="ces_03_0031__p105931440173016">unit</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.2 "><p id="ces_03_0031__p12554645184830">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.1.6.2.5.1.3 "><p id="ces_03_0031__p1149973211349">String</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.6.2.5.1.4 "><p id="ces_03_0031__p197361919403">Specifies the data unit. Enter up to 32 characters.</p>
</td>
</tr>
<tr id="ces_03_0031__row35945402309"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.1 "><p id="ces_03_0031__p20594124010304">count</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.2 "><p id="ces_03_0031__p33235482184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.1.6.2.5.1.3 "><p id="ces_03_0031__p1533910445344">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.6.2.5.1.4 "><p id="ces_03_0031__p273713184014">Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: <strong id="ces_03_0031__b99941723184817">1</strong> to <strong id="ces_03_0031__b13995122324813">5</strong></p>
</td>
</tr>
<tr id="ces_03_0031__row142736157280"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.1 "><p id="ces_03_0031__p2028621125620">suppress_duration</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.2.5.1.2 "><p id="ces_03_0031__p106671823192810">No</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.1.6.2.5.1.3 "><p id="ces_03_0031__p3423204863413">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.2.1.6.2.5.1.4 "><p id="ces_03_0031__p205271414123013">Specifies the interval for triggering an alarm if the alarm persists.</p>
<p id="ces_03_0031__p183001218183011">Possible intervals are as follows:</p>
<p id="ces_03_0031__p197021221113012"><strong id="ces_03_0031__b9701162103020">0</strong>: Cloud Eye triggers the alarm only once.</p>
<p id="ces_03_0031__p9126172463015"><strong id="ces_03_0031__b191267247302">300</strong>: Cloud Eye triggers the alarm every 5 minutes.</p>
<p id="ces_03_0031__p034182718303"><strong id="ces_03_0031__b17349273302">600</strong>: Cloud Eye triggers the alarm every 10 minutes.</p>
<p id="ces_03_0031__p883029143014"><strong id="ces_03_0031__b2083142913304">900</strong>: Cloud Eye triggers the alarm every 15 minutes.</p>
<p id="ces_03_0031__p19598113133010"><strong id="ces_03_0031__b20598153133015">1800</strong>: Cloud Eye triggers the alarm every 30 minutes.</p>
<p id="ces_03_0031__p13642183316309"><strong id="ces_03_0031__b166421733103020">3600</strong>: Cloud Eye triggers the alarm every hour.</p>
<p id="ces_03_0031__p85858356301"><strong id="ces_03_0031__b65857351307">10800</strong>: Cloud Eye triggers the alarm every 3 hours.</p>
<p id="ces_03_0031__p10502937133016"><strong id="ces_03_0031__b1502637173019">21600</strong>: Cloud Eye triggers the alarm every 6 hours.</p>
<p id="ces_03_0031__p164631940133017"><strong id="ces_03_0031__b144625406306">43200</strong>: Cloud Eye triggers the alarm every 12 hours.</p>
<p id="ces_03_0031__p1869131612402"><strong id="ces_03_0031__b1084973102916">86400</strong>: Cloud Eye triggers the alarm every day.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="ces_03_0031__ul34750592184830"><li id="ces_03_0031__li44319877184830">Example request 1<div class="p" id="ces_03_0031__p124291443151415"><a name="ces_03_0031__li44319877184830"></a><a name="li44319877184830"></a>Creating an alarm rule to monitor a metric<pre class="screen" id="ces_03_0031__screen17221753134919">{
"alarm_name": "alarm-rp0E",
"alarm_description": "",
"metric": {
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "33328f02-3814-422e-b688-bfdba93d4051"
}
],
"metric_name": "network_outgoing_bytes_rate_inband"
},
"condition": {
"period": 300,
"filter": "average",
"comparison_operator": "&gt;=",
"value": 6,
"unit": "Byte/s",
"count": 1
},
"alarm_enabled": true,
"alarm_action_enabled": true,
"alarm_level": 2,
"alarm_actions": [
{
"type": "notification",
"notificationList": ["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
}
],
"ok_actions": [
{
"type": "notification",
"notificationList": ["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
}
]
}</pre>
</div>
</li><li id="ces_03_0031__li563920499107">Example request 2<p id="ces_03_0031__p863944911014"><a name="ces_03_0031__li563920499107"></a><a name="li563920499107"></a>Creating an alarm rule to monitor an event</p>
<pre class="screen" id="ces_03_0031__screen145311805117">{
"alarm_name": "alarm-test",
"metric": {
"namespace": "SYS.ECS",
"metric_name": "instance_resize_scheduled",
"dimensions": [
{
"name": "instance_id",
"value": "d53692e5-828b-495b-a5e2-a1b227f6034c"
}
]
},
"condition": {
"comparison_operator": "&gt;=",
"count": 1,
"filter": "average",
"period": 0,
"unit": "count",
"value": 1
},
"alarm_enabled": true,
"alarm_action_enabled": true,
"alarm_level": 2,
"alarm_type": "EVENT.SYS",
"alarm_actions": [
{
"type": "notification",
"notificationList": ["urn:smn:region:ce8476c174f94c6991ea7885e3380d99:sd"]
}
],
"ok_actions": [
{
"type": "notification",
"notificationList": ["urn:smn:region:ce8476c174f94c6991ea7885e3380d99:sd"]
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="ces_03_0031__section41088852184830"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0031__ul39862682184830"><li id="ces_03_0031__li23219822184830">Response parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table7651809184830" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0031__row11265298184830"><th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="ces_03_0031__p40073906184830">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.04%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="ces_03_0031__p59478015184830">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70.04%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="ces_03_0031__p52989949184830">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row64327487184830"><td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0031__p43143982184830">alarm_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.04%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0031__p15981046115616">String</p>
</td>
<td class="cellrowborder" valign="top" width="70.04%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0031__p66697365184830">Specifies the alarm rule ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="ces_03_0031__ul33777478184830"><li id="ces_03_0031__li35561846184830">Example response<pre class="screen" id="ces_03_0031__screen2358389810228">{
"alarm_id":"al1450321795427dR8p5mQBo"
}</pre>
</li></ul>
</div>
<div class="section" id="ces_03_0031__section55124147184830"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0031__ul35870885184830"><li id="ces_03_0031__li54402515184830">Normal<p id="ces_03_0031__p19860588184830"><a name="ces_03_0031__li54402515184830"></a><a name="li54402515184830"></a>201</p>
</li><li id="ces_03_0031__li44527571184830">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0031__table46793998" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0031__row65573909"><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_0031__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_0031__p15553712182924">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0031__row37564172"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0031__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_0031__p164784039168">Request error.</p>
</td>
</tr>
<tr id="ces_03_0031__row66248115"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0031__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_0031__p218024949168">The authentication information is not provided or is incorrect.</p>
</td>
</tr>
<tr id="ces_03_0031__row44282627"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0031__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_0031__p661449719168">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="ces_03_0031__row1815156"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0031__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_0031__p585420329168">The request timed out.</p>
</td>
</tr>
<tr id="ces_03_0031__row25675773"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0031__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_0031__p37560249168">Concurrent requests are excessive.</p>
</td>
</tr>
<tr id="ces_03_0031__row47530006"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0031__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_0031__p618106189168">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="ces_03_0031__row20561848"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0031__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_0031__p54144829168">The service is currently unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="ces_03_0031__section1618385104615"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0031__ces_03_0020_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