youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/cts/api-ref/cts_api_0313.html
Ying, Jiayu 14be087a3b CTS API 1122 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Ying, Jiayu <jiayuying1@huawei.com>
Co-committed-by: Ying, Jiayu <jiayuying1@huawei.com>
2022-12-09 10:04:38 +00:00

483 lines
34 KiB
HTML
Raw Blame History

<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__section13484739341"><h4 class="sectiontitle">Function</h4><p id="cts_api_0313__p174846391417">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__section6484739149"><h4 class="sectiontitle">URI</h4><p id="cts_api_0313__p74842391242">PUT /v3/{project_id}/notifications</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0313__table0485739949" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="cts_api_0313__row104857396420"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_0313__p6485153915416">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="cts_api_0313__p1548510391741">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="cts_api_0313__p64851397410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="cts_api_0313__p54863391649">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row948553917419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0313__p84861391844">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0313__p14864391249">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0313__p9486339249">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0313__p64869394417">Project ID. For details, see section "Obtaining the Account ID and Project ID" in <em id="cts_api_0313__i15421537504">Cloud Trace Service API Reference</em>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0313__section248615399416"><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__row12487639644"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="cts_api_0313__p64880394418">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="cts_api_0313__p124881039842">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="cts_api_0313__p174888397420">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="cts_api_0313__p64881539442">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row104878395412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0313__p748813391415">notification_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0313__p34881839642">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0313__p1648916394415">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0313__p84896391443">Notification name.</p>
</td>
</tr>
<tr id="cts_api_0313__row348711394413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0313__p1348912391449">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0313__p048916391649">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0313__p748963910410">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0313__p12489123916419">Operation type. Possible options include <strong id="cts_api_0313__b3318827185919">complete</strong> and <strong id="cts_api_0313__b18325827195911">customized</strong>. If you choose <strong id="cts_api_0313__b8180131045916">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__b16358125185819">customized</strong>, notifications will be sent when operations defined in <strong id="cts_api_0313__b936612545813">operations</strong> occur.</p>
<p id="cts_api_0313__p848915396418">Enumerated values:</p>
<ul id="cts_api_0313__ul154908391144"><li id="cts_api_0313__li174900391410"><strong id="cts_api_0313__b2490183916413">customized</strong></li><li id="cts_api_0313__li94901739144"><strong id="cts_api_0313__b114904396412">complete</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0313__row1348713391540"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0313__p24901139042">operations</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0313__p24901839949">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0313__p949013910418">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.3.2.2.5.1.4 "><p id="cts_api_0313__p1149017397415">Operation list.</p>
</td>
</tr>
<tr id="cts_api_0313__row1948712398414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0313__p1491039243">notify_user_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0313__p1749114391146">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0313__p649114391243">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.3.2.2.5.1.4 "><p id="cts_api_0313__p11491539248">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__row248783920418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0313__p134911039146">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0313__p114911439742">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0313__p1449273916411">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0313__p1149263912416">Notification status. Possible options include <strong id="cts_api_0313__b4875194713110">enabled</strong> and <strong id="cts_api_0313__b2612205014119">disabled</strong>.</p>
<p id="cts_api_0313__p949217390419">Enumerated values:</p>
<ul id="cts_api_0313__ul149283912419"><li id="cts_api_0313__li1049219391346"><strong id="cts_api_0313__b9492439748">enabled</strong></li><li id="cts_api_0313__li149213920410"><strong id="cts_api_0313__b12492339946">disabled</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0313__row648753916420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0313__p449233916414">topic_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0313__p749219391244">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0313__p349323919416">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0313__p14931639445">Topic URN. This parameter is mandatory when <strong id="cts_api_0313__b122831196313">status</strong> is set to <strong id="cts_api_0313__b1142135816216">enabled</strong>.</p>
<ul id="cts_api_0313__ul149313917419"><li id="cts_api_0313__li104934396419">To obtain the <strong id="cts_api_0313__b2020210481672">topic_urn</strong>, call the SMN API for querying topics. Example URN: <strong id="cts_api_0313__b142091648379">urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0313__row34874396414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cts_api_0313__p184931239945">notification_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cts_api_0313__p3493123912413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cts_api_0313__p849312393418">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cts_api_0313__p20494183917413">Notification ID.</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__row94954391841"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="cts_api_0313__p184959394416">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__p144951739042">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__p134951391340">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__p649619391417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row44957395418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0313__p84960391412">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0313__p849615393419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0313__p17496639644">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0313__p1749620391549">Cloud service. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in the <em id="cts_api_0313__i179831815034">Cloud Trace Service User Guide</em>.</p>
</td>
</tr>
<tr id="cts_api_0313__row114951139543"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0313__p16496113919414">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0313__p2496123919413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0313__p16497193910410">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0313__p349718391745">Resource type.</p>
</td>
</tr>
<tr id="cts_api_0313__row649515391548"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cts_api_0313__p1949713393410">trace_names</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cts_api_0313__p194971439249">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cts_api_0313__p94973391410">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cts_api_0313__p10497439644">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__row144984395419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="cts_api_0313__p849810391546">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="cts_api_0313__p249816391346">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="cts_api_0313__p194994391147">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="cts_api_0313__p1449916391419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row1049853917420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="cts_api_0313__p149963916418">user_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="cts_api_0313__p15499113915415">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="cts_api_0313__p749910393414">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="cts_api_0313__p18499239645">IAM user group.</p>
</td>
</tr>
<tr id="cts_api_0313__row449823916419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="cts_api_0313__p1349912391417">user_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="cts_api_0313__p1950014391449">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="cts_api_0313__p150033915413">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="cts_api_0313__p135001439349">IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0313__section195051539645"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0313__p050510391649"><strong id="cts_api_0313__b152811518368">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 5 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__row115051639746"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="cts_api_0313__p1450615391642">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="cts_api_0313__p4506153918410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="cts_api_0313__p750618396414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row5505339748"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p13506123913416">notification_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p35068396417">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0313__p1350793917419">Notification name.</p>
</td>
</tr>
<tr id="cts_api_0313__row1650513393415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p165072039948">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p65075391342">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0313__p175079391418">Operation type. Possible options include <strong id="cts_api_0313__b11120643155711">complete</strong> and <strong id="cts_api_0313__b5120184314573">customized</strong>. If you choose <strong id="cts_api_0313__b1872318381943">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__b9815151017584">customized</strong>, notifications will be sent when operations defined in <strong id="cts_api_0313__b581631016584">operations</strong> occur.</p>
<p id="cts_api_0313__p35074391441">Enumerated values:</p>
<ul id="cts_api_0313__ul135079390412"><li id="cts_api_0313__li1050718393414"><strong id="cts_api_0313__b95072391747">customized</strong></li><li id="cts_api_0313__li55072396415"><strong id="cts_api_0313__b17508193916415">complete</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0313__row195051439349"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p11508193919410">operations</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p65083394419">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.4.3.2.4.1.3 "><p id="cts_api_0313__p115086391343">Operation list.</p>
</td>
</tr>
<tr id="cts_api_0313__row450523920411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p450893910410">notify_user_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p15508939646">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.4.3.2.4.1.3 "><p id="cts_api_0313__p350920392416">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__row85056391349"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p2050919391541">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p115091539247">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0313__p75097396414">Notification status. Possible options include <strong id="cts_api_0313__b1814517481959">enabled</strong> and <strong id="cts_api_0313__b1814516481255">disabled</strong>.</p>
<p id="cts_api_0313__p1850918399419">Enumerated values:</p>
<ul id="cts_api_0313__ul125092393413"><li id="cts_api_0313__li15509183918413"><strong id="cts_api_0313__b155091339147">enabled</strong></li><li id="cts_api_0313__li450918391545"><strong id="cts_api_0313__b650913396419">disabled</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0313__row750511398415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p1751019391244">topic_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p851093914414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0313__p051014398413">Topic URN.</p>
<ul id="cts_api_0313__ul13510133916410"><li id="cts_api_0313__li18510139941">To obtain the <strong id="cts_api_0313__b19955152312815">topic_urn</strong>, call the SMN API for querying topics. Example URN: <strong id="cts_api_0313__b1796218238813">urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0313__row75058391047"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p16510153920412">notification_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p5510133915418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0313__p195113391344">Unique notification ID.</p>
</td>
</tr>
<tr id="cts_api_0313__row25050391416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p1051110394419">notification_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p2511939646">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0313__p195112391344">Notification type.</p>
<p id="cts_api_0313__p05116393412">Enumerated value:</p>
<ul id="cts_api_0313__ul751113391048"><li id="cts_api_0313__li1851116398417"><strong id="cts_api_0313__b851193911415">smn</strong></li></ul>
</td>
</tr>
<tr id="cts_api_0313__row18505039743"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p12512139847">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p14512839946">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0313__p15512439644">Project ID.</p>
</td>
</tr>
<tr id="cts_api_0313__row5505143916412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0313__p1251218392042">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0313__p19512143913413">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0313__p85123395411">Timestamp when a notification was created.</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 6 </b>Operations</caption><thead align="left"><tr id="cts_api_0313__row9513153914411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="cts_api_0313__p85143391443">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="cts_api_0313__p1351418391548">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="cts_api_0313__p85141839944">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row4513339845"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0313__p17514139647">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0313__p651433916420">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0313__p1851413913410">Cloud service. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in the <em id="cts_api_0313__i149255191839">Cloud Trace Service User Guide</em>.</p>
</td>
</tr>
<tr id="cts_api_0313__row175139391415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0313__p10515739144">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0313__p85151639948">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0313__p155159391144">Resource type.</p>
</td>
</tr>
<tr id="cts_api_0313__row145136391418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0313__p851510391848">trace_names</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0313__p251518391412">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0313__p551516391417">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 7 </b>NotificationUsers</caption><thead align="left"><tr id="cts_api_0313__row8516193912419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="cts_api_0313__p165164395416">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="cts_api_0313__p75167391945">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="cts_api_0313__p65162391546">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row1851615397418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0313__p851743919417">user_group</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0313__p1251714397411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0313__p125174391413">IAM user group.</p>
</td>
</tr>
<tr id="cts_api_0313__row55164391441"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0313__p1151716391342">user_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0313__p165177391241">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0313__p4517339544">IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cts_api_0313__p768315391446"><strong id="cts_api_0313__b1568310391843">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 8 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0313__row4524439243"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="cts_api_0313__p186839397413">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="cts_api_0313__p9684143912414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="cts_api_0313__p868411391420">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row252415393412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cts_api_0313__p9684439946">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cts_api_0313__p768414391414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cts_api_0313__p14684133917415">Error code. Format: <strong id="cts_api_0313__b19889192131916">CTS.</strong><em id="cts_api_0313__i189692131910">XXX</em>.</p>
</td>
</tr>
<tr id="cts_api_0313__row652413391048"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cts_api_0313__p868417391444">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cts_api_0313__p66844394414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cts_api_0313__p668413391741">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0313__section0684123910411"><h4 class="sectiontitle">Example Request</h4><p id="cts_api_0313__p1368420396413">Modifying a key event notification</p>
<pre class="screen" id="cts_api_0313__screen13684183910418">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", "deleteTraceker" ]
}, {
"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__section768518391841"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0313__p13685839543"><strong id="cts_api_0313__b843182363815">Status code: 200</strong></p>
<p id="cts_api_0313__p16685183915411">The notification is modified.</p>
<pre class="screen" id="cts_api_0313__screen146855394420">{
"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", "deleteTraceker" ]
}, {
"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__section868743910411"><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__row85302392049"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_0313__p268719391641">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="cts_api_0313__p126876392042">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cts_api_0313__row185301739247"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0313__p8687639745">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0313__p1068713912410">The notification is modified.</p>
</td>
</tr>
<tr id="cts_api_0313__row553063919412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0313__p11687939946">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0313__p1568783911411">The server failed to process the request.</p>
</td>
</tr>
<tr id="cts_api_0313__row953063911418"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0313__p11687939942">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0313__p16871839547">The request is rejected due to authentication failure.</p>
</td>
</tr>
<tr id="cts_api_0313__row1553033912413"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0313__p1168719391347">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0313__p8687183911411">The server understood the request but refused to authorize it.</p>
</td>
</tr>
<tr id="cts_api_0313__row1653163918410"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0313__p9687339148">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0313__p46871139948">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__row1853114391448"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0313__p568714391416">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0313__p1468712391240">The request failed to be executed or some trackers failed to be deleted.</p>
</td>
</tr>
<tr id="cts_api_0313__row25315399410"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0313__p56877390412">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0313__p1668714391747">The requested service is unavailable. The client should not repeat the request without modifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cts_api_0313__section868718391417"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_0313__p14688139549">See <a href="en-us_topic_0168602259.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Key Event Notification Management</a></div>
</div>
</div>
View Git Blame Copy Permalink