forked from docs/doc-exports
Hasko, Vladimir
bbf8757cdf
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>
228 lines
16 KiB
HTML
228 lines
16 KiB
HTML
<a name="aom_04_1017"></a><a name="aom_04_1017"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Threshold Rule</h1>
|
|
<div id="body1606983050342"><div class="section" id="aom_04_1017__section56222540"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="aom_04_1017__p60360818">This API is used to delete a threshold rule.</p>
|
|
</div>
|
|
<div class="section" id="aom_04_1017__section36240817"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="aom_04_1017__p57388118">DELETE /v2/{project_id}/ams/alarms/{alarm_id}</p>
|
|
</div>
|
|
<div class="section" id="aom_04_1017__section57731898"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="aom_04_1017__p17925982"><strong id="aom_04_1017__b27116115">Request parameters</strong></p>
|
|
<p class="msonormal" id="aom_04_1017__p42718451"><a href="#aom_04_1017__d0e3568">Table 1</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="aom_04_1017__d0e3568"></a><a name="d0e3568"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1017__d0e3568" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="aom_04_1017__row37419966"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.6.1.1"><p id="aom_04_1017__p11118435">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_1017__p28178065">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_1017__p721903">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_1017__p58474149">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_1017__p38785628">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="aom_04_1017__row54628155"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1017__p62804459">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1017__p53996436">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1017__p11635165">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1017__p2924270">-</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1017__p35539312">Project ID obtained from IAM. Generally, a project ID contains 32 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="aom_04_1017__row51418354"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1017__p4137184">alarm_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1017__p66676498">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1017__p32087281">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1017__p15471253173220">Non-null value that can be converted to a value of the <strong id="aom_04_1017__b806827961105355">long</strong> type.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1017__p4147156">Threshold rule ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="aom_04_1017__p13501584343"><strong id="aom_04_1017__b1024195414120">Request headers</strong></p>
|
|
<p class="msonormal" id="aom_04_1017__p19248500157"><a href="#aom_04_1017__table17428844137">Table 2</a> describes the request headers.</p>
|
|
|
|
<div class="tablenoborder"><a name="aom_04_1017__table17428844137"></a><a name="table17428844137"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1017__table17428844137" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request headers</caption><thead align="left"><tr id="aom_04_1017__row1542824171318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.4.1.1"><p id="aom_04_1017__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_1017__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_1017__p1742816441311">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="aom_04_1017__row1942834191319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.4.1.1 "><p id="aom_04_1017__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_1017__p464591643812">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.7.2.4.1.3 "><p id="aom_04_1017__p156451416173813">User token obtained from IAM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="aom_04_1017__row2428124181313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.4.1.1 "><p id="aom_04_1017__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_1017__p464631663813">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.7.2.4.1.3 "><p id="aom_04_1017__p1464691683810">Content type, which is <strong id="aom_04_1017__b1913074723105355">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p class="msonormal" id="aom_04_1017__p37324406"><strong id="aom_04_1017__b375336">Example request</strong></p>
|
|
<pre class="screen" id="aom_04_1017__screen3378027">/v2/{project_id}/ams/alarms/al1441967036681YkazZ0deN</pre>
|
|
</div>
|
|
<div class="section" id="aom_04_1017__section49825042"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="aom_04_1017__p5184785"><strong id="aom_04_1017__b46663070">Response parameters</strong></p>
|
|
<p class="msonormal" id="aom_04_1017__p17314447"><a href="#aom_04_1017__d0e3648">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="aom_04_1017__d0e3648"></a><a name="d0e3648"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1017__d0e3648" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="aom_04_1017__row43591827"><th align="left" class="cellrowborder" valign="top" width="29.592959295929592%" id="mcps1.3.4.4.2.4.1.1"><p id="aom_04_1017__p41277099">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.733673367336735%" id="mcps1.3.4.4.2.4.1.2"><p id="aom_04_1017__p55110736">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.673367336733676%" id="mcps1.3.4.4.2.4.1.3"><p id="aom_04_1017__p34784617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="aom_04_1017__row66090591"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1017__p51737625">errorCode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1017__p29998079">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1017__p13925371">Response code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="aom_04_1017__row58219475"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1017__p18157064">errorMessage</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1017__p61436102">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1017__p10268340">Response message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p class="msonormal" id="aom_04_1017__p25306196"><strong id="aom_04_1017__b26429178">Example response</strong></p>
|
|
<pre class="screen" id="aom_04_1017__screen59644336">{
|
|
"errorCode": "AOM.0200",
|
|
"errorMessage": "Delete Threshold [xxx] successfully ."
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="aom_04_1017__section45772201"><h4 class="sectiontitle">Status Code</h4><ul id="aom_04_1017__ul66461936"><li id="aom_04_1017__li61286518">Success response<p id="aom_04_1017__p14707753"><a name="aom_04_1017__li61286518"></a><a name="li61286518"></a><a href="#aom_04_1017__table86491459125016">Table 4</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="aom_04_1017__table86491459125016"></a><a name="table86491459125016"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1017__table86491459125016" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="aom_04_1017__row58979846"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="aom_04_1017__p12638194">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="aom_04_1017__p18261589486">Message</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="aom_04_1017__p17060819">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="aom_04_1017__row39749137"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="aom_04_1017__p65563539">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="aom_04_1017__p115208125323">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="aom_04_1017__p19579466497">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="aom_04_1017__ul12103413"><li id="aom_04_1017__li41821856">Error response<p id="aom_04_1017__p141421095814"><a name="aom_04_1017__li41821856"></a><a name="li41821856"></a><a href="#aom_04_1017__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_1017__table939134985614"></a><a name="table939134985614"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1017__table939134985614" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="aom_04_1017__row44141239"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.3.1.2.2.4.1.1"><p id="aom_04_1017__p18670586">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.3.1.2.2.4.1.2"><p id="aom_04_1017__p47075245288">Message</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.3.1.2.2.4.1.3"><p id="aom_04_1017__p35922469">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="aom_04_1017__row24038881"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1017__p992341">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1017__p126271018112520">Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1017__p2431727192515">The request is invalid.</p>
|
|
<p id="aom_04_1017__p34352717254">The client should not repeat the request without modifications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="aom_04_1017__row52328576"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1017__p10756297">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1017__p195759466253">Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1017__p1371123810254">The authorization information provided by the client is incorrect or invalid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="aom_04_1017__row56712700"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1017__p30325987">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1017__p15185125614254">Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1017__p10447844263">The request is rejected.</p>
|
|
<p id="aom_04_1017__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_1017__row28828553"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1017__p53411432">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1017__p2945812153211">Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1017__p1815584516269">The server is able to receive the request but unable to understand the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="aom_04_1017__row13793060"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1017__p43496037">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1017__p205675500263">Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1017__p4668115672614">The requested service is invalid.</p>
|
|
<p id="aom_04_1017__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_1017__section180881121217"><h4 class="sectiontitle">Error Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1017__table4880211161220" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Error codes</caption><thead align="left"><tr id="aom_04_1017__row58767117124"><th align="left" class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.3.6.2.2.4.1.1"><p id="aom_04_1017__p1287611131219">Error Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.3.6.2.2.4.1.2"><p id="aom_04_1017__p14876141115124">Message</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.3.6.2.2.4.1.3"><p id="aom_04_1017__p1687631110123">Solution</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="aom_04_1017__row1687961171220"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1017__p20954103981711">AOM.0115</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1017__p3487104317473">Invalid request parameter.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1017__p7954113941718">Check whether the parameter meets requirements.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="aom_04_1017__row16880411161212"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1017__p495453931711">AOM.0501</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1017__p6487104384716">The Cassandra session is null.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1017__p79541039101711">Contact technical support.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="aom_04_1017__row199791311201315"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1017__p2954133991712">AOM.0502</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1017__p148784310478">The Cassandra execution is abnormal.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1017__p16954183941711">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>
|
|
|