forked from docs/doc-exports
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>
732 lines
72 KiB
HTML
732 lines
72 KiB
HTML
<a name="cts_api_0313"></a><a name="cts_api_0313"></a>
|
|
|
|
<h1 class="topictitle1">Modifying a Key Event Notification</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_0313__en-us_topic_0000001213357771_section209200263786"><h4 class="sectiontitle">Function</h4><p id="cts_api_0313__en-us_topic_0000001213357771_p159324775686">This API is used to modify a key event notification. The notification ID carried in the request must be valid.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0313__en-us_topic_0000001213357771_section1459062248"><h4 class="sectiontitle">API Calling</h4><p id="cts_api_0313__en-us_topic_0000001213357771_p149678988686">For details, see <a href="cts_api_0006.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0313__en-us_topic_0000001213357771_section2045660465"><h4 class="sectiontitle">URI</h4><p id="cts_api_0313__en-us_topic_0000001213357771_p69194686486">PUT /v3/{project_id}/notifications</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_table159912921286" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row115990071186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p110475066486">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_0313__en-us_topic_0000001213357771_p176299105086">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_0313__en-us_topic_0000001213357771_p79440965286">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_0313__en-us_topic_0000001213357771_p85702889386">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row193163779786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p170056072186">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p187343879486">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p38808480186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p43759177886">Project ID. For details, see <a href="cts_api_0005.html">Obtaining an Account ID and Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0313__en-us_topic_0000001213357771_section209738802086"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_request_UpdateNotificationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row153331846986"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p155205775686">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p196050897486">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p121682795486">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="cts_api_0313__en-us_topic_0000001213357771_p136699777386">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row58974596186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p201122901286">notification_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p209240124786">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p133340057386">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p184207891586">Notification name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row5807369686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p116815563586">operation_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p972317186">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p121992308586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p192630742186">Operation type. Possible options include <strong id="cts_api_0313__en-us_topic_0000001213357771_b168831583951625">complete</strong> and <strong id="cts_api_0313__en-us_topic_0000001213357771_b156090746151625">customized</strong>. If you choose <strong id="cts_api_0313__en-us_topic_0000001213357771_b209160035751625">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_0313__en-us_topic_0000001213357771_b137171806751625">customized</strong>, notifications will be sent when operations defined in <strong id="cts_api_0313__en-us_topic_0000001213357771_b53115831751625">operations</strong> occur.</p>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p69408463386">Enumerated values:</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul99971910186"><li id="cts_api_0313__en-us_topic_0000001213357771_li127805387986"><p id="cts_api_0313__en-us_topic_0000001213357771_p30289671186"><a name="cts_api_0313__en-us_topic_0000001213357771_li127805387986"></a><a name="en-us_topic_0000001213357771_li127805387986"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b69735823686">customized</strong></p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li10789541686"><p id="cts_api_0313__en-us_topic_0000001213357771_p205816092486"><a name="cts_api_0313__en-us_topic_0000001213357771_li10789541686"></a><a name="en-us_topic_0000001213357771_li10789541686"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b142908617886">complete</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row172644925886"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p136657412486">operations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p48651114086">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p116382845986">Array of <a href="#cts_api_0313__en-us_topic_0000001213357771_request_Operations">Operations</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p152400991686">Operation list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row68653192286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p32139104486">notify_user_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p140869520986">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p138745892686">Array of <a href="#cts_api_0313__en-us_topic_0000001213357771_request_NotificationUsers">NotificationUsers</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p132775177386">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_0313__en-us_topic_0000001213357771_row187627714086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p205325450286">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p210824265486">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p26005645886">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p34467669386">Notification status. Possible options include <strong id="cts_api_0313__en-us_topic_0000001213357771_b129918208651625">enabled</strong> and <strong id="cts_api_0313__en-us_topic_0000001213357771_b16369461251625">disabled</strong>.</p>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p210646654586">Enumerated values:</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul201590357086"><li id="cts_api_0313__en-us_topic_0000001213357771_li77636048686"><p id="cts_api_0313__en-us_topic_0000001213357771_p58323115986"><a name="cts_api_0313__en-us_topic_0000001213357771_li77636048686"></a><a name="en-us_topic_0000001213357771_li77636048686"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b67364590886">enabled</strong></p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li21861856086"><p id="cts_api_0313__en-us_topic_0000001213357771_p87719194586"><a name="cts_api_0313__en-us_topic_0000001213357771_li21861856086"></a><a name="en-us_topic_0000001213357771_li21861856086"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b61795876986">disabled</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row170946880986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p41051007586">topic_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p28583425886">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p116831042986">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p6382242286">Topic URN or function URN. This parameter is mandatory when <strong id="cts_api_0313__en-us_topic_0000001213357771_b9642254131819">status</strong> is set to <strong id="cts_api_0313__en-us_topic_0000001213357771_b39572569188">enabled</strong>. To obtain the <strong id="cts_api_0313__en-us_topic_0000001213357771_b208038327151625">topic_urn</strong>, call the SMN API for querying topics. Example URN: <strong id="cts_api_0313__en-us_topic_0000001213357771_b108866633151625">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_0313__en-us_topic_0000001213357771_b57644206351625">urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row110459852686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p4507525986">notification_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p36269285286">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p181360944386">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p89946897386">Notification ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row55904156286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p37731125386">filter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p55490847886">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p166449438686"><a href="#cts_api_0313__en-us_topic_0000001213357771_request_Filter">Filter</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p2214530686">Advanced filter of key event notifications.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0313__en-us_topic_0000001213357771_request_Operations"></a><a name="en-us_topic_0000001213357771_request_Operations"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_request_Operations" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Operations</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row110160820086"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p139331289986">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p293201986">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p192927320286">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="cts_api_0313__en-us_topic_0000001213357771_p100711448486">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row20311703786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p58465284586">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p191813993586">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p152751644786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p183161400186">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_0313__en-us_topic_0000001213357771_i46134696855055">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_0313__en-us_topic_0000001213357771_row35955565986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p12644804186">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p167272252886">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p45575392086">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p92565311486">Resource type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row107316064886"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p202901573086">trace_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p89449359886">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p90180453386">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p49310431386">Trace name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0313__en-us_topic_0000001213357771_request_NotificationUsers"></a><a name="en-us_topic_0000001213357771_request_NotificationUsers"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_request_NotificationUsers" frame="border" border="1" rules="all"><caption><b>Table 4 </b>NotificationUsers</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row196544505786"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p69393097986">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p35581376586">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p173933770686">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="cts_api_0313__en-us_topic_0000001213357771_p85776271086">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row13681838086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p59654351086">user_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p4340242086">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p114647544286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p109388630686">IAM user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row181014078786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p138915735286">user_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p116561249386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p205420895086">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p115171823586">IAM user.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0313__en-us_topic_0000001213357771_request_Filter"></a><a name="en-us_topic_0000001213357771_request_Filter"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_request_Filter" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Filter</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row39675152286"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p194967377486">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p190112021886">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p144799389686">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.5.2.5.1.4"><p id="cts_api_0313__en-us_topic_0000001213357771_p204545965886">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row68108304486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p184902588486">condition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p24693469686">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p70990705586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p79574698286">Relationship between conditions.</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul9211236686"><li id="cts_api_0313__en-us_topic_0000001213357771_li12068625986"><p id="cts_api_0313__en-us_topic_0000001213357771_p149454844986"><a name="cts_api_0313__en-us_topic_0000001213357771_li12068625986"></a><a name="en-us_topic_0000001213357771_li12068625986"></a>AND (default value) indicates that a rule takes effect after all filtering criteria are met.</p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li43539006586"><p id="cts_api_0313__en-us_topic_0000001213357771_p31854589086"><a name="cts_api_0313__en-us_topic_0000001213357771_li43539006586"></a><a name="en-us_topic_0000001213357771_li43539006586"></a>OR indicates that a rule takes effect when one of the filtering criteria is met.</p>
|
|
</li></ul>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p157571709086">Enumerated values:</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul77777160886"><li id="cts_api_0313__en-us_topic_0000001213357771_li23693795386"><p id="cts_api_0313__en-us_topic_0000001213357771_p26334600886"><a name="cts_api_0313__en-us_topic_0000001213357771_li23693795386"></a><a name="en-us_topic_0000001213357771_li23693795386"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b2097789153511">AND (default value)</strong></p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li54284774986"><p id="cts_api_0313__en-us_topic_0000001213357771_p103695788986"><a name="cts_api_0313__en-us_topic_0000001213357771_li54284774986"></a><a name="en-us_topic_0000001213357771_li54284774986"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b172256524786">OR</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row201420856386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p88852647986">is_support_filter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p156887329386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p180137505186">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p134664260786">Whether to enable the advanced filter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row195078368086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p23030382986">rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p109337025386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p157503554286">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cts_api_0313__en-us_topic_0000001213357771_p122350684186">Advanced filter criteria rule. Example: <strong id="cts_api_0313__en-us_topic_0000001213357771_b10226105022114">key != value</strong>. The format is <em id="cts_api_0313__en-us_topic_0000001213357771_i11558101712212">field rule value</em>. - Field options: <strong id="cts_api_0313__en-us_topic_0000001213357771_b101869562115">api_version</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b21861051212">code</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b14186125102115">trace_rating</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b11861954218">trace_type</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b318612516214">resource_id</strong>, or <strong id="cts_api_0313__en-us_topic_0000001213357771_b151863562112">resource_name</strong>. - Rule: <strong id="cts_api_0313__en-us_topic_0000001213357771_b1173865010239">!=</strong> or <strong id="cts_api_0313__en-us_topic_0000001213357771_b88568529232">=</strong>. - Value: <strong id="cts_api_0313__en-us_topic_0000001213357771_b5642933132216">api_version</strong>: ^(a-zA-Z0-9_-.){1,64}$; <strong id="cts_api_0313__en-us_topic_0000001213357771_b864313312210">code</strong>: 1 to 256 characters; <strong id="cts_api_0313__en-us_topic_0000001213357771_b5643143342216">trace_rating</strong>: <strong id="cts_api_0313__en-us_topic_0000001213357771_b6643133162210">normal</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b5643143362220">warning</strong>, or <strong id="cts_api_0313__en-us_topic_0000001213357771_b16431433142217">incident</strong>; <strong id="cts_api_0313__en-us_topic_0000001213357771_b164323310222">trace_type</strong>: <strong id="cts_api_0313__en-us_topic_0000001213357771_b364313342218">ConsoleAction</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b1643433112218">ApiCall</strong>, or <strong id="cts_api_0313__en-us_topic_0000001213357771_b1864353316222">SystemAction</strong>; <strong id="cts_api_0313__en-us_topic_0000001213357771_b864333382217">resource_id</strong>: 1 to 350 characters; <strong id="cts_api_0313__en-us_topic_0000001213357771_b2064314337228">resource_name</strong>: 1 to 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0313__en-us_topic_0000001213357771_section6203822486"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0313__en-us_topic_0000001213357771_p29131300886"><strong id="cts_api_0313__en-us_topic_0000001213357771_b79816919359">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_response_UpdateNotificationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row66553297986"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p200146691786">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_0313__en-us_topic_0000001213357771_p47331798986">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_0313__en-us_topic_0000001213357771_p182271041386">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row140140696586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p66979665986">notification_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p176800844686">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p187058583186">Notification name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row69772612286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p214196037786">operation_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p193653931286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p6657468186">Operation type. Possible options include <strong id="cts_api_0313__en-us_topic_0000001213357771_b2060548675">complete</strong> and <strong id="cts_api_0313__en-us_topic_0000001213357771_b88613104">customized</strong>. If you choose <strong id="cts_api_0313__en-us_topic_0000001213357771_b1945424108">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_0313__en-us_topic_0000001213357771_b8734388">customized</strong>, notifications will be sent when operations defined in <strong id="cts_api_0313__en-us_topic_0000001213357771_b1310698943">operations</strong> occur.</p>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p110707599786">Enumerated values:</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul50492950286"><li id="cts_api_0313__en-us_topic_0000001213357771_li67335899586"><p id="cts_api_0313__en-us_topic_0000001213357771_p21640249786"><a name="cts_api_0313__en-us_topic_0000001213357771_li67335899586"></a><a name="en-us_topic_0000001213357771_li67335899586"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b179091664486">customized</strong></p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li22024074986"><p id="cts_api_0313__en-us_topic_0000001213357771_p83310503486"><a name="cts_api_0313__en-us_topic_0000001213357771_li22024074986"></a><a name="en-us_topic_0000001213357771_li22024074986"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b57496691586">complete</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row118278241086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p104714060486">operations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p18009066886">Array of <a href="#cts_api_0313__en-us_topic_0000001213357771_response_Operations">Operations</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p12993931186">Operation list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row184931552086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p77968464086">notify_user_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p21595653986">Array of <a href="#cts_api_0313__en-us_topic_0000001213357771_response_NotificationUsers">NotificationUsers</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p166839103286">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_0313__en-us_topic_0000001213357771_row121779261486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p169144984986">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p64495099186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p158435399086">Notification status. Possible options include <strong id="cts_api_0313__en-us_topic_0000001213357771_b1428306809">enabled</strong> and <strong id="cts_api_0313__en-us_topic_0000001213357771_b2044003588">disabled</strong>.</p>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p100875908386">Enumerated values:</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul67801937886"><li id="cts_api_0313__en-us_topic_0000001213357771_li53913450186"><p id="cts_api_0313__en-us_topic_0000001213357771_p53189789186"><a name="cts_api_0313__en-us_topic_0000001213357771_li53913450186"></a><a name="en-us_topic_0000001213357771_li53913450186"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b83824897486">enabled</strong></p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li166456682686"><p id="cts_api_0313__en-us_topic_0000001213357771_p154855255386"><a name="cts_api_0313__en-us_topic_0000001213357771_li166456682686"></a><a name="en-us_topic_0000001213357771_li166456682686"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b149209042086">disabled</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row139211039186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p117377701186">topic_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p159804467786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p153919845786">Topic URN or function URN. To obtain the <strong id="cts_api_0313__en-us_topic_0000001213357771_b197835143851625">topic_urn</strong>, call the SMN API for querying topics. Example URN: <strong id="cts_api_0313__en-us_topic_0000001213357771_b83025470151625">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_0313__en-us_topic_0000001213357771_b695709254">urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row92919458986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p36219099586">notification_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p202022969686">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p151929045686">Unique notification ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row163854723386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p12166974586">notification_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p46054364586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p86464998086">Notification type identified based on <strong id="cts_api_0313__en-us_topic_0000001213357771_b6261431278">topic_id</strong>. Possible options include SMN (<strong id="cts_api_0313__en-us_topic_0000001213357771_b1496419613276">smn</strong>) and FunctionGraph (<strong id="cts_api_0313__en-us_topic_0000001213357771_b7698952714">fun</strong>).</p>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p80602168386">Enumerated values:</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul124979107186"><li id="cts_api_0313__en-us_topic_0000001213357771_li12700726786"><p id="cts_api_0313__en-us_topic_0000001213357771_p161361192086"><a name="cts_api_0313__en-us_topic_0000001213357771_li12700726786"></a><a name="en-us_topic_0000001213357771_li12700726786"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b67589459386">smn</strong></p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li41348518386"><p id="cts_api_0313__en-us_topic_0000001213357771_p37920197686"><a name="cts_api_0313__en-us_topic_0000001213357771_li41348518386"></a><a name="en-us_topic_0000001213357771_li41348518386"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b194796069586">fun</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row96626380986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p144390551286">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p203354574986">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p151255853886">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row124056553886"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p134566260886">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p179876631486">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p103261089586">Timestamp when a notification was created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row5196792686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p137020249386">filter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p72647430086"><a href="#cts_api_0313__en-us_topic_0000001213357771_response_Filter">Filter</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p13013068186">Advanced filter of key event notifications.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0313__en-us_topic_0000001213357771_response_Operations"></a><a name="en-us_topic_0000001213357771_response_Operations"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_response_Operations" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Operations</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row209465866086"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p51706315686">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_0313__en-us_topic_0000001213357771_p38711767786">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_0313__en-us_topic_0000001213357771_p204211214886">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row176160592586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p162430104986">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p66507001186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p149787478986">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_0313__en-us_topic_0000001213357771_i17574209755055">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_0313__en-us_topic_0000001213357771_row199236155086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p99861933986">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p188936447586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p195219954386">Resource type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row133142561186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p5106440586">trace_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p19981120486">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p124259551086">Trace name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0313__en-us_topic_0000001213357771_response_NotificationUsers"></a><a name="en-us_topic_0000001213357771_response_NotificationUsers"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_response_NotificationUsers" frame="border" border="1" rules="all"><caption><b>Table 8 </b>NotificationUsers</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row125278269486"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p154252933886">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_0313__en-us_topic_0000001213357771_p96339059586">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_0313__en-us_topic_0000001213357771_p29415234086">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row82003710786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p177192272886">user_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p168251121686">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p47285638686">IAM user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row70905597086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p101530744386">user_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p122052227586">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_0313__en-us_topic_0000001213357771_p5048249986">IAM user.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0313__en-us_topic_0000001213357771_response_Filter"></a><a name="en-us_topic_0000001213357771_response_Filter"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_response_Filter" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Filter</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row11331678186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p122895568886">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_0313__en-us_topic_0000001213357771_p85826803386">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_0313__en-us_topic_0000001213357771_p172143115486">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row117083821786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p13149807486">condition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p150552928786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p147133070686">Relationship between conditions.</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul148709974986"><li id="cts_api_0313__en-us_topic_0000001213357771_li77039512986"><p id="cts_api_0313__en-us_topic_0000001213357771_p186797926386"><a name="cts_api_0313__en-us_topic_0000001213357771_li77039512986"></a><a name="en-us_topic_0000001213357771_li77039512986"></a>AND (default value) indicates that a rule takes effect after all filtering criteria are met.</p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li70391989686"><p id="cts_api_0313__en-us_topic_0000001213357771_p158071740486"><a name="cts_api_0313__en-us_topic_0000001213357771_li70391989686"></a><a name="en-us_topic_0000001213357771_li70391989686"></a>OR indicates that a rule takes effect when one of the filtering criteria is met.</p>
|
|
</li></ul>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p37137778586">Enumerated values:</p>
|
|
<ul id="cts_api_0313__en-us_topic_0000001213357771_ul202356043986"><li id="cts_api_0313__en-us_topic_0000001213357771_li88223563986"><p id="cts_api_0313__en-us_topic_0000001213357771_p87273089886"><a name="cts_api_0313__en-us_topic_0000001213357771_li88223563986"></a><a name="en-us_topic_0000001213357771_li88223563986"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b1853687872">AND (default value)</strong></p>
|
|
</li><li id="cts_api_0313__en-us_topic_0000001213357771_li60236261486"><p id="cts_api_0313__en-us_topic_0000001213357771_p83004924186"><a name="cts_api_0313__en-us_topic_0000001213357771_li60236261486"></a><a name="en-us_topic_0000001213357771_li60236261486"></a><strong id="cts_api_0313__en-us_topic_0000001213357771_b93714579786">OR</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row182701184886"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p206572707386">is_support_filter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p113319784786">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p22125734686">Whether to enable the advanced filter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row67667563386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p13866058086">rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p118394294586">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_0313__en-us_topic_0000001213357771_p172003264786">Advanced filter criteria rule. Example: <strong id="cts_api_0313__en-us_topic_0000001213357771_b1633658191">key != value</strong>. The format is <em id="cts_api_0313__en-us_topic_0000001213357771_i535841769">field rule value</em>. - Field options: <strong id="cts_api_0313__en-us_topic_0000001213357771_b1308458145">api_version</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b1030714764">code</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b1572655002">trace_rating</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b1117338471">trace_type</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b1110796672">resource_id</strong>, or <strong id="cts_api_0313__en-us_topic_0000001213357771_b1713740308">resource_name</strong>. - Rule: <strong id="cts_api_0313__en-us_topic_0000001213357771_b707663843">!=</strong> or <strong id="cts_api_0313__en-us_topic_0000001213357771_b1117860848">=</strong>. - Value: <strong id="cts_api_0313__en-us_topic_0000001213357771_b18676193713225">api_version</strong>: ^(a-zA-Z0-9_-.){1,64}$; <strong id="cts_api_0313__en-us_topic_0000001213357771_b16676183713223">code</strong>: 1 to 256 characters; <strong id="cts_api_0313__en-us_topic_0000001213357771_b1367653722216">trace_rating</strong>: <strong id="cts_api_0313__en-us_topic_0000001213357771_b19677123717228">normal</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b16771437132217">warning</strong>, or <strong id="cts_api_0313__en-us_topic_0000001213357771_b1867763762216">incident</strong>; <strong id="cts_api_0313__en-us_topic_0000001213357771_b146771937152217">trace_type</strong>: <strong id="cts_api_0313__en-us_topic_0000001213357771_b106771837172213">ConsoleAction</strong>, <strong id="cts_api_0313__en-us_topic_0000001213357771_b667763772218">ApiCall</strong>, or <strong id="cts_api_0313__en-us_topic_0000001213357771_b1367712378222">SystemAction</strong>; <strong id="cts_api_0313__en-us_topic_0000001213357771_b1767717376222">resource_id</strong>: 1 to 350 characters; <strong id="cts_api_0313__en-us_topic_0000001213357771_b13677133713225">resource_name</strong>: 1 to 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p173959732786"><strong id="cts_api_0313__en-us_topic_0000001213357771_b16487161033517">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_response_FailedRsp" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row19409155986"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p64630775486">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p168917028186">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p142479327886">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row117359372886"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p191683845486">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p54290960586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p205692172286">Error code. Format: <strong id="cts_api_0313__en-us_topic_0000001213357771_b72273166551626">CTS.</strong><em id="cts_api_0313__en-us_topic_0000001213357771_i21569012451626">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row106955426986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p194439478886">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p10526456286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p23037677986">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p79697583286"><strong id="cts_api_0313__en-us_topic_0000001213357771_b1549001010359">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_table1788088467" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row152228036886"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p112813895486">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p154908167286">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.10.2.4.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p9855985986">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row157039632586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p91329609086">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p173717950786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p55700088586">Error code. Format: <strong id="cts_api_0313__en-us_topic_0000001213357771_b2097545984">CTS.</strong><em id="cts_api_0313__en-us_topic_0000001213357771_i772377304">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row162702965286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p158058854186">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p98643369086">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p67198295286">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p25615744486"><strong id="cts_api_0313__en-us_topic_0000001213357771_b6491910203513">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_table770792636" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row128199142886"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p43568150686">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p188315419886">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.12.2.4.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p135289723186">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row82865898986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p74043904486">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p117825403786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p52821183586">Error code. Format: <strong id="cts_api_0313__en-us_topic_0000001213357771_b1383149662">CTS.</strong><em id="cts_api_0313__en-us_topic_0000001213357771_i1872512256">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row158463664586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p165787224286">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p72307668286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p102750870486">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p137710824786"><strong id="cts_api_0313__en-us_topic_0000001213357771_b6493161013351">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_table2143797320" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row9128355386"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p92499938586">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p68394551186">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.14.2.4.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p6023647386">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row204566421786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p35470167086">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p147854025386">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p96353050786">Error code. Format: <strong id="cts_api_0313__en-us_topic_0000001213357771_b1109046145">CTS.</strong><em id="cts_api_0313__en-us_topic_0000001213357771_i717630905">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row121108310586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p45721401486">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p42376039586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p102399220586">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p136168443486"><strong id="cts_api_0313__en-us_topic_0000001213357771_b154951310163515">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_table2101520936" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row166343426186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.16.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p75193823786">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.16.2.4.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p158001627486">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.16.2.4.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p214636250686">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row40513352486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p153184601386">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p156581139886">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.16.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p181288760586">Error code. Format: <strong id="cts_api_0313__en-us_topic_0000001213357771_b802011398">CTS.</strong><em id="cts_api_0313__en-us_topic_0000001213357771_i1440903285">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row89761268386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p165647241686">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p198145874886">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.16.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p79844116386">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p188322220086"><strong id="cts_api_0313__en-us_topic_0000001213357771_b13496210133511">Status code: 503</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_table333213853" frame="border" border="1" rules="all"><caption><b>Table 15 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row105651639086"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.18.2.4.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p181674424086">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.18.2.4.1.2"><p id="cts_api_0313__en-us_topic_0000001213357771_p71051444986">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.18.2.4.1.3"><p id="cts_api_0313__en-us_topic_0000001213357771_p117921354986">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row2680778586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p149225151086">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p198129342586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.18.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p36683330686">Error code. Format: <strong id="cts_api_0313__en-us_topic_0000001213357771_b1812872711">CTS.</strong><em id="cts_api_0313__en-us_topic_0000001213357771_i398996421">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row73619380586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p203819845986">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p177386358786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.18.2.4.1.3 "><p id="cts_api_0313__en-us_topic_0000001213357771_p52691152886">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0313__en-us_topic_0000001213357771_section52709793986"><h4 class="sectiontitle">Example Request</h4><p id="cts_api_0313__en-us_topic_0000001213357771_p77953912986">Modify a key event notification.</p>
|
|
<pre class="screen" id="cts_api_0313__en-us_topic_0000001213357771_screen213128584986">PUT https://{endpoint}/v3/{project_id}/notifications
|
|
|
|
{
|
|
"notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8",
|
|
"notification_name" : "keyOperate_info_cfwy",
|
|
"operation_type" : "customized",
|
|
"operations" : [ {
|
|
"service_type" : "CTS",
|
|
"resource_type" : "tracker",
|
|
"trace_names" : [ "createTracker", "deleteTracker" ]
|
|
}, {
|
|
"service_type" : "CTS",
|
|
"resource_type" : "notification",
|
|
"trace_names" : [ "deleteNotification", "updateNotification" ]
|
|
}, {
|
|
"service_type" : "AOM",
|
|
"resource_type" : "pe",
|
|
"trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ]
|
|
} ],
|
|
"notify_user_list" : [ {
|
|
"user_group" : "admin",
|
|
"user_list" : [ "test", "test1" ]
|
|
}, {
|
|
"user_group" : "CTS view",
|
|
"user_list" : [ "test2", "test3" ]
|
|
} ],
|
|
"status" : "enabled",
|
|
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:foo"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cts_api_0313__en-us_topic_0000001213357771_section89728832386"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0313__en-us_topic_0000001213357771_p22971956086"><strong id="cts_api_0313__en-us_topic_0000001213357771_b83498257285">Status code: 200</strong></p>
|
|
<p id="cts_api_0313__en-us_topic_0000001213357771_p189542800586">The notification is modified.</p>
|
|
<pre class="screen" id="cts_api_0313__en-us_topic_0000001213357771_screen73864655886">{
|
|
"notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8",
|
|
"notification_name" : "keyOperate_info_cfwy",
|
|
"operation_type" : "customized",
|
|
"operations" : [ {
|
|
"service_type" : "CTS",
|
|
"resource_type" : "tracker",
|
|
"trace_names" : [ "createTracker", "deleteTracker" ]
|
|
}, {
|
|
"service_type" : "CTS",
|
|
"resource_type" : "notification",
|
|
"trace_names" : [ "deleteNotification", "updateNotification" ]
|
|
}, {
|
|
"service_type" : "AOM",
|
|
"resource_type" : "pe",
|
|
"trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ]
|
|
} ],
|
|
"notify_user_list" : [ {
|
|
"user_group" : "admin",
|
|
"user_list" : [ "test", "test1" ]
|
|
}, {
|
|
"user_group" : "CTS view",
|
|
"user_list" : [ "test2", "test3" ]
|
|
} ],
|
|
"status" : "enabled",
|
|
"project_id" : "24edf66e79d04187acb99a463e610764",
|
|
"notification_type" : "smn",
|
|
"create_time" : 1634001495876,
|
|
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:foo"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cts_api_0313__en-us_topic_0000001213357771_section149625772986"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__en-us_topic_0000001213357771_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0313__en-us_topic_0000001213357771_row78978502386"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="cts_api_0313__en-us_topic_0000001213357771_p212663601786">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_0313__en-us_topic_0000001213357771_p214284091886">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0313__en-us_topic_0000001213357771_row208075426386"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p188677788986">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p59785296386">The notification is modified.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row13232666886"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p80924827286">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p42847164186">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row251588286"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p75005468886">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p1158890886">The request is rejected due to authentication failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row70660725786"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p212234463086">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p2791828986">The server understood the request but refused to authorize it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row36195669586"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p27217471086">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p82498037286">The server failed to find the requested resource or some key event notifications failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row193260606886"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p33574750486">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p74021495686">The request failed to be executed or some trackers failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0313__en-us_topic_0000001213357771_row164506277886"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0313__en-us_topic_0000001213357771_p113564653286">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0313__en-us_topic_0000001213357771_p43947259786">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_0313__en-us_topic_0000001213357771_section45394151286"><h4 class="sectiontitle">Error Code</h4><p id="cts_api_0313__en-us_topic_0000001213357771_p189784914786">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>
|
|
|