forked from docs/doc-exports
Ying, Jiayu
14be087a3b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Ying, Jiayu <jiayuying1@huawei.com> Co-committed-by: Ying, Jiayu <jiayuying1@huawei.com>
143 lines
10 KiB
HTML
143 lines
10 KiB
HTML
<a name="cts_api_0314"></a><a name="cts_api_0314"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Key Event Notification</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_0314__section38121923028"><h4 class="sectiontitle">Function</h4><p id="cts_api_0314__p1881292313216">This API is used to delete a key event notification.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0314__section138149234210"><h4 class="sectiontitle">URI</h4><p id="cts_api_0314__p20815152316215">DELETE /v3/{project_id}/notifications</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0314__table14818142313219" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="cts_api_0314__row781615231728"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_0314__p10818182316211">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="cts_api_0314__p2819182316217">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="cts_api_0314__p10819142314216">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="cts_api_0314__p382012231223">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0314__row1817923124"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0314__p1082017238220">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0314__p1582115231215">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0314__p682142317211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0314__p08222232213">Project ID. For details, see section "Obtaining the Account ID and Project ID" in <em id="cts_api_0314__i19298242141616">Cloud Trace Service API Reference</em>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0314__table5825112312214" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameter</caption><thead align="left"><tr id="cts_api_0314__row98235231929"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="cts_api_0314__p28259231922">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="cts_api_0314__p98261232213">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="cts_api_0314__p082617231427">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="cts_api_0314__p13826923424">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0314__row78241123626"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cts_api_0314__p28271523128">notification_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cts_api_0314__p8827172312218">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cts_api_0314__p20830623921">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cts_api_0314__p208314232216">Notification ID. To batch delete notifications, enter multiple notification IDs separated by commas (,), for example, <strong id="cts_api_0314__b16564144651711">notification_id="</strong><strong id="cts_api_0314__b8291112204813">xxx1</strong><strong id="cts_api_0314__b1498112564173">,</strong><strong id="cts_api_0314__b1796614155485">ccc2</strong><strong id="cts_api_0314__b145171929184">"</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0314__section783416231829"><h4 class="sectiontitle">Request Parameters</h4><p id="cts_api_0314__p983522314219">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0314__section198359231529"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0314__p14836923622"><strong id="cts_api_0314__b1918141611814">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0314__en-us_topic_0000001167919326_response_FailedRsp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0314__row12837182318211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="cts_api_0314__p2083919231420">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="cts_api_0314__p584012315216">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="cts_api_0314__p88401823328">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0314__row383719231126"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0314__p20841723527">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0314__p1784112237212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0314__p1384218231422">Error code. Format: <strong id="cts_api_0314__b1889673121914">CTS.</strong><em id="cts_api_0314__i1190313391918">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0314__row7837152319215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0314__p28421123729">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0314__p78422237213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0314__p5843102319218">Error description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0314__section1843142313219"><h4 class="sectiontitle">Example Request</h4><p id="cts_api_0314__p1084414238220">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0314__section1084472314220"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0314__p784522314216">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0314__section1684572317214"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0314__en-us_topic_0000001167919326_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0314__row5850223324"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_0314__p28532023227">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="cts_api_0314__p9854112313219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0314__row385082310214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0314__p1855192310210">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0314__p1185612231322">The deletion is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0314__row28513231823"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0314__p38569231521">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0314__p28571323126">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0314__row10851623726"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0314__p18571623725">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0314__p986152311218">The request is rejected due to authentication failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0314__row2851202313218"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0314__p1986218231211">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0314__p38621723921">The server understood the request but refused to authorize it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0314__row8852152310216"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0314__p0863923928">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0314__p186313236215">The server failed to find the requested resource or some key event notifications failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0314__row78531237215"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0314__p986418231024">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0314__p15865142310213">The request failed to be executed or some trackers failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0314__row1385314233219"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0314__p486613231229">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0314__p1586716231422">The requested service is unavailable. The client should not repeat the request without modifications.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0314__section1886714232028"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_0314__p1286717231125">See <a href="en-us_topic_0168602259.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Key Event Notification Management</a></div>
|
|
</div>
|
|
</div>
|
|
|