forked from docs/doc-exports
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: luhuayi <luhuayi@huawei.com> Co-committed-by: luhuayi <luhuayi@huawei.com>
345 lines
27 KiB
HTML
345 lines
27 KiB
HTML
<a name="EN-US_TOPIC_0000002500014044"></a><a name="EN-US_TOPIC_0000002500014044"></a>
|
|
|
|
<h1 class="topictitle1">Creating an Alarm Subscription</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002500014044__section1647011115502"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002500014044__p347151175017">This API is used to create an alarm subscription.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002500014044__section16471151113502"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000002500014044__p8473171110502">For details, see <a href="dws_02_0062.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002500014044__section1647391145010"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002500014044__p8474131185013">POST /v2/{project_id}/alarm-subs</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500014044__table84751811125017" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002500014044__row194752116501"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002500014044__p11476111175016">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002500014044__p447711125014">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002500014044__p347771113507">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002500014044__p18478141135011">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002500014044__row134751911205011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002500014044__p74798111508">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002500014044__p4479711175018">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002500014044__p948061116505">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002500014044__p1481191115011"><strong id="EN-US_TOPIC_0000002500014044__b194811811105011">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p148211113505">Project ID. To obtain the value, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p84831211165010"><strong id="EN-US_TOPIC_0000002500014044__b4483141120503">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p16483011185019">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p148471145011"><strong id="EN-US_TOPIC_0000002500014044__b74846113501">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p19484411125015">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1485711115011"><strong id="EN-US_TOPIC_0000002500014044__b748512116508">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p84852113504">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002500014044__section3486181117509"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500014044__en-us_topic_0000002341097500_request_AlarmSubRequest" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002500014044__row948721115501"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000002500014044__p548941125016">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000002500014044__p949010110503">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000002500014044__p1849171165017">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000002500014044__p64928119501">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002500014044__row8487161115011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002500014044__p4492411125020">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002500014044__p19493111135011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002500014044__p19494151165014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002500014044__p20495171115508"><strong id="EN-US_TOPIC_0000002500014044__b184956111508">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p849551185010">Subscribed alarm name.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p5496141115509"><strong id="EN-US_TOPIC_0000002500014044__b1149612113508">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p24961411115013">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row4487201115018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002500014044__p13497181111502">enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002500014044__p8498131118502">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002500014044__p9498141195019">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002500014044__p13499101185012"><strong id="EN-US_TOPIC_0000002500014044__b114991911185012">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p2500311195017">Whether to enable subscription.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1850021165019"><strong id="EN-US_TOPIC_0000002500014044__b950015112506">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1450121112501">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row1348791185013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002500014044__p3501181125017">alarm_level</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002500014044__p1750241112508">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002500014044__p750331155018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002500014044__p11505181155012"><strong id="EN-US_TOPIC_0000002500014044__b8505151116509">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p11505191119503">Alarm severity.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p11506121120503"><strong id="EN-US_TOPIC_0000002500014044__b1950651155010">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1650671110503">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row1848791112503"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002500014044__p8507101195016">notification_target</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002500014044__p115081911145013">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002500014044__p950811117509">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002500014044__p2509131115015"><strong id="EN-US_TOPIC_0000002500014044__b175104113502">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p251071185019">Message topic address.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p051001113500"><strong id="EN-US_TOPIC_0000002500014044__b5511181118509">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p4511911155014">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row104874110508"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002500014044__p10512141117508">notification_target_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002500014044__p1651211119506">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002500014044__p105131611175012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002500014044__p8514191112505"><strong id="EN-US_TOPIC_0000002500014044__b351441165019">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p0514101155011">Message topic name.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p13515171195012"><strong id="EN-US_TOPIC_0000002500014044__b1251510111509">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p951511175016">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row13487511115013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002500014044__p351614116508">notification_target_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002500014044__p4517121145017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002500014044__p15178117501">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002500014044__p1551911145016"><strong id="EN-US_TOPIC_0000002500014044__b75193112508">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1551910113509">Message topic type. Only SMN is supported.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p452051195018"><strong id="EN-US_TOPIC_0000002500014044__b19520191118507">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1452019116503">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row134879117502"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002500014044__p2521171117507">time_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002500014044__p15522171118504">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002500014044__p3522011195014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002500014044__p115243118509"><strong id="EN-US_TOPIC_0000002500014044__b55241811175011">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p13524211205011">Time zone.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1952571113509"><strong id="EN-US_TOPIC_0000002500014044__b952591117500">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1252591165014">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002500014044__section45261811175011"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002500014044__p10527181118509"><strong id="EN-US_TOPIC_0000002500014044__b9527171115506">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500014044__en-us_topic_0000002341097500_response_AlarmSubscriptionResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002500014044__row35271311155013"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002500014044__p1552920118504">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000002500014044__p2530161145018">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000002500014044__p9530611115013">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002500014044__row55282112507"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p11531201165014">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p1753291118504">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p195337110501"><strong id="EN-US_TOPIC_0000002500014044__b13533191125019">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p19533121118509">Alarm subscription ID.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1553421115504"><strong id="EN-US_TOPIC_0000002500014044__b953431155016">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1253517112505">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row14528511135016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p3535311135012">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p165361911115013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p653751165016"><strong id="EN-US_TOPIC_0000002500014044__b8538181135014">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p195383118500">Subscribed alarm name.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p4538201114501"><strong id="EN-US_TOPIC_0000002500014044__b553981118507">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p13539121195015">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row105284111506"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p6540911195011">enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p20540511115017">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p5541141185011"><strong id="EN-US_TOPIC_0000002500014044__b19542121114502">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1054261113507">Whether to enable subscription.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p154216116506"><strong id="EN-US_TOPIC_0000002500014044__b1954351135011">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1354321117504">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row1528161195011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p1054412112504">alarm_level</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p2544121115010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p1454561117500"><strong id="EN-US_TOPIC_0000002500014044__b554601145011">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p954651115018">Alarm severity.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1546011165014"><strong id="EN-US_TOPIC_0000002500014044__b154721110509">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p65474114504">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row85281711205011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p1054813112506">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p1954851111501">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p755011155015"><strong id="EN-US_TOPIC_0000002500014044__b105502111506">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p9550121115019">Project ID.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p185511211175017"><strong id="EN-US_TOPIC_0000002500014044__b5551121117509">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p11551141112509">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row352815113506"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p155521411185019">name_space</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p8553201115014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p6554131115014"><strong id="EN-US_TOPIC_0000002500014044__b14554191111501">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1554121118502">Service to which the alarm belongs.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p755551117502"><strong id="EN-US_TOPIC_0000002500014044__b955551165013">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p8555181125011">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row85287117506"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p12556171175016">notification_target</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p3557131125011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p755819116507"><strong id="EN-US_TOPIC_0000002500014044__b175584113502">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p3558191155012">Message topic address.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p6559151112506"><strong id="EN-US_TOPIC_0000002500014044__b255931113504">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p4559181135018">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row17528131114505"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p75601118504">notification_target_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p656016115505">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p18561611105014"><strong id="EN-US_TOPIC_0000002500014044__b195621111195019">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1056212117503">Message topic name.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p1056261111506"><strong id="EN-US_TOPIC_0000002500014044__b1256316113506">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p456341119507">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row852816113506"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p20564121118508">notification_target_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p16564121112501">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p356511118503"><strong id="EN-US_TOPIC_0000002500014044__b11566811125016">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p20566181175014">Message topic type.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p8567191117506"><strong id="EN-US_TOPIC_0000002500014044__b756711117501">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p155671411135019">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row165286112507"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p556851117508">language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p185694115502">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p25691911165013"><strong id="EN-US_TOPIC_0000002500014044__b12570511165016">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p15570131135013">Language.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p4571151195017"><strong id="EN-US_TOPIC_0000002500014044__b65716115507">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p115711411165015">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row14528511105018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002500014044__p057211115502">time_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002500014044__p9572111175014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002500014044__p1057371155013"><strong id="EN-US_TOPIC_0000002500014044__b357441118506">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p857421185012">Time zone.</p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p12574611105016"><strong id="EN-US_TOPIC_0000002500014044__b0575711145017">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p55751911115015">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002500014044__section165768114501"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002500014044__p257712117506">Create an alarm subscription (Subscription name: <strong id="EN-US_TOPIC_0000002500014044__b1357861117508">zrf-test-12</strong>. Alarm m severity: <strong id="EN-US_TOPIC_0000002500014044__b457810114505">critical,major,minor</strong>. SMN topic name: <strong id="EN-US_TOPIC_0000002500014044__b457811110503">dws-test-nodelete</strong>. Topic address: <strong id="EN-US_TOPIC_0000002500014044__b1578201175015">urn:smn:<span id="EN-US_TOPIC_0000002500014044__text48332044175017">eu-de-01</span>:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete</strong>).</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002500014044__screen5579191165012">https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs
|
|
|
|
{
|
|
"alarm_level" : "urgent,important,minor",
|
|
"enable" : 1,
|
|
"name" : "zrf-test-12",
|
|
"notification_target" : "urn:smn:<span id="EN-US_TOPIC_0000002500014044__text14450552155010">eu-de-01</span>:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
|
|
"notification_target_name" : "dws-test-nodelete",
|
|
"notification_target_type" : "SMN",
|
|
"time_zone" : "GMT+08:00"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002500014044__section105852116507"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002500014044__p5586161115010"><strong id="EN-US_TOPIC_0000002500014044__b15586191118503">Status code: 200</strong></p>
|
|
<p id="EN-US_TOPIC_0000002500014044__p18586141125011">Alarm subscription created.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002500014044__screen14588171175018">{
|
|
"id" : "273ce506-dad8-411c-92f9-be5004739b40",
|
|
"name" : "zrf-test-12",
|
|
"enable" : 1,
|
|
"language" : "zh-cn",
|
|
"alarm_level" : "urgent,important,minor",
|
|
"project_id" : "4cf650fd46704908aa071b4df2453e1e",
|
|
"name_space" : "dws",
|
|
"notification_target" : "urn:smn:<span id="EN-US_TOPIC_0000002500014044__text14361958175017">eu-de-01</span>:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
|
|
"notification_target_name" : "dws-test-nodelete",
|
|
"notification_target_type" : "SMN",
|
|
"time_zone" : "GMT+08:00"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002500014044__section161718124500"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500014044__en-us_topic_0000002341097500_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002500014044__row1566014118504"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002500014044__p1717271255020">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="EN-US_TOPIC_0000002500014044__p14172112175013">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002500014044__row966071115013"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002500014044__p217217126502">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002500014044__p71721012145012">Alarm subscription created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row1466013118503"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002500014044__p10173181212506">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002500014044__p151733125505">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row76601811155011"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002500014044__p1617361216502">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002500014044__p41738123508">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row16660511145017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002500014044__p151741912165015">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002500014044__p17174101219504">You do not have required permissions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row1466061119509"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002500014044__p141741712135013">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002500014044__p18174512125020">No resources found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row1660411195013"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002500014044__p417411285011">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002500014044__p51751312145013">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002500014044__row116603118505"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002500014044__p517591212501">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002500014044__p917571216507">Service unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0544.html">Alarm Management</a></div>
|
|
</div>
|
|
</div>
|
|
|