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>
711 lines
67 KiB
HTML
711 lines
67 KiB
HTML
<a name="cts_api_0312"></a><a name="cts_api_0312"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Key Event Notification</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_0312__en-us_topic_0000001213559235_section212365516286"><h4 class="sectiontitle">Function</h4><p id="cts_api_0312__en-us_topic_0000001213559235_p596833986">SMS, email, or HTTP/HTTPS notifications can be sent through pre-configured SMN topics to subscribers when key operations occur. This helps you detect high-risk operations promptly. Notifications can also be used as triggers for specific operations or to connect to your own audit system.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0312__en-us_topic_0000001213559235_section1600924082"><h4 class="sectiontitle">API Calling</h4><p id="cts_api_0312__en-us_topic_0000001213559235_p170638462786">For details, see <a href="cts_api_0006.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0312__en-us_topic_0000001213559235_section138650455"><h4 class="sectiontitle">URI</h4><p id="cts_api_0312__en-us_topic_0000001213559235_p82628113786">POST /v3/{project_id}/notifications</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_table200961709086" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row149550093586"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p197787236786">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_0312__en-us_topic_0000001213559235_p25177767686">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_0312__en-us_topic_0000001213559235_p90850578786">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_0312__en-us_topic_0000001213559235_p3094948086">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row99730763286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p104932017686">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p6697332886">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p145151031986">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p105128543986">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_0312__en-us_topic_0000001213559235_section11818116386"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_request_CreateNotificationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row145875854486"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p96783382386">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_0312__en-us_topic_0000001213559235_p3019832686">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_0312__en-us_topic_0000001213559235_p205585698286">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_0312__en-us_topic_0000001213559235_p10528037586">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row139757463186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p134943673586">notification_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p197079848786">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p82755421686">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p214309435086">Notification name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row100552701686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p162756397486">operation_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p50425279286">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p86878717586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p77449421986">Operation type. Possible options include <strong id="cts_api_0312__en-us_topic_0000001213559235_b40435761910929">complete</strong> and <strong id="cts_api_0312__en-us_topic_0000001213559235_b48415318710929">customized</strong>. If you choose <strong id="cts_api_0312__en-us_topic_0000001213559235_b117997396010929">complete</strong>, you do not need to specify <strong id="cts_api_0312__en-us_topic_0000001213559235_b73763018310929">operations</strong> and <strong id="cts_api_0312__en-us_topic_0000001213559235_b42919402710929">notify_user_list</strong>, and notifications will be sent when any supported operations occur on any of the connected cloud services. If you choose <strong id="cts_api_0312__en-us_topic_0000001213559235_b86826984710929">customized</strong>, notifications will be sent when operations defined in <strong id="cts_api_0312__en-us_topic_0000001213559235_b200979618310929">operations</strong> occur.</p>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p20906850986">Enumerated values:</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul119054029586"><li id="cts_api_0312__en-us_topic_0000001213559235_li152565567486"><strong id="cts_api_0312__en-us_topic_0000001213559235_b99427795686">complete</strong></li><li id="cts_api_0312__en-us_topic_0000001213559235_li181049208986"><strong id="cts_api_0312__en-us_topic_0000001213559235_b209427428786">customized</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row9717964486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p73513290686">operations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p130707502286">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p23840417886">Array of <a href="#cts_api_0312__en-us_topic_0000001213559235_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_0312__en-us_topic_0000001213559235_p175002938786">Operation list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row193087913986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p137853425986">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_0312__en-us_topic_0000001213559235_p87551771686">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p127438686286">Array of <a href="#cts_api_0312__en-us_topic_0000001213559235_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_0312__en-us_topic_0000001213559235_p36839232586">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_0312__en-us_topic_0000001213559235_row20314674086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p131960424386">topic_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p108933204886">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p138458781386">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p19976836486">Topic URN or function URN. To obtain the <strong id="cts_api_0312__en-us_topic_0000001213559235_b9571427375">topic_urn</strong>, call the SMN API for querying topics. Example URN: <strong id="cts_api_0312__en-us_topic_0000001213559235_b1657928378">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_0312__en-us_topic_0000001213559235_b188661355133810">urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row161327352686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p68990446686">filter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p701995486">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p207334677386"><a href="#cts_api_0312__en-us_topic_0000001213559235_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_0312__en-us_topic_0000001213559235_p170209781186">Advanced filter of key event notifications.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0312__en-us_topic_0000001213559235_request_Operations"></a><a name="en-us_topic_0000001213559235_request_Operations"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_request_Operations" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Operations</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row56766809586"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p88561129786">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_0312__en-us_topic_0000001213559235_p10545007586">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_0312__en-us_topic_0000001213559235_p193021168586">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_0312__en-us_topic_0000001213559235_p72418439386">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row78345528786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p82005330686">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p137635748786">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p42171274886">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p126844711186">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_0312__en-us_topic_0000001213559235_i1368056185010">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_0312__en-us_topic_0000001213559235_row189959645986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p193107327386">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p46360052986">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p37646637186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p125141338386">Resource type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row37355403286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p68304109486">trace_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p99406411486">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p65411871586">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_0312__en-us_topic_0000001213559235_p20001510586">Trace name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0312__en-us_topic_0000001213559235_request_NotificationUsers"></a><a name="en-us_topic_0000001213559235_request_NotificationUsers"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_request_NotificationUsers" frame="border" border="1" rules="all"><caption><b>Table 4 </b>NotificationUsers</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row51374890286"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p187046491186">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_0312__en-us_topic_0000001213559235_p25041775186">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_0312__en-us_topic_0000001213559235_p110585554286">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_0312__en-us_topic_0000001213559235_p121360962886">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row20990700486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p131164841786">user_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p118170068986">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p169559465986">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p175750625686">IAM user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row156736246086"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p154739437486">user_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p25961486086">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p153291669186">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_0312__en-us_topic_0000001213559235_p66318705286">IAM user.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0312__en-us_topic_0000001213559235_request_Filter"></a><a name="en-us_topic_0000001213559235_request_Filter"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_request_Filter" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Filter</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row31421779386"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p132117939186">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_0312__en-us_topic_0000001213559235_p111438982786">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_0312__en-us_topic_0000001213559235_p4151677786">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_0312__en-us_topic_0000001213559235_p205817914586">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row76596779386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p149583560986">condition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p100872721586">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p166968224586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p208653019486">Relationship between conditions.</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul199625428686"><li id="cts_api_0312__en-us_topic_0000001213559235_li148142936586">AND (default value) indicates that a rule takes effect after all filtering criteria are met.</li><li id="cts_api_0312__en-us_topic_0000001213559235_li198336569986">OR indicates that a rule takes effect when one of the filtering criteria is met.</li></ul>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p92204937886">Enumerated values:</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul117397026186"><li id="cts_api_0312__en-us_topic_0000001213559235_li75986339386"><strong id="cts_api_0312__en-us_topic_0000001213559235_b181701010163520">AND (default value)</strong></li><li id="cts_api_0312__en-us_topic_0000001213559235_li208287021186"><strong id="cts_api_0312__en-us_topic_0000001213559235_b146925723186">OR</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row77702646786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p35636387986">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_0312__en-us_topic_0000001213559235_p68959587586">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p207209407886">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cts_api_0312__en-us_topic_0000001213559235_p16863690986">Whether to enable the advanced filter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row17599511986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p170250843286">rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p79455416886">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p65529230186">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_0312__en-us_topic_0000001213559235_p199281139386">Advanced filter criteria rule. Example: <strong id="cts_api_0312__en-us_topic_0000001213559235_b0107867171">key != value</strong>. The format is <em id="cts_api_0312__en-us_topic_0000001213559235_i41078619172">field rule value</em>. - Field options: <strong id="cts_api_0312__en-us_topic_0000001213559235_b1662661172117">api_version</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b1362617119212">code</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b4626121114217">trace_rating</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b362610115211">trace_type</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b8626191112211">resource_id</strong>, or <strong id="cts_api_0312__en-us_topic_0000001213559235_b106269110214">resource_name</strong>. - Rule: <strong id="cts_api_0312__en-us_topic_0000001213559235_b53409131185">!=</strong> or <strong id="cts_api_0312__en-us_topic_0000001213559235_b103401132185">=</strong>. - Value: <strong id="cts_api_0312__en-us_topic_0000001213559235_b13521527182112">api_version</strong>: ^(a-zA-Z0-9_-.){1,64}$; <strong id="cts_api_0312__en-us_topic_0000001213559235_b1453132717216">code</strong>: 1 to 256 characters; <strong id="cts_api_0312__en-us_topic_0000001213559235_b7531627152119">trace_rating</strong>: <strong id="cts_api_0312__en-us_topic_0000001213559235_b1253122752114">normal</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b253102715211">warning</strong>, or <strong id="cts_api_0312__en-us_topic_0000001213559235_b1553162782111">incident</strong>; <strong id="cts_api_0312__en-us_topic_0000001213559235_b8531127132116">trace_type</strong>: <strong id="cts_api_0312__en-us_topic_0000001213559235_b4531727132110">ConsoleAction</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b25382714217">ApiCall</strong>, or <strong id="cts_api_0312__en-us_topic_0000001213559235_b105432702114">SystemAction</strong>; <strong id="cts_api_0312__en-us_topic_0000001213559235_b13541327172118">resource_id</strong>: 1 to 350 characters; <strong id="cts_api_0312__en-us_topic_0000001213559235_b1154182718218">resource_name</strong>: 1 to 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0312__en-us_topic_0000001213559235_section38134113886"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0312__en-us_topic_0000001213559235_p105445774486"><strong id="cts_api_0312__en-us_topic_0000001213559235_b61761310123510">Status code: 201</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_response_CreateNotificationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row200857271186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p62388789986">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_0312__en-us_topic_0000001213559235_p173274074686">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_0312__en-us_topic_0000001213559235_p65450368586">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row174049027886"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p203044577886">notification_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p136577420486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p100281820786">Notification name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row92822430686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p53919406586">operation_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p32239376286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p128387553686">Operation type. Possible options include <strong id="cts_api_0312__en-us_topic_0000001213559235_b5794832152516">complete</strong> and <strong id="cts_api_0312__en-us_topic_0000001213559235_b1121693732512">customized</strong>.</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul8671810986"><li id="cts_api_0312__en-us_topic_0000001213559235_li26692601986">complete: Notifications will be sent through SMN for all operations recorded by CTS.</li><li id="cts_api_0312__en-us_topic_0000001213559235_li60585457586">customized: Notifications will be sent through SMN for specified operations performed on specified cloud services.</li></ul>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p64758771186">Enumerated values:</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul45870517386"><li id="cts_api_0312__en-us_topic_0000001213559235_li188014975986"><strong id="cts_api_0312__en-us_topic_0000001213559235_b16649800186">customized</strong></li><li id="cts_api_0312__en-us_topic_0000001213559235_li158146300386"><strong id="cts_api_0312__en-us_topic_0000001213559235_b137373473486">complete</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row76614342186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p209445805286">operations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p127650162386">Array of <a href="#cts_api_0312__en-us_topic_0000001213559235_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_0312__en-us_topic_0000001213559235_p159543745886">Operation list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row43466173486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p95343393286">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_0312__en-us_topic_0000001213559235_p172727917786">Array of <a href="#cts_api_0312__en-us_topic_0000001213559235_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_0312__en-us_topic_0000001213559235_p48854423686">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_0312__en-us_topic_0000001213559235_row139219753686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p17871072986">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p21157997486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p140848357986">Notification status.</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul8327127486"><li id="cts_api_0312__en-us_topic_0000001213559235_li132093081286"><strong id="cts_api_0312__en-us_topic_0000001213559235_b3906118205314">disabled</strong>: Key event notification is disabled.</li><li id="cts_api_0312__en-us_topic_0000001213559235_li44828475486"><strong id="cts_api_0312__en-us_topic_0000001213559235_b16308193185111">enabled</strong>: Key event notification is enabled.</li></ul>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p158259883986">Enumerated values:</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul176916377586"><li id="cts_api_0312__en-us_topic_0000001213559235_li56886954986"><strong id="cts_api_0312__en-us_topic_0000001213559235_b174962191586">enabled</strong></li><li id="cts_api_0312__en-us_topic_0000001213559235_li202219780386"><strong id="cts_api_0312__en-us_topic_0000001213559235_b41935198786">disabled</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row23190677186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p118948270186">topic_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p34784112486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p137663792286">Unique resource ID of an SMN topic. You can obtain the ID by querying the topic list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row34472138286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p125536444086">notification_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p155559367586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p115120702086">Unique notification ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row152791961286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p189511710286">notification_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p202521950486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p136346969886">Notification type. - <strong id="cts_api_0312__en-us_topic_0000001213559235_b78194113528">smn</strong>: Simple Message Notification (SMN). - <strong id="cts_api_0312__en-us_topic_0000001213559235_b11556153205516">fun</strong>: FunctionGraph.</p>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p55382436386">Enumerated values:</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul156560089286"><li id="cts_api_0312__en-us_topic_0000001213559235_li167698568086"><strong id="cts_api_0312__en-us_topic_0000001213559235_b2486733186">smn</strong></li><li id="cts_api_0312__en-us_topic_0000001213559235_li27722066686"><strong id="cts_api_0312__en-us_topic_0000001213559235_b27112536586">fun</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row16188500286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p159384037786">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p147306494986">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p34984780586">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row15421603386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p10437546586">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p109889651586">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p33234988086">Time when a notification rule was created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row66996904786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p20475514386">filter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p93736821786"><a href="#cts_api_0312__en-us_topic_0000001213559235_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_0312__en-us_topic_0000001213559235_p144524035986">Advanced filter of key event notifications.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0312__en-us_topic_0000001213559235_response_Operations"></a><a name="en-us_topic_0000001213559235_response_Operations"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_response_Operations" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Operations</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row140189317786"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p198404792386">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_0312__en-us_topic_0000001213559235_p116865799886">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_0312__en-us_topic_0000001213559235_p187159888786">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row174881086686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p454238986">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p79880172486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p52402918686">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_0312__en-us_topic_0000001213559235_i784610546504">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_0312__en-us_topic_0000001213559235_row59188867686"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p190686533886">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p89690957186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p39914149986">Resource type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row148947471286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p17361217186">trace_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p180179224486">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_0312__en-us_topic_0000001213559235_p195652146286">Trace name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0312__en-us_topic_0000001213559235_response_NotificationUsers"></a><a name="en-us_topic_0000001213559235_response_NotificationUsers"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_response_NotificationUsers" frame="border" border="1" rules="all"><caption><b>Table 8 </b>NotificationUsers</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row94038795786"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p214585757886">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_0312__en-us_topic_0000001213559235_p17800550486">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_0312__en-us_topic_0000001213559235_p164527441886">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row49805888986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p125072408086">user_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p48306910486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p29824547286">IAM user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row29573000486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p137546123986">user_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p24117355886">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_0312__en-us_topic_0000001213559235_p145540158986">IAM user.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_0312__en-us_topic_0000001213559235_response_Filter"></a><a name="en-us_topic_0000001213559235_response_Filter"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_response_Filter" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Filter</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row38002130286"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p147505594686">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_0312__en-us_topic_0000001213559235_p208411472786">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_0312__en-us_topic_0000001213559235_p194515818786">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row197386637486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p169511968386">condition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p211977085686">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p151236492586">Relationship between conditions.</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul43448180686"><li id="cts_api_0312__en-us_topic_0000001213559235_li57731000686">AND (default value) indicates that a rule takes effect after all filtering criteria are met.</li><li id="cts_api_0312__en-us_topic_0000001213559235_li175042633786">OR indicates that a rule takes effect when one of the filtering criteria is met.</li></ul>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p145812861286">Enumerated values:</p>
|
|
<ul id="cts_api_0312__en-us_topic_0000001213559235_ul176531268586"><li id="cts_api_0312__en-us_topic_0000001213559235_li108256216186"><strong id="cts_api_0312__en-us_topic_0000001213559235_b1182019238">AND (default value)</strong></li><li id="cts_api_0312__en-us_topic_0000001213559235_li140605637386"><strong id="cts_api_0312__en-us_topic_0000001213559235_b154854389686">OR</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row55443833186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p92556193686">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_0312__en-us_topic_0000001213559235_p100479436686">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p160585040286">Whether to enable the advanced filter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row202393824886"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p54171264986">rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p48364748386">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_0312__en-us_topic_0000001213559235_p124244561686">Advanced filter criteria rule. Example: <strong id="cts_api_0312__en-us_topic_0000001213559235_b457521598">key != value</strong>. The format is <em id="cts_api_0312__en-us_topic_0000001213559235_i273942381">field rule value</em>. - Field options: <strong id="cts_api_0312__en-us_topic_0000001213559235_b1204190563">api_version</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b1655665844">code</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b912897261">trace_rating</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b1540422794">trace_type</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b818098337">resource_id</strong>, or <strong id="cts_api_0312__en-us_topic_0000001213559235_b924170935">resource_name</strong>. - Rule: <strong id="cts_api_0312__en-us_topic_0000001213559235_b810364459">!=</strong> or <strong id="cts_api_0312__en-us_topic_0000001213559235_b1877796671">=</strong>. - Value: <strong id="cts_api_0312__en-us_topic_0000001213559235_b20909436181813">api_version</strong>: ^(a-zA-Z0-9_-.){1,64}$; <strong id="cts_api_0312__en-us_topic_0000001213559235_b69101336121816">code</strong>: 1 to 256 characters; <strong id="cts_api_0312__en-us_topic_0000001213559235_b139101836111813">trace_rating</strong>: <strong id="cts_api_0312__en-us_topic_0000001213559235_b109106362186">normal</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b15911736151819">warning</strong>, or <strong id="cts_api_0312__en-us_topic_0000001213559235_b18911836101815">incident</strong>; <strong id="cts_api_0312__en-us_topic_0000001213559235_b49111436101810">trace_type</strong>: <strong id="cts_api_0312__en-us_topic_0000001213559235_b491123611816">ConsoleAction</strong>, <strong id="cts_api_0312__en-us_topic_0000001213559235_b49124362183">ApiCall</strong>, or <strong id="cts_api_0312__en-us_topic_0000001213559235_b19121436161817">SystemAction</strong>; <strong id="cts_api_0312__en-us_topic_0000001213559235_b19912123681818">resource_id</strong>: 1 to 350 characters; <strong id="cts_api_0312__en-us_topic_0000001213559235_b1491313641818">resource_name</strong>: 1 to 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p139053757286"><strong id="cts_api_0312__en-us_topic_0000001213559235_b7624140599">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_response_FailedRsp" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row51117787586"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p152519028086">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_0312__en-us_topic_0000001213559235_p194480926786">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_0312__en-us_topic_0000001213559235_p150200665586">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row143364789386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p77632047986">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p133629921386">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p42878114386">Error code. Format: <strong id="cts_api_0312__en-us_topic_0000001213559235_b87946018210929">CTS.</strong><em id="cts_api_0312__en-us_topic_0000001213559235_i103724861010929">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row160819945186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p90253046786">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p133384420186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p17472509086">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p40901147186"><strong id="cts_api_0312__en-us_topic_0000001213559235_b137276109358">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_table1908538482" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row129274885986"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p158166618586">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_0312__en-us_topic_0000001213559235_p188911888486">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_0312__en-us_topic_0000001213559235_p116953437986">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row181142866786"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p155675114786">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p95472821286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p110743752686">Error code. Format: <strong id="cts_api_0312__en-us_topic_0000001213559235_b796648313">CTS.</strong><em id="cts_api_0312__en-us_topic_0000001213559235_i1769866753">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row98764715886"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p172062891086">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p8452496186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p114573941686">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p27426072386"><strong id="cts_api_0312__en-us_topic_0000001213559235_b1584618111007">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_table1932299488" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row20866400886"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p124976291386">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_0312__en-us_topic_0000001213559235_p213600453986">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_0312__en-us_topic_0000001213559235_p99286521086">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row86897606386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p183181939986">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p20270421586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p94630939786">Error code. Format: <strong id="cts_api_0312__en-us_topic_0000001213559235_b30845542">CTS.</strong><em id="cts_api_0312__en-us_topic_0000001213559235_i709775640">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row126219475386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p35068213386">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p1026836286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p115919164086">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p128619044186"><strong id="cts_api_0312__en-us_topic_0000001213559235_b9729141073518">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_table776192426" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row208725557986"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p26034609186">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_0312__en-us_topic_0000001213559235_p126967585886">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_0312__en-us_topic_0000001213559235_p118883466786">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row56773578186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p23575702586">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p161026652786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p134478170486">Error code. Format: <strong id="cts_api_0312__en-us_topic_0000001213559235_b670487474">CTS.</strong><em id="cts_api_0312__en-us_topic_0000001213559235_i1751834733">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row1800102286"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p4036680086">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p188682262086">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p188841797986">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p69561044486"><strong id="cts_api_0312__en-us_topic_0000001213559235_b17638133710018">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_table2139339378" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row214240337586"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.16.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p50953285486">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_0312__en-us_topic_0000001213559235_p3221605786">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_0312__en-us_topic_0000001213559235_p105205067886">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row81990413486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p60609708286">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p78541676386">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.16.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p81036076486">Error code. Format: <strong id="cts_api_0312__en-us_topic_0000001213559235_b308681393">CTS.</strong><em id="cts_api_0312__en-us_topic_0000001213559235_i478429614">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row15005700986"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p161595411286">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p102664280786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.16.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p212849043386">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p128033718886"><strong id="cts_api_0312__en-us_topic_0000001213559235_b648875319016">Status code: 503</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_table1826540367" frame="border" border="1" rules="all"><caption><b>Table 15 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row175894597386"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.18.2.4.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p206623449286">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_0312__en-us_topic_0000001213559235_p70342136186">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_0312__en-us_topic_0000001213559235_p121127135286">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row116049749386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p43353508686">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p130926024786">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.18.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p63376411786">Error code. Format: <strong id="cts_api_0312__en-us_topic_0000001213559235_b1013013687">CTS.</strong><em id="cts_api_0312__en-us_topic_0000001213559235_i1473939443">XXX</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row66893002386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p139017190686">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p159274131286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.18.2.4.1.3 "><p id="cts_api_0312__en-us_topic_0000001213559235_p129554556686">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0312__en-us_topic_0000001213559235_section155566290686"><h4 class="sectiontitle">Example Request</h4><ul id="cts_api_0312__en-us_topic_0000001213559235_ul117566384286"><li id="cts_api_0312__en-us_topic_0000001213559235_li145093741086">Creating a complete key event notification<pre class="screen" id="cts_api_0312__en-us_topic_0000001213559235_screen12689577886">POST https://{endpoint}/v3/{project_id}/notifications
|
|
|
|
{
|
|
"notification_name" : "test",
|
|
"filter" : {
|
|
"is_support_filter" : true,
|
|
"rule" : [ "code != 200", "api_version = v1.0", "trace_rating = normal", "trace_type != ApiCall", "resource_id = xxx", "resource_name = xxx" ],
|
|
"condition" : "OR"
|
|
},
|
|
"operation_type" : "complete",
|
|
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
|
|
}</pre>
|
|
</li><li id="cts_api_0312__en-us_topic_0000001213559235_li110403933286">Creating a custom key event notification<pre class="screen" id="cts_api_0312__en-us_topic_0000001213559235_screen104599957686">POST https://{endpoint}/v3/{project_id}/notifications
|
|
|
|
{
|
|
"notification_name" : "test",
|
|
"operation_type" : "customized",
|
|
"filter" : {
|
|
"is_support_filter" : true,
|
|
"rule" : [ "code != 200", "api_version = v1.0", "trace_rating = normal", "trace_type != ApiCall", "resource_id = xxx", "resource_name = xxx" ],
|
|
"condition" : "OR"
|
|
},
|
|
"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" : [ "test1", "test2" ]
|
|
}, {
|
|
"user_group" : "CTS view",
|
|
"user_list" : [ "test3", "test4" ]
|
|
} ],
|
|
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="cts_api_0312__en-us_topic_0000001213559235_section197258151086"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0312__en-us_topic_0000001213559235_p153491891286"><strong id="cts_api_0312__en-us_topic_0000001213559235_b654149310">Status code: 201</strong></p>
|
|
<p id="cts_api_0312__en-us_topic_0000001213559235_p72376116486">The creation is successful.</p>
|
|
<pre class="screen" id="cts_api_0312__en-us_topic_0000001213559235_screen50402989786">{
|
|
"create_time" : 1634001495876,
|
|
"notification_id" : "cda8fd83-d08c-46f0-b914-1453a6a85c00",
|
|
"notification_name" : "test",
|
|
"notification_type" : "smn",
|
|
"notify_user_list" : [ {
|
|
"user_group" : "admin",
|
|
"user_list" : [ "test1", "test2" ]
|
|
}, {
|
|
"user_group" : "CTS view",
|
|
"user_list" : [ "test3", "test4" ]
|
|
} ],
|
|
"operation_type" : "customized",
|
|
"operations" : [ {
|
|
"resource_type" : "tracker",
|
|
"service_type" : "CTS",
|
|
"trace_names" : [ "createTracker", "deleteTracker" ]
|
|
}, {
|
|
"resource_type" : "notification",
|
|
"service_type" : "CTS",
|
|
"trace_names" : [ "deleteNotification", "updateNotification" ]
|
|
}, {
|
|
"resource_type" : "pe",
|
|
"service_type" : "AOM",
|
|
"trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ]
|
|
} ],
|
|
"project_id" : "24edf66e79d04187acb99a463e610764",
|
|
"status" : "enabled",
|
|
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cts_api_0312__en-us_topic_0000001213559235_section108509408186"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0312__en-us_topic_0000001213559235_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0312__en-us_topic_0000001213559235_row10404366486"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="cts_api_0312__en-us_topic_0000001213559235_p31045692686">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_0312__en-us_topic_0000001213559235_p77831614186">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0312__en-us_topic_0000001213559235_row113426671786"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p51884614186">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p53771167486">The creation is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row174224931686"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p197647397586">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p190402157786">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row58354071086"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p131007192386">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p119935754186">The request is rejected due to authentication failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row198853458386"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p136661489286">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p69948170386">The server understood the request but refused to authorize it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row197848108986"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p148939743886">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p8220709486">The server failed to find the requested resource or some key event notifications failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row208657554186"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p100935704486">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p103766511286">The request failed to be executed or some trackers failed to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0312__en-us_topic_0000001213559235_row47643539586"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cts_api_0312__en-us_topic_0000001213559235_p174993143286">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cts_api_0312__en-us_topic_0000001213559235_p127611491186">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_0312__en-us_topic_0000001213559235_section57108200686"><h4 class="sectiontitle">Error Code</h4><p id="cts_api_0312__en-us_topic_0000001213559235_p8288667386">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>
|
|
|