forked from docs/doc-exports
Dong, Qiu Jian
95f84e7c3b
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>
464 lines
36 KiB
HTML
464 lines
36 KiB
HTML
<a name="ces_03_0028"></a><a name="ces_03_0028"></a>
|
|
|
|
<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
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table31681753175455" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0028__row39882175175455"><th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="ces_03_0028__p9230722175455">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="ces_03_0028__p9490989175455">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.08%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="ces_03_0028__p30572649175455">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row60465501175455"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0028__p65867442175455">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0028__p33662608175455">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.08%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0028__p42316702175455">Specifies the project ID.</p>
|
|
<p id="ces_03_0028__p1624720191068">For details about how to obtain the project ID, see <a href="ces_03_0057.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row53812216202217"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0028__p63822203202217">alarm_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0028__p2215992202217">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.08%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0028__p45277653202217">Specifies the alarm rule ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="ces_03_0028__ul52541973175457"><li id="ces_03_0028__li41462866">Example<pre class="screen" id="ces_03_0028__screen1854006119507">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/alarms/al1441967036681YkazZ0deN</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0028__section24112512"><h4 class="sectiontitle">Request</h4><p id="ces_03_0028__p45638969">None</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0028__section15686020"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0028__ul5769005"><li id="ces_03_0028__li27068104152742">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table42286344152742" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0028__row38095364152742"><th align="left" class="cellrowborder" valign="top" width="20.7020702070207%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="ces_03_0028__p65825661152742">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.39163916391639%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="ces_03_0028__p36622711152742">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.90629062906291%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="ces_03_0028__p13649609152742">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row48913836152742"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="ces_03_0028__p2597784152742">metric_alarms</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.39163916391639%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="ces_03_0028__p65521217152742">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.90629062906291%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="ces_03_0028__p5618383152742">Specifies the list of alarm objects.</p>
|
|
<p id="ces_03_0028__p118152512355">For details, see <a href="#ces_03_0028__table1358574011306">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0028__table1358574011306"></a><a name="table1358574011306"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table1358574011306" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="ces_03_0028__b1922893510428">metric_alarms</strong> data structure description</caption><thead align="left"><tr id="ces_03_0028__row9573140143015"><th align="left" class="cellrowborder" valign="top" width="20.7020702070207%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="ces_03_0028__p1557384013300">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.39163916391639%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="ces_03_0028__p5573440153014">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.90629062906291%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="ces_03_0028__p195730403301">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row205738405308"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p1157364016307">alarm_name</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__p12573104011303">String</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__p4573440163019">Specifies the alarm rule name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row25741540133013"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p16573184014306">alarm_description</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__p17574124023016">String</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__p1857413406305">Provides supplementary information about the alarm rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row155741140143015"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p16574640163019">metric</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__p15613193451220">Object</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__p1574114053012">Specifies the alarm metric.</p>
|
|
<p id="ces_03_0028__p649212419352">For details, see <a href="#ces_03_0028__table1358724013016">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row45761840113018"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p13575114083012">condition</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__p95751540103013">Object</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__p135768405307">Specifies the alarm triggering condition.</p>
|
|
<p id="ces_03_0028__p14454145463510">For details, see <a href="#ces_03_0028__table159417407300">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row0582174003015"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p65822040133017">alarm_enabled</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__p8582194016301">Boolean</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__p18582940193011">Specifies whether to enable the alarm rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row3583174083016"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p185821840133017">alarm_level</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__p115820402307">Integer</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__p19582740193010">Specifies the alarm severity, which can be <strong id="ces_03_0028__b760062717159">1</strong>, <strong id="ces_03_0028__b3601102721511">2</strong> (default), <strong id="ces_03_0028__b166012272153">3</strong> or <strong id="ces_03_0028__b16602182720157">4</strong>, indicating critical, major, minor, and informational, respectively.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row05831440103013"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p6583340143018">alarm_action_enabled</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__p1583194013014">Boolean</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__p65831640133018">Specifies whether to enable the action to be triggered by an alarm.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row157678553312"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p557864016306">alarm_actions</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__p1578124013018">Array of objects</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__p757814409303">Specifies the action to be triggered by an alarm.</p>
|
|
<p id="ces_03_0028__p657904083018">For details, see <a href="#ces_03_0028__table359064073020">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row37641510123312"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p15579140163017">ok_actions</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__p7581840133019">Array of objects</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__p1854123711153">Specifies the action to be triggered after the alarm is cleared.</p>
|
|
<p id="ces_03_0028__p2551537141517">For details, see <a href="#ces_03_0028__table1859144073012">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row75845404301"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p17584440173011">alarm_id</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__p1458484012308">String</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__p115848409301">Specifies the alarm rule ID.</p>
|
|
</td>
|
|
</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>
|
|
<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>
|
|
</tr>
|
|
<tr id="ces_03_0028__row16585144011306"><td class="cellrowborder" valign="top" width="20.7020702070207%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0028__p175847405306">alarm_state</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__p23811055141215">String</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__p2584134043014">Specifies the alarm status, which can be</p>
|
|
<ul id="ces_03_0028__ul19585640123011"><li id="ces_03_0028__li35841340143010"><strong id="ces_03_0028__b334613954411">ok</strong>: The alarm status is normal.</li><li id="ces_03_0028__li4585184013306"><strong id="ces_03_0028__b51598041151512">alarm</strong>: An alarm is generated.</li><li id="ces_03_0028__li10585540183015"><strong id="ces_03_0028__b1251114017444">insufficient_data</strong>: The required data is insufficient.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0028__table1358724013016"></a><a name="table1358724013016"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table1358724013016" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0028__b67566407445">metric</strong> data structure description</caption><thead align="left"><tr id="ces_03_0028__row9586104013016"><th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="ces_03_0028__p1858674016307">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="ces_03_0028__p1958684013306">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.7%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="ces_03_0028__p16586840173017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row058694020301"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0028__p1458611403306">namespace</p>
|
|
</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">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>
|
|
</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__p19586164043017">Array of objects</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__p55861740143019">Specifies the list of metric dimensions.</p>
|
|
<p id="ces_03_0028__p9586154053018">For details, see <a href="#ces_03_0028__table15589124016303">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row96438865716"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0028__p13623999153639">metric_name</p>
|
|
</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__p136841954153011">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__p1351411315505">Specifies the metric ID. For example, if the monitoring metric of an ECS is CPU usage, <strong id="ces_03_0028__b1720152563413">metric_name</strong> is <strong id="ces_03_0028__b920132583420">cpu_util</strong>. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0028__table15589124016303"></a><a name="table15589124016303"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table15589124016303" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0028__b203151711164515">dimensions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0028__row95871840183019"><th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="ces_03_0028__p155871640123019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="ces_03_0028__p758714013304">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.7%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="ces_03_0028__p1958714018307">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row3588194053014"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0028__p9588164019308">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0028__p858811407301">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0028__p228921325315">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0028__b113391350183616">instance_id</strong>. For details about the dimension of each service, see the <strong id="ces_03_0028__b733411544352">key</strong> column in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row6589124015301"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0028__p19588184023011">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0028__p1588154012306">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0028__p11371113251615">Specifies the dimension value, for example, an ECS ID.</p>
|
|
<p id="ces_03_0028__p18588194043020">Enter 1 to 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0028__table359064073020"></a><a name="table359064073020"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table359064073020" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="ces_03_0028__b569812331455">alarm_actions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0028__row1258924033017"><th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="ces_03_0028__p135896407302">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="ces_03_0028__p6589194012309">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.7%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="ces_03_0028__p7589340173016">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row18590840153020"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="ces_03_0028__p4589154053013">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="ces_03_0028__p1258919407308">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><div class="p" id="ces_03_0028__p2059034043019">Specifies the alarm notification type.<ul id="ces_03_0028__ul10590940153014"><li id="ces_03_0028__li1589104016307"><strong id="ces_03_0028__b792212361457">notification</strong>: indicates that a notification will be sent.</li><li id="ces_03_0028__li105892040153018"><strong id="ces_03_0028__b15532143744518">autoscaling</strong>: indicates that a scaling action will be triggered.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row1859074017305"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="ces_03_0028__p1459014406307">notificationList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="ces_03_0028__p189944518163">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="ces_03_0028__p35901840113013">Specifies the list of objects to be notified if the alarm status changes.</p>
|
|
<div class="note" id="ces_03_0028__note1578161452512"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0028__p19791914112518">The IDs in the list are strings.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0028__table1859144073012"></a><a name="table1859144073012"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table1859144073012" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="ces_03_0028__b1489683916459">ok_actions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0028__row1159014401302"><th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="ces_03_0028__p659084020309">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="ces_03_0028__p13590144073018">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.7%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="ces_03_0028__p559024053012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row1259134016305"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="ces_03_0028__p1659024013014">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="ces_03_0028__p15911940183012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><div class="p" id="ces_03_0028__p165918407306">Specifies the notification type when an alarm is triggered.<ul id="ces_03_0028__ul10591184093013"><li id="ces_03_0028__li2591040163019"><strong id="ces_03_0028__b3574342194513">notification</strong>: indicates that a notification will be sent.</li><li id="ces_03_0028__li9591174017304"><strong id="ces_03_0028__b91617439459">autoscaling</strong>: indicates that a scaling action will be triggered.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row195911940183017"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="ces_03_0028__p115912405301">notificationList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="ces_03_0028__p9548141017165">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="ces_03_0028__p20591840103012">Specifies the list of objects to be notified if the alarm status changes.</p>
|
|
<div class="note" id="ces_03_0028__note187241341152520"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0028__p672444172514">The IDs in the list are strings.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0028__table159417407300"></a><a name="table159417407300"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table159417407300" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="ces_03_0028__b174913452455">condition</strong> data structure description</caption><thead align="left"><tr id="ces_03_0028__row175923401303"><th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.4.2.1.7.2.4.1.1"><p id="ces_03_0028__p8592184020306">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.4.2.1.7.2.4.1.2"><p id="ces_03_0028__p759220403308">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.7%" id="mcps1.3.4.2.1.7.2.4.1.3"><p id="ces_03_0028__p1592124010305">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row859212406308"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0028__p14592164013013">period</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__p1592540163016">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__p9592124016302">Specifies the interval (seconds) for checking whether the configured alarm rules are met.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row12593134013307"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0028__p75931140123014">filter</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__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, 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>
|
|
<tr id="ces_03_0028__row11593174014301"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0028__p15593194018309">comparison_operator</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__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">></strong>, <strong id="ces_03_0028__b12487352184317">=</strong>, <strong id="ces_03_0028__b144881052154319"><</strong>, <strong id="ces_03_0028__b44887529433">>=</strong>, or <strong id="ces_03_0028__b34897521436"><=</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>
|
|
</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__p559324053017">Double</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__p4340485184830">Specifies the alarm threshold. Supported range: <strong id="ces_03_0028__b885132210438">0</strong> to <strong id="ces_03_0028__b585212234313">Number. MAX_VALUE (1.7976931348623157e+108)</strong></p>
|
|
<p id="ces_03_0028__p4166141145613">For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS <strong id="ces_03_0028__b17326181422612">cpu_util</strong> in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a> to <strong id="ces_03_0028__b11327171416260">80</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row25941440173013"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0028__p105931440173016">unit</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__p059394018301">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__p197361919403">Specifies the data unit. Enter up to 32 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row35945402309"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0028__p20594124010304">count</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__p75941740143016">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__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>
|
|
</li><li id="ces_03_0028__li51921052">Example response<pre class="screen" id="ces_03_0028__screen4620271711409">{
|
|
"metric_alarms":
|
|
[
|
|
{
|
|
"alarm_name":"alarm-ipwx",
|
|
"alarm_description":"",
|
|
"metric":
|
|
{
|
|
"namespace":"SYS.ELB",
|
|
"dimensions":
|
|
[
|
|
{
|
|
"name":"lb_instance_id",
|
|
"value":"44d06d10-bce0-4237-86b9-7b4d1e7d5621"
|
|
}
|
|
],
|
|
"metric_name":"m8_out_Bps"
|
|
},
|
|
"condition":
|
|
{
|
|
"period":300,
|
|
"filter":"sum",
|
|
"comparison_operator":">=",
|
|
"value":0,
|
|
"unit":"",
|
|
"count":1,
|
|
"suppress_duration":1800
|
|
},
|
|
"alarm_enabled":true,
|
|
"alarm_level": 2,
|
|
"alarm_action_enabled":true,
|
|
"alarm_actions":
|
|
[
|
|
{
|
|
"type":"notification",
|
|
"notificationList":["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
|
|
}
|
|
],
|
|
"ok_actions":
|
|
[
|
|
{
|
|
"type":"notification",
|
|
"notificationList":["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
|
|
}
|
|
],
|
|
"alarm_id":"al1498096535573r8DNy7Gyk",
|
|
"update_time":1498100100000,
|
|
"alarm_state":"alarm"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0028__section6956456"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0028__ul20226985"><li id="ces_03_0028__li47825138">Normal<p id="ces_03_0028__p27773061"><a name="ces_03_0028__li47825138"></a><a name="li47825138"></a>200</p>
|
|
</li><li id="ces_03_0028__li48630964">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0028__table14117433163713" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0028__row151171633133716"><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_0028__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_0028__p15553712182924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0028__row151181133123717"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0028__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_0028__p164784039168">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row4118143317370"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0028__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_0028__p218024949168">The authentication information is not provided or is incorrect.</p>
|
|
</td>
|
|
</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">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>
|
|
</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__p585420329168">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row911803313713"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0028__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_0028__p37560249168">Concurrent requests are excessive.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row18118153312379"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0028__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_0028__p618106189168">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0028__row12118143320376"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0028__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_0028__p54144829168">The service is currently unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0028__section1343182834618"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0028__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>
|
|
|