vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ces/api-ref/en-us_topic_0109034020.html
Dong, Qiu Jian 95f84e7c3b Update CES API -20240104 version 
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
2024-05-07 11:19:42 +00:00

351 lines
28 KiB
HTML
Raw Blame History

<a name="en-us_topic_0109034020"></a><a name="en-us_topic_0109034020"></a>
<h1 class="topictitle1">Reporting Events</h1>
<div id="body1524732199456"><div class="section" id="en-us_topic_0109034020__section366675881818"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0109034020__p11689595189">An API for reporting custom events is provided, which helps you collect and report abnormal events or important change events to Cloud Eye.</p>
</div>
<div class="section" id="en-us_topic_0109034020__section466795818180"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0109034020__p96915941813">POST /V1.0/{project_id}/events</p>
<ul id="en-us_topic_0109034020__ul1869659131811"><li id="en-us_topic_0109034020__li8691459151818">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0109034020__table968175851812" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0109034020__row773175951818"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="en-us_topic_0109034020__p67318593183">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.41%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="en-us_topic_0109034020__p57375911813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.199999999999996%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="en-us_topic_0109034020__p5731559181818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0109034020__row07325991818"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="en-us_topic_0109034020__p147311599186">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="en-us_topic_0109034020__p147385911180">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60.199999999999996%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="en-us_topic_0109034020__p8738593188">Specifies the project ID.</p>
<p id="en-us_topic_0109034020__p8394139675">For details about how to obtain the project ID, see <a href="ces_03_0057.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0109034020__li1573205911186">Example<pre class="screen" id="en-us_topic_0109034020__screen1988021814918">POST https://{Cloud Eye endpoint}/V1.0/{project_id}/events</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0109034020__section16971858161816"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0109034020__ul1574659181817"><li id="en-us_topic_0109034020__li167417595186">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0109034020__table69011263247" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0109034020__row1990162672413"><th align="left" class="cellrowborder" valign="top" width="18.488151184881513%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="en-us_topic_0109034020__p7901112618245">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.358064193580642%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="en-us_topic_0109034020__p20901226192419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.738726127387261%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="en-us_topic_0109034020__p156351519585">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.415058494150585%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="en-us_topic_0109034020__p16901182616246">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0109034020__row12901726192414"><td class="cellrowborder" valign="top" width="18.488151184881513%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="en-us_topic_0109034020__p490182682418">[Array element]</p>
</td>
<td class="cellrowborder" valign="top" width="19.358064193580642%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="en-us_topic_0109034020__p6399215102813">Array of <a href="#en-us_topic_0109034020__table3736458191816">EventItem</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="12.738726127387261%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0109034020__p96355193820">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.415058494150585%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0109034020__p164509304268">Specifies the event list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0109034020__table3736458191816"></a><a name="table3736458191816"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0109034020__table3736458191816" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description of the <strong id="en-us_topic_0109034020__b355984113547">EventItem</strong> field</caption><thead align="left"><tr id="en-us_topic_0109034020__row1674165961815"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="en-us_topic_0109034020__p774759181818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="en-us_topic_0109034020__p57435981816">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="en-us_topic_0109034020__p274759201818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="en-us_topic_0109034020__p4741759141819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0109034020__row1974125911814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0109034020__p18289164174513">event_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0109034020__p177425911812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0109034020__p11119150134018">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0109034020__p8741959191810">Specifies the event name.</p>
<p id="en-us_topic_0109034020__p106265144614">Start with a letter. Enter 1 to 64 characters. Only letters, digits, and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row18741759121812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0109034020__p574185991810">event_source</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0109034020__p37412599182">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0109034020__p552994614611">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0109034020__p1274165911813">Specifies the event source.</p>
<p id="en-us_topic_0109034020__p461714934420">The format is service.item. Set this parameter based on the site requirements.</p>
<p id="en-us_topic_0109034020__p15543145912461"><strong id="en-us_topic_0109034020__b20962028956">service</strong> and <strong id="en-us_topic_0109034020__b89630287510">item</strong> each must be a string that starts with a letter and contains 3 to 32 characters, including only letters, digits, and underscores (_).</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row77425951819"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0109034020__p17768203574712">time</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0109034020__p137415598189">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0109034020__p1832720106403">Long</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0109034020__p47415981815">Specifies when the event occurred, which is a UNIX timestamp (ms).</p>
<div class="note" id="en-us_topic_0109034020__note8502115254914"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0109034020__p1050315220496">Since there is a latency between the client and the server, the data timestamp to be inserted should be within the period that starts from one hour before the current time plus 20s to 10 minutes after the current time minus 20s. In this way, the timestamp will be inserted to the database without being affected by the latency.</p>
<p id="en-us_topic_0109034020__p1737655783613">For example, if the current time is 2020.01.30 12:00:30, the timestamp inserted must be within the range [2020.01.30 11:00:50, 2020.01.30 12:10:10]. The corresponding UNIX timestamp is [1580353250, 1580357410].</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0109034020__row154242222184"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0109034020__p8426722131811">detail</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0109034020__p2426102271819">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0109034020__p2083313141820">Detail object</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0109034020__p3426622181814">Specifies the event details.</p>
<p id="en-us_topic_0109034020__p146201626185112">For details, see <a href="#en-us_topic_0109034020__table181310172506">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0109034020__table181310172506"></a><a name="table181310172506"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0109034020__table181310172506" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="en-us_topic_0109034020__b05271052163814">detail</strong> data structure description</caption><thead align="left"><tr id="en-us_topic_0109034020__row1312419174508"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="en-us_topic_0109034020__p19124121713500">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="en-us_topic_0109034020__p612417174500">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="en-us_topic_0109034020__p9124181714502">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="en-us_topic_0109034020__p71241817145019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0109034020__row912981712509"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0109034020__p4129101718503">content</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0109034020__p012921715011">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0109034020__p4129317175015">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0109034020__p19129181712505">Specifies the event content. Enter up to 4,096 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row8130717115019"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0109034020__p51291717165011">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0109034020__p7130217165017">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0109034020__p15130101765014">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0109034020__p9130171765017">Specifies the resource ID. Enter up to 128 characters, including letters, digits, underscores (_), hyphens (-), and colon (:).</p>
<p id="en-us_topic_0109034020__p17827352102213">Example: 6a69bf28-ee62-49f3-9785-845dacd799ec</p>
<p id="en-us_topic_0109034020__p17838730112219">To query the resource ID, perform the following steps:</p>
<ol id="en-us_topic_0109034020__ol63049455437"><li id="en-us_topic_0109034020__li9304745154311">Log in to the management console.</li><li id="en-us_topic_0109034020__li2304134518435">Under <strong id="en-us_topic_0109034020__b147242812119">Computing</strong>, select <strong id="en-us_topic_0109034020__b12871228132113">Elastic Cloud Server</strong>.<p id="en-us_topic_0109034020__p1085063617224">On the <strong id="en-us_topic_0109034020__b14935163872016">Resource Overview</strong> page, obtain the resource ID.</p>
</li></ol>
</td>
</tr>
<tr id="en-us_topic_0109034020__row141301617175017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0109034020__p513015171504">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0109034020__p191301017165017">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0109034020__p1913091755010">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0109034020__p913011174505">Specifies the resource name. Enter up to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row14130131719503"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0109034020__p181302017135012">event_state</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0109034020__p51301117135013">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0109034020__p107761916164111">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0109034020__p111301317205011">Specifies the event status.</p>
<p id="en-us_topic_0109034020__p5130917145019">The value can be <strong id="en-us_topic_0109034020__b842352706154129">normal</strong>, <strong id="en-us_topic_0109034020__b842352706154133">warning</strong>, or <strong id="en-us_topic_0109034020__b842352706154144">incident</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row6131121775010"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0109034020__p713031710506">event_level</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0109034020__p161313177506">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0109034020__p813111705013">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0109034020__p9131101725011">Specifies the event severity.</p>
<p id="en-us_topic_0109034020__p15131141713507">The value can be <strong id="en-us_topic_0109034020__b84235270619531">Critical</strong>, <strong id="en-us_topic_0109034020__b84235270619534">Major</strong>, <strong id="en-us_topic_0109034020__b84235270619538">Minor</strong>, or <strong id="en-us_topic_0109034020__b842352706195318">Info</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row1131517175017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0109034020__p81311179509">event_user</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0109034020__p913131785015">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0109034020__p199518228417">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0109034020__p12131201765018">Specifies the event user.</p>
<p id="en-us_topic_0109034020__p14131201735016">Enter up to 64 characters, including letters, digits, underscores (_), hyphens (-), slashes (/), and spaces.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row16131151720502"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0109034020__p41310177506">event_type</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0109034020__p141316176507">No</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0109034020__p513101716506">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0109034020__p11316171506">Specifies the event type.</p>
<p id="en-us_topic_0109034020__p313151715505">Its value can be <strong id="en-us_topic_0109034020__b842352706195725">EVENT.SYS</strong> or <strong id="en-us_topic_0109034020__b842352706195733">EVENT.CUSTOM</strong>. <strong id="en-us_topic_0109034020__b842352706195737">EVENT.SYS</strong> indicates system events that cannot be reported by users. Only custom events can be reported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0109034020__ul1877159201814"><li id="en-us_topic_0109034020__li18771759101810">Example request<pre class="screen" id="en-us_topic_0109034020__screen116012215210">[{
"event_name":"systemInvaded",
"event_source":"financial.System",
"time":1522121194000,
"detail":{
"content":"The financial system was invaded",
"group_id":"rg15221211517051YWWkEnVd",
"resource_id":"1234567890sjgggad",
"resource_name":"ecs001",
"event_state":"normal",
"event_level":"Major",
"event_user":"xiaokong",
"event_type": "EVENT.CUSTOM"
}
},
{
"event_name":"systemInvaded",
"event_source":"financial.System",
"time":1522121194020,
"detail":{
"content":"The financial system was invaded",
"group_id":"rg15221211517051YWWkEnVd",
"resource_id":"1234567890sjgggad",
"resource_name":"ecs001",
"event_state":"normal",
"event_level":"Major",
"event_user":"xihong",
"event_type": "EVENT.CUSTOM"
}
}]</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0109034020__section3695195811812"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0109034020__ul39862682184830"><li id="en-us_topic_0109034020__li23219822184830">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0109034020__table10858193319314" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0109034020__row18858123353116"><th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0109034020__p4858193316317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0109034020__p68586335318">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.08%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0109034020__p10858103303117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0109034020__row13858193343116"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0109034020__p785813319311">Array elements</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0109034020__p188582335313">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="59.08%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0109034020__p985963363111">Specifies the event list.</p>
<p id="en-us_topic_0109034020__p1920014475576">For details, see <a href="#en-us_topic_0109034020__table7651809184830">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0109034020__table7651809184830"></a><a name="table7651809184830"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0109034020__table7651809184830" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response parameters</caption><thead align="left"><tr id="en-us_topic_0109034020__row11265298184830"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="en-us_topic_0109034020__p40073906184830">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="en-us_topic_0109034020__p24760926184830">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="en-us_topic_0109034020__p59478015184830">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="en-us_topic_0109034020__p52989949184830">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0109034020__row64327487184830"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="en-us_topic_0109034020__p99051018912">event_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="en-us_topic_0109034020__p5001649184830">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="en-us_topic_0109034020__p2480433184830">String</p>
</td>
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="en-us_topic_0109034020__p66697365184830">Specifies the event ID.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row1136183616448"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="en-us_topic_0109034020__p148048373444">event_name</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="en-us_topic_0109034020__p1280683712444">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="en-us_topic_0109034020__p1811123764418">String</p>
</td>
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="en-us_topic_0109034020__p198141375444">Specifies the event name.</p>
<p id="en-us_topic_0109034020__p1781416375446">Start with a letter. Enter 1 to 64 characters. Only letters, digits, and underscores (_) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0109034020__ul33777478184830"><li id="en-us_topic_0109034020__li35561846184830">Example response<pre class="screen" id="en-us_topic_0109034020__screen2358389810228">[
{
"event_id":"evdgiqwgedkkcvhdjcdu346",
"event_name":"systemInvaded"
},
{
"event_id":"evdgiqwgedkkcvhdjcdu347",
"event_name":"systemParalysis"
}
]</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0109034020__section13823158141819"><h4 class="sectiontitle">Returned Values</h4><ul id="en-us_topic_0109034020__ul10781759141820"><li id="en-us_topic_0109034020__li8784595186">Normal<p id="en-us_topic_0109034020__p167865914187"><a name="en-us_topic_0109034020__li8784595186"></a><a name="li8784595186"></a>201</p>
</li><li id="en-us_topic_0109034020__li17812590185">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0109034020__table10364173623214" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0109034020__row03645369329"><th align="left" class="cellrowborder" valign="top" width="32.1%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="en-us_topic_0109034020__p1849030182924">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.9%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="en-us_topic_0109034020__p15553712182924">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0109034020__row236413368320"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0109034020__p581987519168">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0109034020__p164784039168">Request error.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row1736413365328"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0109034020__p2691669168">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0109034020__p218024949168">The authentication information is not provided or is incorrect.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row16364113663218"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0109034020__p563264059168">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0109034020__p661449719168">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row9364103633216"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0109034020__p355199299168">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0109034020__p585420329168">The request timed out.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row173648363321"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0109034020__p630127129168">429 Too Many Requests</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0109034020__p37560249168">Concurrent requests are excessive.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row1736483643220"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0109034020__p537873819168">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0109034020__p618106189168">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="en-us_topic_0109034020__row2036473613329"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0109034020__p298930079168">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0109034020__p54144829168">The service is currently unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0109034020__section282724211478"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0109034020__ces_03_0020_p91851023153416">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ces_03_0038.html">Event Monitoring</a></div>
</div>
</div>
View Git Blame Copy Permalink