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>
371 lines
26 KiB
HTML
371 lines
26 KiB
HTML
<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__section3732839545"><h4 class="sectiontitle">Function</h4><p id="cts_api_0315__p37321339943">This API is used to query a key event notification.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0315__section1773323918410"><h4 class="sectiontitle">URI</h4><p id="cts_api_0315__p1173303918412">GET /v3/{project_id}/notifications/{notification_type}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__table2073493917420" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="cts_api_0315__row5734103920413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_0315__p17342039244">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_0315__p157351939741">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_0315__p1773513916417">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_0315__p6735193914420">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0315__row1173463912414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0315__p1973513390418">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0315__p1573623912410">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0315__p117365398419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0315__p14736183911413">Project ID. For details, see section "Obtaining the Account ID and Project ID" in <em id="cts_api_0315__i1528514213183">Cloud Trace Service API Reference</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row11734163916415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0315__p373643914414">notification_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0315__p157371739345">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0315__p6737113913416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0315__p1673714392046">Notification type.</p>
|
|
<p id="cts_api_0315__p157376393419">Enumerated value:</p>
|
|
<ul id="cts_api_0315__ul15737123912413"><li id="cts_api_0315__li137375398411"><strong id="cts_api_0315__b1973893910418">smn</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0315__table11739939148" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameter</caption><thead align="left"><tr id="cts_api_0315__row117381239242"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="cts_api_0315__p67393395418">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_0315__p18739039347">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_0315__p1739153918413">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_0315__p1673913911410">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0315__row15738739348"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cts_api_0315__p1974093912419">notification_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cts_api_0315__p1774011398413">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cts_api_0315__p147401039946">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cts_api_0315__p17403391749">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__section1174163916418"><h4 class="sectiontitle">Request Parameters</h4><p id="cts_api_0315__p2741639144">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0315__section167417399420"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0315__p3741143910419"><strong id="cts_api_0315__b14742183914410">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 parameter</caption><thead align="left"><tr id="cts_api_0315__row474243917419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="cts_api_0315__p147423391149">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_0315__p974312391417">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_0315__p774317391944">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0315__row67423393415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0315__p274318393414">notifications</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0315__p9744103916417">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.4.3.2.4.1.3 "><p id="cts_api_0315__p17448391147">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__row1874419391748"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="cts_api_0315__p774519397414">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="cts_api_0315__p97453395415">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="cts_api_0315__p07460393418">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0315__row1874410391742"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p117469396413">notification_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p137461339549">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0315__p2746239841">Notification name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row1474415393415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p374720391146">operation_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p15747133912411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0315__p13747839046">Operation type. Possible options include <strong id="cts_api_0315__b223411342213">complete</strong> and <strong id="cts_api_0315__b123581312210">customized</strong>. If you choose <strong id="cts_api_0315__b16178101515223">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__b174981817102219">customized</strong>, notifications will be sent when operations defined in <strong id="cts_api_0315__b15499101713223">operations</strong> occur.</p>
|
|
<p id="cts_api_0315__p1874712397416">Enumerated values:</p>
|
|
<ul id="cts_api_0315__ul0748183917416"><li id="cts_api_0315__li9748639149"><strong id="cts_api_0315__b9748193917417">customized</strong></li><li id="cts_api_0315__li107483399416"><strong id="cts_api_0315__b147481639841">complete</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row774403920418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p874817390410">operations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p17491939544">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.4.4.2.4.1.3 "><p id="cts_api_0315__p18749183915411">Operation list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row1774420391046"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p117494395413">notify_user_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p1749113919414">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.4.4.2.4.1.3 "><p id="cts_api_0315__p67502391744">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__row13744173910412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p675015398420">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p14750103912410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0315__p7750239743">Notification status. Possible options include <strong id="cts_api_0315__b1413182911221">enabled</strong> and <strong id="cts_api_0315__b51375294226">disabled</strong>.</p>
|
|
<p id="cts_api_0315__p13750163919418">Enumerated values:</p>
|
|
<ul id="cts_api_0315__ul13751939747"><li id="cts_api_0315__li1575110394415"><strong id="cts_api_0315__b1751139248">enabled</strong></li><li id="cts_api_0315__li197517391142"><strong id="cts_api_0315__b575113913414">disabled</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row77441739147"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p2751239747">topic_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p275193911418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0315__p137528391941">Topic URN.</p>
|
|
<ul id="cts_api_0315__ul14752839842"><li id="cts_api_0315__li11752539940">To obtain the <strong id="cts_api_0315__b1589513911369">topic_urn</strong>, call the SMN API for querying topics. Example URN: <strong id="cts_api_0315__b209071929193618">urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row18745103912420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p37525391742">notification_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p1675318391947">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0315__p127536395414">Unique notification ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row874510391749"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p15753143910415">notification_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p775373914417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0315__p4754239246">Notification type.</p>
|
|
<p id="cts_api_0315__p1675410399416">Enumerated value:</p>
|
|
<ul id="cts_api_0315__ul1775418397412"><li id="cts_api_0315__li1775483914418"><strong id="cts_api_0315__b187549394420">smn</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row1074553910417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p975573915410">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p5755133914411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0315__p17552039249">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row1874513399410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0315__p775553920415">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0315__p1375614392045">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0315__p1375615391746">Timestamp when a notification was created.</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__row107575391646"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="cts_api_0315__p57617392415">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="cts_api_0315__p9761639146">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="cts_api_0315__p676216391415">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0315__row276015398411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0315__p476283919412">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0315__p127624392410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0315__p676213390415">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 the <em id="cts_api_0315__i1644718111537">Cloud Trace Service User Guide</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row1876013391447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0315__p176211391248">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0315__p117635397415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0315__p11763123912412">Resource type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row1976013396415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0315__p1476383910414">trace_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0315__p13763939341">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0315__p976483911414">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__row876418391846"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="cts_api_0315__p117644391415">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="cts_api_0315__p7765133912412">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="cts_api_0315__p117653397413">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0315__row1076412391241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cts_api_0315__p276519391147">user_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cts_api_0315__p167654396411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cts_api_0315__p27661939945">IAM user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row12764123915410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cts_api_0315__p157668391742">user_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cts_api_0315__p12766739246">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cts_api_0315__p1276616392420">IAM user.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0315__p677114391642"><strong id="cts_api_0315__b1677120391419">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 7 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0315__row9772183916417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="cts_api_0315__p47726398411">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="cts_api_0315__p37728392044">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="cts_api_0315__p777317391947">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0315__row1977212391640"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cts_api_0315__p137731391843">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cts_api_0315__p1477317391848">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cts_api_0315__p1777373919411">Error code. Format: <strong id="cts_api_0315__b1817101615193">CTS.</strong><em id="cts_api_0315__i1382371619195">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row1977220391848"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="cts_api_0315__p577416395413">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="cts_api_0315__p127741395420">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="cts_api_0315__p1077418391549">Error description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0315__section137741391944"><h4 class="sectiontitle">Example Request</h4><p id="cts_api_0315__p1877514391449">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0315__section137751939649"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0315__p187753391143"><strong id="cts_api_0315__b177041831102316">Status code: 200</strong></p>
|
|
<p id="cts_api_0315__p3775939342">The query is successful.</p>
|
|
<pre class="screen" id="cts_api_0315__screen1677743916410">{
|
|
"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__section616764020411"><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__row9784739549"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_0315__p101683409415">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_0315__p516818405414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0315__row127844398415"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0315__p71687401141">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0315__p151686406418">The query is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row27847395420"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0315__p151682405419">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0315__p0169184020415">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row197853396418"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0315__p316994012411">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0315__p516917401416">The request is rejected due to authentication failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row117856392040"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0315__p17169640045">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0315__p416912401548">The server understood the request but refused to authorize it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row1678510394414"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0315__p91695401543">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0315__p161709405415">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__row1978510391847"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0315__p141705401641">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0315__p20170164015412">The request failed to be executed or some trackers failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0315__row078503913411"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0315__p121701440543">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0315__p1817018406411">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_0315__section1417015402420"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_0315__p5171154011412">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>
|
|
|