forked from docs/doc-exports
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>
601 lines
46 KiB
HTML
601 lines
46 KiB
HTML
<a name="ces_03_0027"></a><a name="ces_03_0027"></a>
|
|
|
|
<h1 class="topictitle1">Querying Alarm Rules</h1>
|
|
<div id="body1442972132817"><div class="section" id="ces_03_0027__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0027__p16876399496">This API is used to query alarm rules. You can specify the paging parameters to limit the number of query results displayed on a page. You can also set the sorting order of query results.</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0027__section62331491"><h4 class="sectiontitle">URI</h4><p id="ces_03_0027__p48490504">GET /V1.0/{project_id}/alarms</p>
|
|
<ul id="ces_03_0027__ul8883693"><li id="ces_03_0027__li33761356">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table31681753175455" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0027__row39882175175455"><th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="ces_03_0027__p9230722175455">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.52%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="ces_03_0027__p9490989175455">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.8%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="ces_03_0027__p30572649175455">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row60465501175455"><td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0027__p65867442175455">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.52%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0027__p33662608175455">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.8%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0027__p42316702175455">Specifies the project ID.</p>
|
|
<p id="ces_03_0027__p191415137612">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>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table69011263247" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0027__row1990162672413"><th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.2.3.1.2.2.4.1.1"><p id="ces_03_0027__p7901112618245">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.3.1.2.2.4.1.2"><p id="ces_03_0027__p20901226192419">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.08%" id="mcps1.3.2.3.1.2.2.4.1.3"><p id="ces_03_0027__p16901182616246">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row12901726192414"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.2.3.1.2.2.4.1.1 "><p id="ces_03_0027__p490182682418">alarms</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.2.2.4.1.2 "><p id="ces_03_0027__p6399215102813">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.08%" headers="mcps1.3.2.3.1.2.2.4.1.3 "><p id="ces_03_0027__p164509304268">Specifies the alarm rule list.</p>
|
|
<p id="ces_03_0027__p64152914239">For details, see <a href="#ces_03_0027__table35416756">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="p" id="ces_03_0027__p13953533151018">
|
|
<div class="tablenoborder"><a name="ces_03_0027__table35416756"></a><a name="table35416756"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table35416756" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Query parameter description</caption><thead align="left"><tr id="ces_03_0027__row27598891"><th align="left" class="cellrowborder" valign="top" width="18.61186118611861%" id="mcps1.3.2.3.1.3.1.2.5.1.1"><p id="ces_03_0027__p20917673">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.981598159815983%" id="mcps1.3.2.3.1.3.1.2.5.1.2"><p id="ces_03_0027__p16609919">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.85178517851785%" id="mcps1.3.2.3.1.3.1.2.5.1.3"><p id="ces_03_0027__p1305739116331">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.55475547554755%" id="mcps1.3.2.3.1.3.1.2.5.1.4"><p id="ces_03_0027__p3226198">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row59995477"><td class="cellrowborder" valign="top" width="18.61186118611861%" headers="mcps1.3.2.3.1.3.1.2.5.1.1 "><p id="ces_03_0027__p3210854694927">start</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.981598159815983%" headers="mcps1.3.2.3.1.3.1.2.5.1.2 "><p id="ces_03_0027__p5065546194927">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.85178517851785%" headers="mcps1.3.2.3.1.3.1.2.5.1.3 "><p id="ces_03_0027__p5101571116331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.55475547554755%" headers="mcps1.3.2.3.1.3.1.2.5.1.4 "><p id="ces_03_0027__p3030830020621">Specifies the first queried alarm to be displayed on a page.</p>
|
|
<p id="ces_03_0027__p2670812615612">The value is <strong id="ces_03_0027__b39912972067">alarm_id</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row14620943"><td class="cellrowborder" valign="top" width="18.61186118611861%" headers="mcps1.3.2.3.1.3.1.2.5.1.1 "><p id="ces_03_0027__p372561594927">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.981598159815983%" headers="mcps1.3.2.3.1.3.1.2.5.1.2 "><p id="ces_03_0027__p3333939594927">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.85178517851785%" headers="mcps1.3.2.3.1.3.1.2.5.1.3 "><p id="ces_03_0027__p865595815514">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.55475547554755%" headers="mcps1.3.2.3.1.3.1.2.5.1.4 "><p id="ces_03_0027__p1613650494927">Supported range: <strong id="ces_03_0027__b4692141411202">1</strong> to <strong id="ces_03_0027__b1552221719205">100</strong> (default)</p>
|
|
<p id="ces_03_0027__p1101081494927">This parameter is used to limit the number of query results.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row55056607"><td class="cellrowborder" valign="top" width="18.61186118611861%" headers="mcps1.3.2.3.1.3.1.2.5.1.1 "><p id="ces_03_0027__p4092925294927">order</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.981598159815983%" headers="mcps1.3.2.3.1.3.1.2.5.1.2 "><p id="ces_03_0027__p2693508294927">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.85178517851785%" headers="mcps1.3.2.3.1.3.1.2.5.1.3 "><p id="ces_03_0027__p4217614016331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.55475547554755%" headers="mcps1.3.2.3.1.3.1.2.5.1.4 "><p id="ces_03_0027__p3425803394927">Specifies the result sorting method, which is sorted by timestamp.</p>
|
|
<p id="ces_03_0027__p3988684494927">The default method is <strong id="ces_03_0027__b106401063518">desc</strong>.</p>
|
|
<ul id="ces_03_0027__ul27034705141026"><li id="ces_03_0027__li40444226141026"><strong id="ces_03_0027__b2483023315742">asc</strong>: The query results are displayed in the ascending order.</li><li id="ces_03_0027__li6118542141026"><strong id="ces_03_0027__b4315414215754">desc</strong>: The query results are displayed in the descending order.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="ces_03_0027__ul52541973175457"><li id="ces_03_0027__li41462866">Example<div class="p" id="ces_03_0027__p19876545183312"><a name="ces_03_0027__li41462866"></a><a name="li41462866"></a>Request example 1: Query the current alarm rule list.<pre class="screen" id="ces_03_0027__screen19889056194625">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/alarms</pre>
|
|
</div>
|
|
<p id="ces_03_0027__p88846439454"></p>
|
|
<div class="p" id="ces_03_0027__p13749948104510">Request example 2: Query the alarm rule list. Start by setting <strong id="ces_03_0027__b9942202312717">alarm_id</strong> to <strong id="ces_03_0027__b19111431192713">al1441967036681YkazZ0deN</strong> and retain 10 records in the descending order of time stamps.<pre class="screen" id="ces_03_0027__screen5749194817459">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/alarms?start=al1441967036681YkazZ0deN&limit=10&order=desc</pre>
|
|
</div>
|
|
<p id="ces_03_0027__p181038456457"></p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0027__section24112512"><h4 class="sectiontitle">Request</h4><p id="ces_03_0027__p45638969">None</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0027__section15686020"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0027__ul5769005"><li id="ces_03_0027__li27068104152742">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table42286344152742" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0027__row38095364152742"><th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="ces_03_0027__p65825661152742">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="ces_03_0027__p36622711152742">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.7%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="ces_03_0027__p13649609152742">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row48913836152742"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0027__p2597784152742">metric_alarms</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0027__p65521217152742">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0027__p5618383152742">Specifies the list of alarm objects.</p>
|
|
<p id="ces_03_0027__p493519491135">For details, see <a href="#ces_03_0027__table10571837131516">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row185671917132310"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0027__p244163712152">meta_data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0027__p64523721512">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0027__p645113791514">Specifies the metadata of query results, including the pagination information.</p>
|
|
<p id="ces_03_0027__p39125515320">For details, see <a href="#ces_03_0027__table1933614411408">Table 11</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0027__table10571837131516"></a><a name="table10571837131516"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table10571837131516" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="ces_03_0027__b4889129112812">metric_alarms</strong> data structure description</caption><thead align="left"><tr id="ces_03_0027__row134453716156"><th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="ces_03_0027__p124463713153">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="ces_03_0027__p104453761519">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.7%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="ces_03_0027__p74433718157">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row248153712151"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p154723714155">alarm_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p9471437161516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p1947193719153">Specifies the alarm rule name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row1748203712158"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p648113717154">alarm_description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p1481237151518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p124853771516">Provides supplementary information about the alarm rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row19488375152"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p12481237171510">metric</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p984318421173">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p124813371158">Specifies the alarm metric.</p>
|
|
<p id="ces_03_0027__p15984161314122">For details, see <a href="#ces_03_0027__table19174559133918">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row1501437181511"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p0501937171510">condition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p98879491178">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p450143711158">Specifies the alarm triggering condition.</p>
|
|
<p id="ces_03_0027__p1099762313419">For details, see <a href="#ces_03_0027__table1473091124015">Table 10</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row8350858143220"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p65515377157">alarm_enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p2552377158">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p65583771510">Specifies whether to enable the alarm rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row12949160173313"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p1955037121518">alarm_level</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p185510371158">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p13551237101518">Specifies the alarm severity, which can be <strong id="ces_03_0027__b19409151161">1</strong>, <strong id="ces_03_0027__b7940161513164">2</strong> (default), <strong id="ces_03_0027__b18941101551618">3</strong> or <strong id="ces_03_0027__b894211159163">4</strong>, indicating critical, major, minor, and informational, respectively.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row1287162520368"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p1986042612363">alarm_action_enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p886052617366">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p886016267365">Specifies whether to enable the action to be triggered by an alarm.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row253103713155"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p105217374156">alarm_actions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p25263719151">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p1753183711155">Specifies the action to be triggered by an alarm.</p>
|
|
<p id="ces_03_0027__p1783765741713">For details, see <a href="#ces_03_0027__table569133710159">Table 8</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row1755173741512"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p35410376153">ok_actions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p105403717151">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p1854123711153">Specifies the action to be triggered after the alarm is cleared.</p>
|
|
<p id="ces_03_0027__p2551537141517">For details, see <a href="#ces_03_0027__table1819115871510">Table 9</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row656837171519"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p9561337191516">alarm_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p55623716158">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p756737131515">Specifies the alarm rule ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row145720371155"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p14561537101512">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p115613719157">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p115753721520">Specifies when the alarm status changed. The time is a UNIX timestamp and the unit is ms.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row175723717154"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0027__p1057143761515">alarm_state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0027__p75793721513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0027__p1957143751513">Specifies the alarm status, which can be</p>
|
|
<ul id="ces_03_0027__ul195793741513"><li id="ces_03_0027__li3577377156"><strong id="ces_03_0027__b64892893151459">ok</strong>: The alarm status is normal.</li><li id="ces_03_0027__li75733716155"><strong id="ces_03_0027__b51598041151512">alarm</strong>: An alarm is generated.</li><li id="ces_03_0027__li155783721518"><strong id="ces_03_0027__b23034997151525">insufficient_data</strong>: The required data is insufficient.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0027__table19174559133918"></a><a name="table19174559133918"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table19174559133918" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="ces_03_0027__b11910171103114">metric</strong> data structure description</caption><thead align="left"><tr id="ces_03_0027__row10174145923910"><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_0027__p117455973917">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_0027__p21751659193910">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_0027__p317575993911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row1017713594391"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0027__p31773593392">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_0027__p017765910397">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0027__p2687838193910">Specifies the namespace of a service. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row717815917396"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0027__p1517812598392">dimensions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0027__p1117805912397">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_0027__p0178195943915">Specifies the list of metric dimensions.</p>
|
|
<p id="ces_03_0027__p2613429127">For details, see <a href="#ces_03_0027__table7554143164419">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row95521942102915"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0027__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_0027__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_0027__p1351411315505">Specifies the metric ID. For example, if the monitoring metric of an ECS is CPU usage, <strong id="ces_03_0027__b1843421133318">metric_name</strong> is <strong id="ces_03_0027__b1843461111331">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_0027__table7554143164419"></a><a name="table7554143164419"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table7554143164419" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="ces_03_0027__b243019362317">dimensions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0027__row1555516374419"><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_0027__p6555193144417">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_0027__p125551734448">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_0027__p1755533204413">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row9558183144414"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0027__p824618425365">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_0027__p3246194283614">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_0027__p228921325315">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0027__b10279172922814">instance_id</strong>. For details about the dimension of each service, see the <strong id="ces_03_0027__b1231264712810">key</strong> column in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row19559235443"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0027__p5547124122511">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_0027__p19547154122519">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_0027__p11371113251615">Specifies the dimension value, for example, an ECS ID.</p>
|
|
<p id="ces_03_0027__p22011213201614">Enter 1 to 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0027__table569133710159"></a><a name="table569133710159"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table569133710159" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="ces_03_0027__b5692847325">alarm_actions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0027__row758183741514"><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_0027__p75815379159">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_0027__p12581537191518">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_0027__p65818370158">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row1565203771511"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="ces_03_0027__p125751020181418">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_0027__p96443712157">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_0027__p56512371155">Specifies the alarm notification type.<ul id="ces_03_0027__ul14659377150"><li id="ces_03_0027__li186553711159"><strong id="ces_03_0027__b842352706173134">notification</strong>: indicates that a notification will be sent.</li><li id="ces_03_0027__li6651337141518"><strong id="ces_03_0027__b842352706173149">autoscaling</strong>: indicates that a scaling action will be triggered.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row367193716157"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="ces_03_0027__p18668378158">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_0027__p66616375152">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_0027__p167173715151">Specifies the list of objects to be notified if the alarm status changes.</p>
|
|
<div class="note" id="ces_03_0027__note16816125412261"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0027__p18161354152615">The IDs in the list are strings.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0027__table1819115871510"></a><a name="table1819115871510"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table1819115871510" frame="border" border="1" rules="all"><caption><b>Table 9 </b><strong id="ces_03_0027__b28411311331">ok_actions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0027__row18819195814154"><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_0027__p1581985818154">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_0027__p1819125819158">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_0027__p1181935841519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row482075819154"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="ces_03_0027__p3820558101519">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_0027__p1682015819157">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_0027__p68201858141515">Specifies the notification type when an alarm is triggered.<ul id="ces_03_0027__ul108209583156"><li id="ces_03_0027__li1682015891511"><strong id="ces_03_0027__b173335218333">notification</strong>: indicates that a notification will be sent.</li><li id="ces_03_0027__li1082035891514"><strong id="ces_03_0027__b154155414336">autoscaling</strong>: indicates that a scaling action will be triggered.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row9820115881519"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="ces_03_0027__p182010585151">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_0027__p98201858151514">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_0027__p9346141372110">Specifies the ID list of objects to be notified if the alarm status changes.</p>
|
|
<div class="note" id="ces_03_0027__note1578161452512"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0027__p19791914112518">The IDs in the list are strings.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0027__table1473091124015"></a><a name="table1473091124015"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table1473091124015" frame="border" border="1" rules="all"><caption><b>Table 10 </b><strong id="ces_03_0027__b125795823310">condition</strong> data structure description</caption><thead align="left"><tr id="ces_03_0027__row12731417403"><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_0027__p273141134017">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_0027__p673151194014">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_0027__p273171144015">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row17351511406"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p873512116408">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_0027__p473515110403">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p1473517154015">Specifies the interval (seconds) for checking whether the configured alarm rules are met.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row573513194010"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p07357119405">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_0027__p167351915402">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p2735918404">Specifies the data rollup method, which can be</p>
|
|
<ul id="ces_03_0027__en-us_topic_0046434864_ul7891893153925"><li id="ces_03_0027__en-us_topic_0046434864_li43492545153925"><strong id="ces_03_0027__b1857491415713">average</strong>: Cloud Eye calculates the average value of metric data within a rollup period.</li><li id="ces_03_0027__li16199819381"><strong id="ces_03_0027__b12515131820715">max</strong>: Cloud Eye calculates the maximum value of metric data within a rollup period.</li><li id="ces_03_0027__li1664629123819"><strong id="ces_03_0027__b19904621278">min</strong>: Cloud Eye calculates the minimum value of metric data within a rollup period.</li><li id="ces_03_0027__li9248811153817"><strong id="ces_03_0027__b1961410258713">sum</strong>: Cloud Eye calculates the sum of metric data within a rollup period.</li><li id="ces_03_0027__en-us_topic_0046434864_li48786427153939"><strong id="ces_03_0027__b1492382714712">variance</strong>: Cloud Eye calculates the variance value of metric data within a rollup period.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row19735111144010"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p373614194018">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_0027__p15736191144014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p1073613104013">Specifies the alarm threshold operator, which can be <strong id="ces_03_0027__b584014114445">></strong>, <strong id="ces_03_0027__b8840184119445">=</strong>, <strong id="ces_03_0027__b5841341144417"><</strong>, <strong id="ces_03_0027__b13841114112447">>=</strong>, or <strong id="ces_03_0027__b1841114116443"><=</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row11736131194014"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p177362134014">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="ces_03_0027__p87361817402">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_0027__p4340485184830">Specifies the alarm threshold. Supported range: <strong id="ces_03_0027__b12717701860">0</strong> to <strong id="ces_03_0027__b12718150864">Number. MAX_VALUE (1.7976931348623157e+108)</strong></p>
|
|
<p id="ces_03_0027__p4166141145613">For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS <strong id="ces_03_0027__b1586015428209">cpu_util</strong> in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a> to <strong id="ces_03_0027__b178614427209">80</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row873611164014"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p177361174018">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_0027__p137369116403">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p197361919403">Specifies the data unit. Enter up to 32 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row1173614104018"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p157368134013">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_0027__p1973711164020">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p273713184014">Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: <strong id="ces_03_0027__b2097451112117">1</strong> to <strong id="ces_03_0027__b4975151112120">5</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row156244211489"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="ces_03_0027__p2028621125620">suppress_duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="ces_03_0027__p3286121113563">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="ces_03_0027__p154432743312">Specifies the interval for triggering an alarm if the alarm persists.</p>
|
|
<p id="ces_03_0027__p19499121013313">Possible intervals are as follows:</p>
|
|
<p id="ces_03_0027__p18656118193312"><strong id="ces_03_0027__b8656101819335">0</strong>: Cloud Eye triggers the alarm only once.</p>
|
|
<p id="ces_03_0027__p777192013338"><strong id="ces_03_0027__b07712202339">300</strong>: Cloud Eye triggers the alarm every 5 minutes.</p>
|
|
<p id="ces_03_0027__p997572218332"><strong id="ces_03_0027__b15975152273312">600</strong>: Cloud Eye triggers the alarm every 10 minutes.</p>
|
|
<p id="ces_03_0027__p101141725173310"><strong id="ces_03_0027__b16114152513319">900</strong>: Cloud Eye triggers the alarm every 15 minutes.</p>
|
|
<p id="ces_03_0027__p1013482733317"><strong id="ces_03_0027__b1813414272332">1800</strong>: Cloud Eye triggers the alarm every 30 minutes.</p>
|
|
<p id="ces_03_0027__p1526232903312"><strong id="ces_03_0027__b14262102943310">3600</strong>: Cloud Eye triggers the alarm every hour.</p>
|
|
<p id="ces_03_0027__p6362631193319"><strong id="ces_03_0027__b1936219314333">10800</strong>: Cloud Eye triggers the alarm every 3 hours.</p>
|
|
<p id="ces_03_0027__p11339173303316"><strong id="ces_03_0027__b1233953343315">21600</strong>: Cloud Eye triggers the alarm every 6 hours.</p>
|
|
<p id="ces_03_0027__p5441153615338"><strong id="ces_03_0027__b114415364337">43200</strong>: Cloud Eye triggers the alarm every 12 hours.</p>
|
|
<p id="ces_03_0027__p1869131612402"><strong id="ces_03_0027__b11367111219212">86400</strong>: Cloud Eye triggers the alarm every day.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0027__table1933614411408"></a><a name="table1933614411408"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table1933614411408" frame="border" border="1" rules="all"><caption><b>Table 11 </b><strong id="ces_03_0027__b92191011113517">meta_data</strong> data structure description</caption><thead align="left"><tr id="ces_03_0027__row23364419409"><th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.4.2.1.8.2.4.1.1"><p id="ces_03_0027__p33366416402">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.4.2.1.8.2.4.1.2"><p id="ces_03_0027__p163365419400">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.7%" id="mcps1.3.4.2.1.8.2.4.1.3"><p id="ces_03_0027__p5336149404">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row1533794184019"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="ces_03_0027__p103371641407">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="ces_03_0027__p133370434010">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="ces_03_0027__p1933717404020">Specifies the number of returned results.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row2305156104015"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="ces_03_0027__p617265794014">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="ces_03_0027__p1172957154015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="ces_03_0027__p1817211579405">Specifies the pagination marker.</p>
|
|
<p id="ces_03_0027__p692093911581">For example, you have queried 10 records this time and <strong id="ces_03_0027__b8525107103913">alarm_id</strong> of the tenth record is <strong id="ces_03_0027__b177335238391">1441967036681YkazZ0deN</strong>. In your next query, if <strong id="ces_03_0027__b13527172613810">start</strong> is set to <strong id="ces_03_0027__b51171648144020">al1441967036681YkazZ0deN</strong>, you can start your query from the next alarm rule ID of <strong id="ces_03_0027__b15281426103811">al1441967036681YkazZ0deN</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row13379417402"><td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="ces_03_0027__p333712424012">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="ces_03_0027__p113375414010">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.7%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="ces_03_0027__p233718413401">Specifies the total number of query results.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="ces_03_0027__li51921052">Example response<pre class="screen" id="ces_03_0027__screen5722512195838">{
|
|
"metric_alarms": [
|
|
{
|
|
"alarm_name": "alarm-ttttttt",
|
|
"alarm_description": "",
|
|
"metric": {
|
|
"namespace": "SYS.ECS",
|
|
"dimensions": [
|
|
{
|
|
"name": "instance_id",
|
|
"value": "07814c0e-59a1-4fcd-a6fb-56f2f6923046"
|
|
}
|
|
],
|
|
"metric_name": "cpu_util"
|
|
},
|
|
"condition": {
|
|
"period": 300,
|
|
"filter": "average",
|
|
"comparison_operator": ">=",
|
|
"value": 0,
|
|
"unit": "%",
|
|
"count": 3
|
|
},
|
|
"alarm_enabled": true,
|
|
"alarm_level": 2,
|
|
"alarm_action_enabled": false,
|
|
"alarm_id": "al15330507498596W7vmlGKL",
|
|
"update_time": 1533050749992,
|
|
"alarm_state": "alarm"
|
|
},
|
|
{
|
|
"alarm_name": "alarm-m5rwxxxxxxx",
|
|
"alarm_description": "",
|
|
"metric": {
|
|
"namespace": "SYS.ECS",
|
|
"dimensions": [
|
|
{
|
|
"name": "instance_id",
|
|
"value": "30f3858d-4377-4514-9081-be5bdbf1392e"
|
|
}
|
|
],
|
|
"metric_name": "network_incoming_bytes_aggregate_rate"
|
|
},
|
|
"condition": {
|
|
"period": 300,
|
|
"filter": "average",
|
|
"comparison_operator": ">=",
|
|
"value": 12,
|
|
"unit": "Byte/s",
|
|
"count": 3,
|
|
"suppress_duration": 1800
|
|
},
|
|
"alarm_enabled": true,
|
|
"alarm_level": 2,
|
|
"alarm_action_enabled": true,
|
|
"alarm_actions": [
|
|
{
|
|
"type": "notification",
|
|
"notificationList": [
|
|
"urn:smn:region:68438a86d98e427e907e0097b7e35d48:test0315"
|
|
]
|
|
}
|
|
],
|
|
"ok_actions": [
|
|
{
|
|
"type": "notification",
|
|
"notificationList": [
|
|
"urn:smn:region:68438a86d98e427e907e0097b7e35d48:test0315"
|
|
]
|
|
}
|
|
],
|
|
"alarm_id": "al1533031226533nKJexAlbq",
|
|
"update_time": 1533204036276,
|
|
"alarm_state": "ok"
|
|
}
|
|
],
|
|
"meta_data": {
|
|
"count": 2,
|
|
"marker": "al1533031226533nKJexAlbq",
|
|
"total": 389
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0027__section6956456"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0027__ul20226985"><li id="ces_03_0027__li47825138">Normal<p id="ces_03_0027__p27773061"><a name="ces_03_0027__li47825138"></a><a name="li47825138"></a>200</p>
|
|
</li><li id="ces_03_0027__li48630964">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0027__table86737121379" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0027__row06741212143719"><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_0027__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_0027__p15553712182924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0027__row567491213710"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__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_0027__p164784039168">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row7674121223714"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__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_0027__p218024949168">The authentication information is not provided or is incorrect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row86741912103710"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__p563264059168">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0027__p661449719168">Access to the requested page is forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row1367431214372"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__p355199299168">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0027__p585420329168">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row467461218375"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__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_0027__p37560249168">Concurrent requests are excessive.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row76741712183713"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__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_0027__p618106189168">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0027__row7674212143717"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0027__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_0027__p54144829168">The service is currently unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0027__section121612204463"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0027__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>
|
|
|