vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cts/api-ref/cts_api_0315.html
Liu, Siying 61db61b4e5 CTS API 20230612 version. 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-04-18 10:17:02 +00:00

562 lines
53 KiB
HTML
Raw Blame History

<a name="cts_api_0315"></a><a name="cts_api_0315"></a>
<h1 class="topictitle1">Querying a Key Event Notification</h1>
<div id="body8662426"><div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section107797948896"><h4 class="sectiontitle">Function</h4><p id="cts_api_0315__en-us_topic_0000001213719193_p207071889096">This API is used to query a key event notification.</p>
</div>
<div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section433023442"><h4 class="sectiontitle">API Calling</h4><p id="cts_api_0315__en-us_topic_0000001213719193_p186506434796">For details, see <a href="cts_api_0006.html">Calling APIs</a>.</p>
</div>
<div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section247175425"><h4 class="sectiontitle">URI</h4><p id="cts_api_0315__en-us_topic_0000001213719193_p92872236896">GET /v3/{project_id}/notifications/{notification_type}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_table4841174496" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row74767847496"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p205497666096">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p87937411396">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p23458547496">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="cts_api_0315__en-us_topic_0000001213719193_p26254064096">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row79724519096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p191684665696">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p123334082796">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p27697696496">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0315__en-us_topic_0000001213719193_p113652595596">Project ID. For details, see <a href="cts_api_0005.html">Obtaining an Account ID and Project ID</a>.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row100660622396"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p112292988796">notification_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p9177500996">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p137462493296">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0315__en-us_topic_0000001213719193_p77527833896">Notification type. - <strong id="cts_api_0315__en-us_topic_0000001213719193_b90217395253345">smn</strong>: Simple Message Notification (SMN). - <strong id="cts_api_0315__en-us_topic_0000001213719193_b6369307953345">fun</strong>: FunctionGraph.</p>
<p id="cts_api_0315__en-us_topic_0000001213719193_p27571556196">Enumerated values:</p>
<ul id="cts_api_0315__en-us_topic_0000001213719193_ul783535596"><li id="cts_api_0315__en-us_topic_0000001213719193_li80867496596"><p id="cts_api_0315__en-us_topic_0000001213719193_p148661379996"><a name="cts_api_0315__en-us_topic_0000001213719193_li80867496596"></a><a name="en-us_topic_0000001213719193_li80867496596"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b13537500996">smn</strong></p>
</li><li id="cts_api_0315__en-us_topic_0000001213719193_li52849097696"><p id="cts_api_0315__en-us_topic_0000001213719193_p41032240296"><a name="cts_api_0315__en-us_topic_0000001213719193_li52849097696"></a><a name="en-us_topic_0000001213719193_li52849097696"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b48896074996">fun</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_table134604951796" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row106079327396"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p36882870796">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p81573026396">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p121790085696">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="cts_api_0315__en-us_topic_0000001213719193_p194711818796">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row23196139196"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p59721111796">notification_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p65487860396">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p89207141096">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="cts_api_0315__en-us_topic_0000001213719193_p189428385996">Notification name. If this parameter is not specified, all key event notifications configured in the current tenant account are returned.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section60424461096"><h4 class="sectiontitle">Request Parameters</h4><p id="cts_api_0315__en-us_topic_0000001213719193_p124239923596">None</p>
</div>
<div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section97542947196"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0315__en-us_topic_0000001213719193_p36633743596"><strong id="cts_api_0315__en-us_topic_0000001213719193_b105451010113511">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_response_ListNotificationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row111287114596"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p45834334896">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p41528062896">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p59488422996">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row75578358496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p62933360096">notifications</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p101307152996">Array of <a href="#cts_api_0315__en-us_topic_0000001213719193_response_NotificationsResponseBody">NotificationsResponseBody</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p166776019896">Notification list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0315__en-us_topic_0000001213719193_response_NotificationsResponseBody"></a><a name="en-us_topic_0000001213719193_response_NotificationsResponseBody"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_response_NotificationsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>NotificationsResponseBody</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row166493256796"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p112750698896">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p75713947996">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p88063097796">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row129592798496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p131283245596">notification_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p169606616596">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p81515411696">Notification name.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row193037192096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p208043937396">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p188360786896">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p209450156096">Operation type. Possible options include <strong id="cts_api_0315__en-us_topic_0000001213719193_b195196494153345">complete</strong> and <strong id="cts_api_0315__en-us_topic_0000001213719193_b131749107753345">customized</strong>. If you choose <strong id="cts_api_0315__en-us_topic_0000001213719193_b130769818253345">complete</strong>, notifications will be sent when any supported operation occurs on any of the connected cloud services. If you choose <strong id="cts_api_0315__en-us_topic_0000001213719193_b74025907853345">customized</strong>, notifications will be sent when operations defined in <strong id="cts_api_0315__en-us_topic_0000001213719193_b62686006553345">operations</strong> occur.</p>
<p id="cts_api_0315__en-us_topic_0000001213719193_p128713780196">Enumerated values:</p>
<ul id="cts_api_0315__en-us_topic_0000001213719193_ul12895447896"><li id="cts_api_0315__en-us_topic_0000001213719193_li50451729696"><p id="cts_api_0315__en-us_topic_0000001213719193_p32662197796"><a name="cts_api_0315__en-us_topic_0000001213719193_li50451729696"></a><a name="en-us_topic_0000001213719193_li50451729696"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b104362274696">customized</strong></p>
</li><li id="cts_api_0315__en-us_topic_0000001213719193_li121489762896"><p id="cts_api_0315__en-us_topic_0000001213719193_p170993071596"><a name="cts_api_0315__en-us_topic_0000001213719193_li121489762896"></a><a name="en-us_topic_0000001213719193_li121489762896"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b201488423196">complete</strong></p>
</li></ul>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row77453369896"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p76447485396">operations</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p204396811496">Array of <a href="#cts_api_0315__en-us_topic_0000001213719193_response_Operations">Operations</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p16305725696">Operation list.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row101058743496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p156851756896">notify_user_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p142812604596">Array of <a href="#cts_api_0315__en-us_topic_0000001213719193_response_NotificationUsers">NotificationUsers</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p155125812496">List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row68316748096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p152275672896">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p194689907896">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p197050630796">Notification status. Possible options include <strong id="cts_api_0315__en-us_topic_0000001213719193_b185030945853345">enabled</strong> and <strong id="cts_api_0315__en-us_topic_0000001213719193_b199534932453345">disabled</strong>.</p>
<p id="cts_api_0315__en-us_topic_0000001213719193_p101143921096">Enumerated values:</p>
<ul id="cts_api_0315__en-us_topic_0000001213719193_ul20180407796"><li id="cts_api_0315__en-us_topic_0000001213719193_li114539814996"><p id="cts_api_0315__en-us_topic_0000001213719193_p84368368196"><a name="cts_api_0315__en-us_topic_0000001213719193_li114539814996"></a><a name="en-us_topic_0000001213719193_li114539814996"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b68250064396">enabled</strong></p>
</li><li id="cts_api_0315__en-us_topic_0000001213719193_li191052830296"><p id="cts_api_0315__en-us_topic_0000001213719193_p26713572496"><a name="cts_api_0315__en-us_topic_0000001213719193_li191052830296"></a><a name="en-us_topic_0000001213719193_li191052830296"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b145192909696">disabled</strong></p>
</li></ul>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row15802066696"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p169081974496">topic_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p145638452896">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p23152170696">Topic URN or function URN. To obtain the <strong id="cts_api_0315__en-us_topic_0000001213719193_b129427242353345">topic_urn</strong>, call the SMN API for querying topics. Example URN: <strong id="cts_api_0315__en-us_topic_0000001213719193_b151860352053345">urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2</strong> To obtain the function URN, call the FunctionGraph API for querying functions. Example URN: <strong id="cts_api_0315__en-us_topic_0000001213719193_b155056502453345">urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test</strong></p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row27762499696"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p90223074496">notification_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p118136650596">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p200783183196">Unique notification ID.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row172381147796"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p137402950196">notification_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p94597661096">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p211844034596">Notification type identified based on <strong id="cts_api_0315__en-us_topic_0000001213719193_b130781172853345">topic_id</strong>. Possible options include SMN (<strong id="cts_api_0315__en-us_topic_0000001213719193_b44287472253345">smn</strong>) and FunctionGraph (<strong id="cts_api_0315__en-us_topic_0000001213719193_b204457360853345">fun</strong>).</p>
<p id="cts_api_0315__en-us_topic_0000001213719193_p24044812096">Enumerated values:</p>
<ul id="cts_api_0315__en-us_topic_0000001213719193_ul131075931296"><li id="cts_api_0315__en-us_topic_0000001213719193_li94494733496"><p id="cts_api_0315__en-us_topic_0000001213719193_p29754643896"><a name="cts_api_0315__en-us_topic_0000001213719193_li94494733496"></a><a name="en-us_topic_0000001213719193_li94494733496"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b8068108196">smn</strong></p>
</li><li id="cts_api_0315__en-us_topic_0000001213719193_li161174803496"><p id="cts_api_0315__en-us_topic_0000001213719193_p28176947696"><a name="cts_api_0315__en-us_topic_0000001213719193_li161174803496"></a><a name="en-us_topic_0000001213719193_li161174803496"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b182424184496">fun</strong></p>
</li></ul>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row13141884096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p209991073696">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p50720960096">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p185516265896">Project ID.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row174956739096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p7286101896">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p1526393596">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p172103646996">Timestamp when a notification was created.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row173753033896"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p154511161496">filter</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p82001609696"><a href="#cts_api_0315__en-us_topic_0000001213719193_response_Filter">Filter</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p101174920496">Advanced filter of key event notifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0315__en-us_topic_0000001213719193_response_Operations"></a><a name="en-us_topic_0000001213719193_response_Operations"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_response_Operations" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Operations</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row66810474496"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p57725382896">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p101323680696">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p138919095296">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row110986178296"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p103624540496">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p130403953996">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p30184478796">Cloud service. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in <em id="cts_api_0315__en-us_topic_0000001213719193_i105312572555058">Cloud Trace Service User Guide</em>. You can click the document link of each cloud service to view its acronym.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row140791839496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p49123717096">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p134810839096">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p97533811896">Resource type.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row178179868896"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p24239115096">trace_names</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p122115446496">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p61751545596">Trace name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0315__en-us_topic_0000001213719193_response_NotificationUsers"></a><a name="en-us_topic_0000001213719193_response_NotificationUsers"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_response_NotificationUsers" frame="border" border="1" rules="all"><caption><b>Table 6 </b>NotificationUsers</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row31101405196"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p15635309196">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p179683746996">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p78181097296">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row180039369096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p73007584896">user_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p78340977096">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p37154915196">IAM user group.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row147373301496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p90336907696">user_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p58536093596">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p2983600996">IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cts_api_0315__en-us_topic_0000001213719193_response_Filter"></a><a name="en-us_topic_0000001213719193_response_Filter"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_response_Filter" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Filter</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row15941404696"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p89965014996">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p93076210196">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p163564357796">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row48422378396"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p158856277496">condition</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p26092313896">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p88480854696">Relationship between conditions.</p>
<ul id="cts_api_0315__en-us_topic_0000001213719193_ul68017035596"><li id="cts_api_0315__en-us_topic_0000001213719193_li157981355696"><p id="cts_api_0315__en-us_topic_0000001213719193_p4301928896"><a name="cts_api_0315__en-us_topic_0000001213719193_li157981355696"></a><a name="en-us_topic_0000001213719193_li157981355696"></a>AND (default value) indicates that a rule takes effect after all filtering criteria are met.</p>
</li><li id="cts_api_0315__en-us_topic_0000001213719193_li118836586696"><p id="cts_api_0315__en-us_topic_0000001213719193_p121876375896"><a name="cts_api_0315__en-us_topic_0000001213719193_li118836586696"></a><a name="en-us_topic_0000001213719193_li118836586696"></a>OR indicates that a rule takes effect when one of the filtering criteria is met.</p>
</li></ul>
<p id="cts_api_0315__en-us_topic_0000001213719193_p86083297896">Enumerated values:</p>
<ul id="cts_api_0315__en-us_topic_0000001213719193_ul86089604296"><li id="cts_api_0315__en-us_topic_0000001213719193_li145247153696"><p id="cts_api_0315__en-us_topic_0000001213719193_p53177629296"><a name="cts_api_0315__en-us_topic_0000001213719193_li145247153696"></a><a name="en-us_topic_0000001213719193_li145247153696"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b1260551003519">AND (default value)</strong></p>
</li><li id="cts_api_0315__en-us_topic_0000001213719193_li51674683196"><p id="cts_api_0315__en-us_topic_0000001213719193_p33411220996"><a name="cts_api_0315__en-us_topic_0000001213719193_li51674683196"></a><a name="en-us_topic_0000001213719193_li51674683196"></a><strong id="cts_api_0315__en-us_topic_0000001213719193_b169032341096">OR</strong></p>
</li></ul>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row12610345996"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p59415182896">is_support_filter</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p88406542196">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p53387657396">Whether to enable the advanced filter.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row107512253096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p29133577396">rule</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p175339157096">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p132287765596">Advanced filter criteria rule. Example: <strong id="cts_api_0315__en-us_topic_0000001213719193_b5600738953345">key != value</strong>. The format is <em id="cts_api_0315__en-us_topic_0000001213719193_i131242727853345">field rule value</em>. - Field options: <strong id="cts_api_0315__en-us_topic_0000001213719193_b13378192211">api_version</strong>, <strong id="cts_api_0315__en-us_topic_0000001213719193_b537814962111">code</strong>, <strong id="cts_api_0315__en-us_topic_0000001213719193_b93784992120">trace_rating</strong>, <strong id="cts_api_0315__en-us_topic_0000001213719193_b937819112112">trace_type</strong>, <strong id="cts_api_0315__en-us_topic_0000001213719193_b537812911217">resource_id</strong>, or <strong id="cts_api_0315__en-us_topic_0000001213719193_b1337811920213">resource_name</strong>. - Rule: <strong id="cts_api_0315__en-us_topic_0000001213719193_b98417066253345">!=</strong> or <strong id="cts_api_0315__en-us_topic_0000001213719193_b208588601153345">=</strong>. - Value: <strong id="cts_api_0315__en-us_topic_0000001213719193_b395554322211">api_version</strong>: ^(a-zA-Z0-9_-.){1,64}$; <strong id="cts_api_0315__en-us_topic_0000001213719193_b1695511436223">code</strong>: 1 to 256 characters; <strong id="cts_api_0315__en-us_topic_0000001213719193_b1695594315221">trace_rating</strong>: <strong id="cts_api_0315__en-us_topic_0000001213719193_b99561443172213">normal</strong>, <strong id="cts_api_0315__en-us_topic_0000001213719193_b1695634352210">warning</strong>, or <strong id="cts_api_0315__en-us_topic_0000001213719193_b19956243162214">incident</strong>; <strong id="cts_api_0315__en-us_topic_0000001213719193_b13956174352211">trace_type</strong>: <strong id="cts_api_0315__en-us_topic_0000001213719193_b79561943102214">ConsoleAction</strong>, <strong id="cts_api_0315__en-us_topic_0000001213719193_b12956124314225">ApiCall</strong>, or <strong id="cts_api_0315__en-us_topic_0000001213719193_b139561243152216">SystemAction</strong>; <strong id="cts_api_0315__en-us_topic_0000001213719193_b149577430221">resource_id</strong>: 1 to 350 characters; <strong id="cts_api_0315__en-us_topic_0000001213719193_b1795734362213">resource_name</strong>: 1 to 256 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0315__en-us_topic_0000001213719193_p43604438296"><strong id="cts_api_0315__en-us_topic_0000001213719193_b860810106358">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_response_FailedRsp" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row60212629996"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p17265304396">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p67212941396">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p145741693296">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row36715523796"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p168217099196">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p129300871396">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p32921385096">Error code. Format: <strong id="cts_api_0315__en-us_topic_0000001213719193_b169398682353345">CTS.</strong><em id="cts_api_0315__en-us_topic_0000001213719193_i9308437053345">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row93180408396"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p186843987196">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p146310676996">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p58048779896">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0315__en-us_topic_0000001213719193_p188969579996"><strong id="cts_api_0315__en-us_topic_0000001213719193_b16615710133512">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_table1204353804" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row193092618996"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p151775343296">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p127454188596">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p106386445696">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row181692889996"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p125662381796">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p3399902996">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p151364825096">Error code. Format: <strong id="cts_api_0315__en-us_topic_0000001213719193_b1663021136">CTS.</strong><em id="cts_api_0315__en-us_topic_0000001213719193_i1761370539">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row145804610196"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p1926904396">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p99351287396">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p133418415196">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0315__en-us_topic_0000001213719193_p71011378196"><strong id="cts_api_0315__en-us_topic_0000001213719193_b062291018351">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_table1643074995" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row45650607996"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p46158457396">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p125026617996">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p139390574296">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row11819366496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p178955783396">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p167414417096">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p97694742196">Error code. Format: <strong id="cts_api_0315__en-us_topic_0000001213719193_b1500208956">CTS.</strong><em id="cts_api_0315__en-us_topic_0000001213719193_i53133646">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row14212623696"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p113708985296">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p121936632396">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p201394072996">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0315__en-us_topic_0000001213719193_p130424557796"><strong id="cts_api_0315__en-us_topic_0000001213719193_b11628131023510">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_table12330036" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row212923561596"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p122786610096">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p41089700596">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.15.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p163678435896">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row16070364496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p100617637696">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p100560174196">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p59255744296">Error code. Format: <strong id="cts_api_0315__en-us_topic_0000001213719193_b962238095">CTS.</strong><em id="cts_api_0315__en-us_topic_0000001213719193_i280617647">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row46230742796"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p51267851996">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p3814610896">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p62536735796">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0315__en-us_topic_0000001213719193_p168249136996"><strong id="cts_api_0315__en-us_topic_0000001213719193_b463416107357">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_table1693177150" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row194356806696"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.17.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p148703258496">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.17.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p176518913696">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.17.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p164219743896">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row186958546096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p164995673896">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p185395842596">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.17.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p80777197796">Error code. Format: <strong id="cts_api_0315__en-us_topic_0000001213719193_b2032164132">CTS.</strong><em id="cts_api_0315__en-us_topic_0000001213719193_i696994557">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row89051179196"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p12314981796">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p58365400396">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.17.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p166455086596">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0315__en-us_topic_0000001213719193_p174476695596"><strong id="cts_api_0315__en-us_topic_0000001213719193_b11640310113510">Status code: 503</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_table1666635385" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row51539796196"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.19.2.4.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p97649353096">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.19.2.4.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p89864243496">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.19.2.4.1.3"><p id="cts_api_0315__en-us_topic_0000001213719193_p173022296">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row144417026696"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p113487449296">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p24898508996">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.19.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p43462757696">Error code. Format: <strong id="cts_api_0315__en-us_topic_0000001213719193_b1905015488">CTS.</strong><em id="cts_api_0315__en-us_topic_0000001213719193_i1445093266">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row72797240296"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p155892959296">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p75115030296">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.19.2.4.1.3 "><p id="cts_api_0315__en-us_topic_0000001213719193_p69031858896">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section168385383596"><h4 class="sectiontitle">Example Request</h4><p id="cts_api_0315__en-us_topic_0000001213719193_p47919198396">None</p>
</div>
<div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section206334859596"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0315__en-us_topic_0000001213719193_p80862242596"><strong id="cts_api_0315__en-us_topic_0000001213719193_b898471033516">Status code: 200</strong></p>
<p id="cts_api_0315__en-us_topic_0000001213719193_p107464064996">The query is successful.</p>
<pre class="screen" id="cts_api_0315__en-us_topic_0000001213719193_screen103774295096">{
"notifications" : [ {
"create_time" : 1633933167385,
"notify_user_list" : [ {
"user_group" : "admin",
"user_list" : [ "test1", "test2" ]
}, {
"user_group" : "CTS view",
"user_list" : [ "test3", "test4" ]
} ],
"notification_id" : "0b98e1c2-2fd6-4e33-a355-f9e12eaab88a",
"notification_name" : "test2",
"notification_type" : "smn",
"operation_type" : "customized",
"operations" : [ {
"resource_type" : "tracker",
"service_type" : "CTS",
"trace_names" : [ "createTracker" ]
}, {
"resource_type" : "notification",
"service_type" : "CTS",
"trace_names" : [ "deleteNotification", "updateNotification" ]
}, {
"resource_type" : "pe",
"service_type" : "AOM",
"trace_names" : [ "createPolicyGroup", "updatePolicyGroup", "deletePolicyGroup" ]
} ],
"project_id" : "24edf66e79d04187acb99a463e610764",
"status" : "enabled",
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
}, {
"create_time" : 1633924057706,
"notify_user_list" : [ {
"user_group" : "admin",
"user_list" : [ "test1", "test2" ]
}, {
"user_group" : "CTS view",
"user_list" : [ "test3", "test4" ]
} ],
"notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8",
"notification_name" : "test1",
"notification_type" : "smn",
"operation_type" : "complete",
"operations" : [ ],
"project_id" : "24edf66e79d04187acb99a463e610764",
"status" : "disabled"
} ]
}</pre>
</div>
<div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section213294315096"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__en-us_topic_0000001213719193_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0315__en-us_topic_0000001213719193_row64237153096"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="cts_api_0315__en-us_topic_0000001213719193_p106834806096">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="cts_api_0315__en-us_topic_0000001213719193_p151452676396">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0315__en-us_topic_0000001213719193_row49681036796"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p35193042396">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p91300426196">The query is successful.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row17681969296"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p51122040496">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p65575673796">The server failed to process the request.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row101280684596"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p128536885296">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p96681692796">The request is rejected due to authentication failure.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row167361749596"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p151063599996">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p69687317896">The server understood the request but refused to authorize it.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row157785989196"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p191946560596">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p195141877896">The server failed to find the requested resource or some key event notifications failed to be deleted.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row200755695896"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p150788526296">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p23681618196">The request failed to be executed or some trackers failed to be deleted.</p>
</td>
</tr>
<tr id="cts_api_0315__en-us_topic_0000001213719193_row127607384396"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0315__en-us_topic_0000001213719193_p33636114396">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0315__en-us_topic_0000001213719193_p162306339796">The requested service is invalid. The client should not repeat the request without modifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0315__en-us_topic_0000001213719193_section94309907196"><h4 class="sectiontitle">Error Code</h4><p id="cts_api_0315__en-us_topic_0000001213719193_p92139813196">For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Key Event Notification Management</a></div>
</div>
</div>
View Git Blame Copy Permalink