vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/aom/api-ref/aom_04_1019.html
Hasko, Vladimir bbf8757cdf AOM API 0929 (recreate of #275) 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-11-29 12:44:31 +00:00

518 lines
36 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="aom_04_1019"></a><a name="aom_04_1019"></a>
<h1 class="topictitle1">Modifying a Threshold Rule</h1>
<div id="body1606983050300"><div class="section" id="aom_04_1019__section762365422310"><h4 class="sectiontitle">Function</h4><p id="aom_04_1019__p2624165415230">This API is used to modify a threshold rule.</p>
</div>
<div class="section" id="aom_04_1019__section206241354102311"><h4 class="sectiontitle">URI</h4><p id="aom_04_1019__p162455442316">PUT /v2/{project_id}/ams/alarms</p>
</div>
<div class="section" id="aom_04_1019__section652491410263"><h4 class="sectiontitle">Request</h4><p id="aom_04_1019__p85246147260"><strong id="aom_04_1019__b1852411442616">Request parameters</strong></p>
<p id="aom_04_1019__p2524714182620"><a href="#aom_04_1019__table4524101420262">Table 1</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="aom_04_1019__table4524101420262"></a><a name="table4524101420262"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1019__table4524101420262" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="aom_04_1019__row105241514152620"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.6.1.1"><p id="aom_04_1019__p1452411142267">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.4.2.6.1.2"><p id="aom_04_1019__p8525191432614">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.4.2.6.1.3"><p id="aom_04_1019__p75259141264">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.3.4.2.6.1.4"><p id="aom_04_1019__p1252521492615">Value Range</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.3.4.2.6.1.5"><p id="aom_04_1019__p155258141269">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1019__row152531410269"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p2367185911539">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p63671959185317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p1236745945316">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p236745910536">-</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p2367659165315">Project ID obtained from IAM. Generally, a project ID contains 32 characters.</p>
</td>
</tr>
<tr id="aom_04_1019__row65251414122614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p11368135995312">statistic</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p636845955314">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p336805919534">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p5616339184611">maximum, minimum, average, sum, or sampleCount.</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p7368559185310">Statistic.</p>
</td>
</tr>
<tr id="aom_04_1019__row1891732184815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p16892183217488">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p148921632144810">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p168936323488">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p213465522913">1–255 characters. Colons (:) are not allowed.</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p78938327486">Namespace. The value transferred to the backend when a threshold rule is added will be used. The value transferred here will not replace that value.</p>
</td>
</tr>
<tr id="aom_04_1019__row798110361489"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p1698103634812">metricName</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p1798119368485">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p698112364486">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p49817364480">1–255 characters.</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p99819367484">Metric name. The value transferred to the backend when a threshold rule is added will be used. The value transferred here will not replace that value.</p>
</td>
</tr>
<tr id="aom_04_1019__row171612440481"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p41634414814">period</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p19161444204817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p616544174811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p103968223305">20000, 60000, 300000, 900000, 1800000, 3600000, 14400000, or 86400000</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p14168448484">Statistical period.</p>
</td>
</tr>
<tr id="aom_04_1019__row514013415486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p4140184184813">alarmLevel</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p21401941134811">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p15140124114811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p16640940173020">4, 3, 2, or 1</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p11140114110481">Alarm severity.</p>
</td>
</tr>
<tr id="aom_04_1019__row11567112917111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p456716291019">evaluationPeriods</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p656762914110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p1756710291013">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p1364120403305">4, 3, or 2</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p10567129519">Number of consecutive periods.</p>
</td>
</tr>
<tr id="aom_04_1019__row519511391614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p219511391117">comparisonOperator</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p1119511399110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p2019511391419">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p8641174019307">&gt;, &gt;=, &lt;, or &lt;=</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p519510391319">Comparison operator.</p>
</td>
</tr>
<tr id="aom_04_1019__row207578421917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p1575784217112">threshold</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p97579421712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p4757104218118">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p764174063015">Non-null value that can be converted to a value of the <strong id="aom_04_1019__b628182229105237">double</strong> type. Once converted, the value cannot be null, or be a positive or negative infinity.</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p197574421118">Threshold.</p>
</td>
</tr>
<tr id="aom_04_1019__row1413017461316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p31307465116">alarmName</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p121301463118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p51315461119">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p964164012303">1–255 characters. Special characters are not allowed.</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p71311846412">Threshold name.</p>
</td>
</tr>
<tr id="aom_04_1019__row1320314492116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p1320314916113">dimensions</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p152035491014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p120384910110">List</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p10641114013017">Non-null; size &lt; 100</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p1820384917111">Metric dimension. The value transferred to the backend when a threshold rule is added will be used. The value transferred here will not replace that value.</p>
</td>
</tr>
<tr id="aom_04_1019__row131549221875"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p015415221673">unit</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p9154322279">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p191542221870">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p13154222476">Number of characters &lt; 32</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p191544221171">Metric unit. The value transferred to the backend when a threshold rule is added will be used. The value transferred here will not replace that value.</p>
</td>
</tr>
<tr id="aom_04_1019__row1790812416715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p790842414719">actionEnabled</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p149083245710">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p159087248713">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p129081724478">-</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p29089241670">Whether to enable the alarm function.</p>
</td>
</tr>
<tr id="aom_04_1019__row1248133220712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p1224815323715">alarmActions</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p1248133212714">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p924812321976">Array</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p228217529314">Size ≤ 5</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p1724816321719">Alarm action.</p>
</td>
</tr>
<tr id="aom_04_1019__row6743734175"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p474311347720">alarmAdvice</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p174363411715">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p12743133419713">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p18282165216310">Number of characters &lt; 255</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p1074310347714">Alarm suggestion. Leave this parameter blank.</p>
</td>
</tr>
<tr id="aom_04_1019__row98461871191"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p5846275916">alarmDescription</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p7846171294">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p1284627495">String</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p1928211529312">Number of characters &lt; 255</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p12846157795">Threshold rule description.</p>
</td>
</tr>
<tr id="aom_04_1019__row7179312792"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p91794121293">insufficientDataActions</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p161791124919">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p1217911214913">Array</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p20282155217314">Size ≤ 5</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p21797128910">Action to be taken when data is insufficient.</p>
</td>
</tr>
<tr id="aom_04_1019__row478018501595"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1019__p27801450999">okActions</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1019__p147805505918">No</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1019__p77801850795">Array</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1019__p192821652193111">Size ≤ 5</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1019__p878012503917">Recovery action.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="aom_04_1019__p13501584343"><strong id="aom_04_1019__b1024195414120">Request headers</strong></p>
<p class="msonormal" id="aom_04_1019__p19248500157"><a href="#aom_04_1019__table17428844137">Table 2</a> describes the request headers.</p>
<div class="tablenoborder"><a name="aom_04_1019__table17428844137"></a><a name="table17428844137"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1019__table17428844137" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request headers</caption><thead align="left"><tr id="aom_04_1019__row1542824171318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.4.1.1"><p id="aom_04_1019__p18428241134">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.4.1.2"><p id="aom_04_1019__p1142819412139">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.3.7.2.4.1.3"><p id="aom_04_1019__p1742816441311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1019__row1942834191319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.4.1.1 "><p id="aom_04_1019__p166451516193818">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.4.1.2 "><p id="aom_04_1019__p464591643812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.7.2.4.1.3 "><p id="aom_04_1019__p156451416173813">User token obtained from IAM.</p>
</td>
</tr>
<tr id="aom_04_1019__row2428124181313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.4.1.1 "><p id="aom_04_1019__p464641619384">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.4.1.2 "><p id="aom_04_1019__p464631663813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.7.2.4.1.3 "><p id="aom_04_1019__p1464691683810">Content type, which is <strong id="aom_04_1019__b1140446709105237">application/json</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="aom_04_1019__p162718542237"><strong id="aom_04_1019__b1627175482317">Example request</strong></p>
<pre class="screen" id="aom_04_1019__screen15627154122310">{
"actionEnabled": false,
"alarmActions": [],
"alarmAdvice": "",
"alarmDescription": "",
"alarmLevel": 3,
"alarmName": "aaaaaaaa",
"comparisonOperator": "&gt;=",
"dimensions": [
{
"name": "appName",
"value": "rhm-broker"
}
],
"evaluationPeriods": 1,
"insufficientDataActions": [],
"metricName": "cpuCoreLimit",
"namespace": "PAAS.CONTAINER",
"okActions": [],
"period": 60000,
"statistic": "average",
"threshold": 0,
"unit": "Core"
}</pre>
<div class="section" id="aom_04_1019__section1162720548234"><h4 class="sectiontitle">Response</h4><p id="aom_04_1019__p2059282245717"><strong id="aom_04_1019__b1659212210574">Response parameters</strong></p>
<p id="aom_04_1019__p15592142215717"><a href="#aom_04_1019__table5592922105719">Table 3</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="aom_04_1019__table5592922105719"></a><a name="table5592922105719"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1019__table5592922105719" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="aom_04_1019__row559322275717"><th align="left" class="cellrowborder" valign="top" width="29.7029702970297%" id="mcps1.3.6.4.2.4.1.1"><p id="aom_04_1019__p659322214577">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.633663366336634%" id="mcps1.3.6.4.2.4.1.2"><p id="aom_04_1019__p10593622175714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.663366336633665%" id="mcps1.3.6.4.2.4.1.3"><p id="aom_04_1019__p25931822125720">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1019__row2593112295714"><td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.6.4.2.4.1.1 "><p id="aom_04_1019__p6593522155718">errorCode</p>
</td>
<td class="cellrowborder" valign="top" width="36.633663366336634%" headers="mcps1.3.6.4.2.4.1.2 "><p id="aom_04_1019__p459313228576">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.6.4.2.4.1.3 "><p id="aom_04_1019__p759342218574">Response code.</p>
</td>
</tr>
<tr id="aom_04_1019__row12593102218578"><td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.6.4.2.4.1.1 "><p id="aom_04_1019__p16593422185719">errorMessage</p>
</td>
<td class="cellrowborder" valign="top" width="36.633663366336634%" headers="mcps1.3.6.4.2.4.1.2 "><p id="aom_04_1019__p259322245711">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.6.4.2.4.1.3 "><p id="aom_04_1019__p1559382215574">Response message.</p>
</td>
</tr>
<tr id="aom_04_1019__row19884621185815"><td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.6.4.2.4.1.1 "><p id="aom_04_1019__p1288482145819">alarmId</p>
</td>
<td class="cellrowborder" valign="top" width="36.633663366336634%" headers="mcps1.3.6.4.2.4.1.2 "><p id="aom_04_1019__p588442175812">Long</p>
</td>
<td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.6.4.2.4.1.3 "><p id="aom_04_1019__p2884182118587">Threshold rule code.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="aom_04_1019__p13627105472316"><strong id="aom_04_1019__b662755432311">Example response</strong></p>
<pre class="screen" id="aom_04_1019__screen1627854172315">{
"errorCode": "AOM.0200",
"errorMessage": "success",
"alarmId": 12345678
}</pre>
</div>
<div class="section" id="aom_04_1019__section1662775472315"><h4 class="sectiontitle">Status Code</h4><ul id="aom_04_1019__ul46272543233"><li id="aom_04_1019__li96272547232">Success response<p id="aom_04_1019__p36285547236"><a name="aom_04_1019__li96272547232"></a><a name="li96272547232"></a><a href="#aom_04_1019__table86491459125016">Table 4</a> describes the status code.</p>
<div class="tablenoborder"><a name="aom_04_1019__table86491459125016"></a><a name="table86491459125016"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1019__table86491459125016" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="aom_04_1019__row58979846"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.2.2.4.1.1"><p id="aom_04_1019__p12638194">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.2.2.4.1.2"><p id="aom_04_1019__p18261589486">Message</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.2.1.2.2.4.1.3"><p id="aom_04_1019__p17060819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1019__row39749137"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="aom_04_1019__p65563539">200</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="aom_04_1019__p115208125323">OK</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="aom_04_1019__p19579466497">The request has succeeded.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="aom_04_1019__li8628145452314">Error response<p id="aom_04_1019__p17628554152320"><a name="aom_04_1019__li8628145452314"></a><a name="li8628145452314"></a><a href="#aom_04_1019__table939134985614">Table 5</a> describes the status codes. For more information, see <a href="aom_04_0018.html">Status Codes</a>.</p>
<div class="tablenoborder"><a name="aom_04_1019__table939134985614"></a><a name="table939134985614"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1019__table939134985614" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="aom_04_1019__row44141239"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.2.2.2.4.1.1"><p id="aom_04_1019__p18670586">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.2.2.2.4.1.2"><p id="aom_04_1019__p47075245288">Message</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.2.2.2.2.4.1.3"><p id="aom_04_1019__p35922469">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1019__row24038881"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.1 "><p id="aom_04_1019__p992341">400</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.2 "><p id="aom_04_1019__p126271018112520">Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.2.2.2.2.4.1.3 "><p id="aom_04_1019__p2431727192515">The request is invalid. </p>
<p id="aom_04_1019__p34352717254">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="aom_04_1019__row52328576"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.1 "><p id="aom_04_1019__p10756297">401</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.2 "><p id="aom_04_1019__p195759466253">Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.2.2.2.2.4.1.3 "><p id="aom_04_1019__p1371123810254">The authorization information provided by the client is incorrect or invalid.</p>
</td>
</tr>
<tr id="aom_04_1019__row56712700"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.1 "><p id="aom_04_1019__p30325987">403</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.2 "><p id="aom_04_1019__p15185125614254">Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.2.2.2.2.4.1.3 "><p id="aom_04_1019__p10447844263">The request is rejected.</p>
<p id="aom_04_1019__p20447941267">The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications. </p>
</td>
</tr>
<tr id="aom_04_1019__row28828553"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.1 "><p id="aom_04_1019__p53411432">500</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.2 "><p id="aom_04_1019__p2945812153211">Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.2.2.2.2.4.1.3 "><p id="aom_04_1019__p1815584516269">The server is able to receive the request but unable to understand the request.</p>
</td>
</tr>
<tr id="aom_04_1019__row13793060"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.1 "><p id="aom_04_1019__p43496037">503</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.2.2.2.4.1.2 "><p id="aom_04_1019__p205675500263">Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.2.2.2.2.4.1.3 "><p id="aom_04_1019__p4668115672614">The requested service is invalid.</p>
<p id="aom_04_1019__p14669256182611">The client should not repeat the request without modifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="aom_04_1019__section180881121217"><h4 class="sectiontitle">Error Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1019__table4880211161220" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Error codes</caption><thead align="left"><tr id="aom_04_1019__row58767117124"><th align="left" class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.3.8.2.2.4.1.1"><p id="aom_04_1019__p1287611131219">Error Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.61616161616162%" id="mcps1.3.8.2.2.4.1.2"><p id="aom_04_1019__p14876141115124">Message</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.05050505050505%" id="mcps1.3.8.2.2.4.1.3"><p id="aom_04_1019__p1687631110123">Solution</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1019__row128792110126"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p133916367131">AOM.0101</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p194009964318">Invalid alarm name.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p1039336141314">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row887931191214"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p1439193618136">AOM.0102</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p7400791432">The threshold rule name already exists.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p38088598326">Use another name.</p>
</td>
</tr>
<tr id="aom_04_1019__row1687961171220"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p53943613137">AOM.0103</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p124001797432">Invalid alarm description.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p1439173621312">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row16880411161212"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p93943611311">AOM.0104</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p5400129114311">Invalid alarm threshold.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p1139193618139">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row199791311201315"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p1739143671313">AOM.0105</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p17401149174316">Invalid alarm period.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p1739103615134">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row19979911201318"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p441123621317">AOM.0106</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p184018934311">Invalid email list.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p1241143691311">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row13979131151313"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p144153616134">AOM.0107</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p74011954310">The maximum number of threshold rules has been reached.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p2978142918364">Contact technical support to expand the capacity.</p>
</td>
</tr>
<tr id="aom_04_1019__row99791811111318"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p14411236151312">AOM.0108</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p10401694434">Invalid time range for alarm queries.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p8411636191317">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row1097901151318"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p13411936171311">AOM.0109</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p1640249124314">Invalid project ID.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p7411236161319">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row19977181191319"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p113717367137">AOM.0115</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p1940269114313">Invalid request parameter.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p153713361132">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row11947161411313"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p6381636181319">AOM.0118</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p840215914436">Invalid number of consecutive periods.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p183819360138">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row594741413133"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p1338173671318">AOM.0119</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p104021984319">Invalid alarm statistic.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p238123614130">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row149478147137"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p338736151318">AOM.0120</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p1340313913433">Invalid alarm comparison operator.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p1738163611137">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1019__row1794711148130"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p438133618136">AOM.0121</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p1640314919436">The alarm does not exist.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p73918360139">Check whether the threshold rule exists.</p>
</td>
</tr>
<tr id="aom_04_1019__row17946121431313"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.8.2.2.4.1.1 "><p id="aom_04_1019__p15375363133">AOM.0500</p>
</td>
<td class="cellrowborder" valign="top" width="33.61616161616162%" headers="mcps1.3.8.2.2.4.1.2 "><p id="aom_04_1019__p174034934310">Internal server error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.05050505050505%" headers="mcps1.3.8.2.2.4.1.3 "><p id="aom_04_1019__p537536201315">Contact technical support.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_1045.html">Monitoring APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink