doc-exports/docs/ces/api-ref/ces_03_0075.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

552 lines
39 KiB
HTML

<a name="ces_03_0075"></a><a name="ces_03_0075"></a>
<h1 class="topictitle1">Querying Details of an Event</h1>
<div id="body1606895824429"><div class="section" id="ces_03_0075__section366675881818"><h4 class="sectiontitle">Function</h4><p id="ces_03_0075__p13723154032719">This API is used to query details of an event based on the event name.</p>
</div>
<div class="section" id="ces_03_0075__section466795818180"><h4 class="sectiontitle">URI</h4><p id="ces_03_0075__p96915941813">GET /V1.0/{project_id}/event/{event_name}</p>
<ul id="ces_03_0075__ul1869659131811"><li id="ces_03_0075__li8691459151818">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0075__table968175851812" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0075__row773175951818"><th align="left" class="cellrowborder" valign="top" width="17.93%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="ces_03_0075__p67318593183">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.059999999999999%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="ces_03_0075__p57375911813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.34%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="ces_03_0075__p9906156492">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.669999999999995%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="ces_03_0075__p5731559181818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0075__row07325991818"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p147311599186">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p147385911180">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p09071461093">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p8738593188">Specifies the project ID.</p>
<p id="ces_03_0075__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>
<tr id="ces_03_0075__row103162334010"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p62322394013">event_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p1923182364012">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p7907116292">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p123623134014">Specifies the event name.</p>
</td>
</tr>
<tr id="ces_03_0075__row14316231406"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p142492318403">event_type</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p19244233402">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p79071666912">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p182442311404">Specifies the event type. The value can be <strong id="ces_03_0075__b2428929193815">EVENT.SYS</strong> (system event) or <strong id="ces_03_0075__b10429929193810">EVENT.CUSTOM</strong> (custom event).</p>
</td>
</tr>
<tr id="ces_03_0075__row1131623194015"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p192472354020">event_source</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p224202314404">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p119071161893">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p724162318409">Specifies the event name. The name can be a system event name or a custom event name.</p>
</td>
</tr>
<tr id="ces_03_0075__row8311823124018"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p132412344019">event_level</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p19241823134013">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p5907166195">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p824723184019">Specifies the event severity. The value can be <strong id="ces_03_0075__b145719421396">Critical</strong>, <strong id="ces_03_0075__b5253194516393">Major</strong>, <strong id="ces_03_0075__b161411748173918">Minor</strong>, or <strong id="ces_03_0075__b183831251183913">Info</strong>.</p>
</td>
</tr>
<tr id="ces_03_0075__row11311323114016"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p15249238405">event_user</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p172418235404">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p139072612918">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p1024423134016">Specifies the name of the user who reports the event monitoring data. It can also be a project ID.</p>
</td>
</tr>
<tr id="ces_03_0075__row1031182384011"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p11246239401">event_state</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p0244231403">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p890711612910">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p1824142310406">Specifies the event status. The value can be <strong id="ces_03_0075__b318611449518">normal</strong>, <strong id="ces_03_0075__b54161148175118">warning</strong>, or <strong id="ces_03_0075__b19770125513514">incident</strong>.</p>
</td>
</tr>
<tr id="ces_03_0075__row6311523204019"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p924523104017">from</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p4241223134019">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p189079617916">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p1024112324014">Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms. Example: <strong id="ces_03_0075__b10177542125211">1605952700911</strong></p>
</td>
</tr>
<tr id="ces_03_0075__row63192317405"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p1224112314407">to</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p1324172319408">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p15907867917">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p6241523114019">Specifies the end time of the query. The time is a UNIX timestamp and the unit is ms. The <strong id="ces_03_0075__b14360145152210">from</strong> value must be smaller than the <strong id="ces_03_0075__b636120450222">to</strong> value.</p>
</td>
</tr>
<tr id="ces_03_0075__row431102314016"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p1924123154012">start</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p1624162311409">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p16907964913">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p22422384014">Specifies the start value of pagination. The value is an integer. The default value is <strong id="ces_03_0075__b12638712185413">0</strong>.</p>
</td>
</tr>
<tr id="ces_03_0075__row431182374013"><td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="ces_03_0075__p10249234401">limit</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="ces_03_0075__p8244233402">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.34%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="ces_03_0075__p8907106697">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.669999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="ces_03_0075__p1124122319403">Specifies the maximum number of records that can be queried at a time. Supported range: <strong id="ces_03_0075__b19564122972911">1</strong> to <strong id="ces_03_0075__b18564162914293">100</strong> (default)</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="ces_03_0075__li1828207216">Example<pre class="screen" id="ces_03_0075__screen1988021814918">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/event/{event_name}</pre>
</li></ul>
</div>
<div class="section" id="ces_03_0075__section821383311476"><h4 class="sectiontitle">Request</h4><p id="ces_03_0075__p894123894012">None</p>
</div>
<div class="section" id="ces_03_0075__section15686020"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0075__ul18172319115615"><li id="ces_03_0075__li3172219105615">Response parameters</li></ul>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0075__table7943519201717" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0075__row10740341101717"><th align="left" class="cellrowborder" valign="top" width="20.3%" id="mcps1.3.4.3.2.5.1.1"><p id="ces_03_0075__p4740641151713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.419999999999998%" id="mcps1.3.4.3.2.5.1.2"><p id="ces_03_0075__p17740154191717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.62%" id="mcps1.3.4.3.2.5.1.3"><p id="ces_03_0075__p3740164114177">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.660000000000004%" id="mcps1.3.4.3.2.5.1.4"><p id="ces_03_0075__p197401541131710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0075__row99681719151714"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ces_03_0075__p19968161916174">event_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ces_03_0075__p196801915173">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.62%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ces_03_0075__p69681519131711">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.660000000000004%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ces_03_0075__p1496871912171">Specifies the event name. The name can be a system event name or a custom event name.</p>
</td>
</tr>
<tr id="ces_03_0075__row16968151961720"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ces_03_0075__p16968201912175">event_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ces_03_0075__p4968819101714">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.62%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ces_03_0075__p179681019171711">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.660000000000004%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ces_03_0075__p4968619121713">Specifies the event type. The value can be <strong id="ces_03_0075__b4432134297">EVENT.SYS</strong> (system event) or <strong id="ces_03_0075__b24416392915">EVENT.CUSTOM</strong> (custom event).</p>
</td>
</tr>
<tr id="ces_03_0075__row1896891912177"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ces_03_0075__p169688194170">event_users</p>
</td>
<td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ces_03_0075__p7968111981713">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="13.62%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ces_03_0075__p8968819161715">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.660000000000004%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ces_03_0075__p1396861916173">Specifies the name of the user who reports the event. It can also be a project ID.</p>
</td>
</tr>
<tr id="ces_03_0075__row296815198179"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ces_03_0075__p7968919151713">event_sources</p>
</td>
<td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ces_03_0075__p1396061582611">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="13.62%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ces_03_0075__p9968191911177">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.660000000000004%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ces_03_0075__p1696811911175">Specifies the event source. If the event is a system event, the source is the namespace of each service. To view the namespace of each service, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>. If the event is a custom event, the event source is defined by the user.</p>
</td>
</tr>
<tr id="ces_03_0075__row189681519111716"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ces_03_0075__p12968131914175">event_info</p>
</td>
<td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ces_03_0075__p19681719151712">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="13.62%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ces_03_0075__p10968101915173">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.660000000000004%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ces_03_0075__p89681319191716">Specifies details of one or more events. </p>
<p id="ces_03_0075__p5251521154211">For details, see <a href="#ces_03_0075__table1062815415499">Table 3</a>.</p>
</td>
</tr>
<tr id="ces_03_0075__row19968161941720"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ces_03_0075__p1696871911710">meta_data</p>
</td>
<td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ces_03_0075__p1096871911716">MetaData object</p>
</td>
<td class="cellrowborder" valign="top" width="13.62%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ces_03_0075__p296821981714">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.660000000000004%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ces_03_0075__p7968151961716">Specifies the number of metadata records in the query result.</p>
<p id="ces_03_0075__p21461323164214">For details, see <a href="#ces_03_0075__table642174817533">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0075__table1062815415499"></a><a name="table1062815415499"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0075__table1062815415499" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0075__b18820444155518">event_info</strong> data structure description</caption><thead align="left"><tr id="ces_03_0075__row197398845018"><th align="left" class="cellrowborder" valign="top" width="21.29%" id="mcps1.3.4.4.2.5.1.1"><p id="ces_03_0075__p574018810505">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.82%" id="mcps1.3.4.4.2.5.1.2"><p id="ces_03_0075__p19740384503">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.48%" id="mcps1.3.4.4.2.5.1.3"><p id="ces_03_0075__p1974068205012">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.410000000000004%" id="mcps1.3.4.4.2.5.1.4"><p id="ces_03_0075__p19740208175016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0075__row4645135420496"><td class="cellrowborder" valign="top" width="21.29%" headers="mcps1.3.4.4.2.5.1.1 "><p id="ces_03_0075__p11287127132018">event_name</p>
</td>
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.4.4.2.5.1.2 "><p id="ces_03_0075__p52873717200">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.48%" headers="mcps1.3.4.4.2.5.1.3 "><p id="ces_03_0075__p152871074208">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.410000000000004%" headers="mcps1.3.4.4.2.5.1.4 "><p id="ces_03_0075__p172871879201">Specifies the event name. Start with a letter. Enter 1 to 64 characters. Only letters, digits, and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="ces_03_0075__row17645115415491"><td class="cellrowborder" valign="top" width="21.29%" headers="mcps1.3.4.4.2.5.1.1 "><p id="ces_03_0075__p52871975206">event_source</p>
</td>
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.4.4.2.5.1.2 "><p id="ces_03_0075__p1328717732012">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.48%" headers="mcps1.3.4.4.2.5.1.3 "><p id="ces_03_0075__p142871277203">No</p>
</td>
<td class="cellrowborder" valign="top" width="46.410000000000004%" headers="mcps1.3.4.4.2.5.1.4 "><p id="ces_03_0075__p1128710710204">Specifies the event source in the format of service.item. <strong id="ces_03_0075__b4204124419563">service</strong> and <strong id="ces_03_0075__b102071344195615">item</strong> each must start with a letter and contain 3 to 32 characters, including only letters, digits, and underscores (_).</p>
</td>
</tr>
<tr id="ces_03_0075__row1264518548492"><td class="cellrowborder" valign="top" width="21.29%" headers="mcps1.3.4.4.2.5.1.1 "><p id="ces_03_0075__p02871579202">time</p>
</td>
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.4.4.2.5.1.2 "><p id="ces_03_0075__p152871576207">Long</p>
</td>
<td class="cellrowborder" valign="top" width="14.48%" headers="mcps1.3.4.4.2.5.1.3 "><p id="ces_03_0075__p72871076202">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.410000000000004%" headers="mcps1.3.4.4.2.5.1.4 "><p id="ces_03_0075__p142871875206">Specifies when the event occurred, which is a UNIX timestamp (ms). 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>
</td>
</tr>
<tr id="ces_03_0075__row1964605454920"><td class="cellrowborder" valign="top" width="21.29%" headers="mcps1.3.4.4.2.5.1.1 "><p id="ces_03_0075__p1628715722014">detail</p>
</td>
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.4.4.2.5.1.2 "><p id="ces_03_0075__p1028716722014">Detail object</p>
</td>
<td class="cellrowborder" valign="top" width="14.48%" headers="mcps1.3.4.4.2.5.1.3 "><p id="ces_03_0075__p15287127112010">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.410000000000004%" headers="mcps1.3.4.4.2.5.1.4 "><p id="ces_03_0075__p628710732016">Specifies the event details.</p>
<p id="ces_03_0075__p39491444144212">For details, see <a href="#ces_03_0075__table415114181224">Table 4</a>.</p>
</td>
</tr>
<tr id="ces_03_0075__row20646145416494"><td class="cellrowborder" valign="top" width="21.29%" headers="mcps1.3.4.4.2.5.1.1 "><p id="ces_03_0075__p9287976203">event_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.82%" headers="mcps1.3.4.4.2.5.1.2 "><p id="ces_03_0075__p72874722017">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.48%" headers="mcps1.3.4.4.2.5.1.3 "><p id="ces_03_0075__p1828777182012">No</p>
</td>
<td class="cellrowborder" valign="top" width="46.410000000000004%" headers="mcps1.3.4.4.2.5.1.4 "><p id="ces_03_0075__p32874715200">Specifies the event ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0075__table415114181224"></a><a name="table415114181224"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0075__table415114181224" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0075__b1216915359585">detail</strong> data structure description</caption><thead align="left"><tr id="ces_03_0075__row620412282229"><th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.4.5.2.5.1.1"><p id="ces_03_0075__p4204172813224">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.22%" id="mcps1.3.4.5.2.5.1.2"><p id="ces_03_0075__p1420462815229">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.5.2.5.1.3"><p id="ces_03_0075__p920452832214">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.849999999999994%" id="mcps1.3.4.5.2.5.1.4"><p id="ces_03_0075__p19204152817222">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0075__row1017991810222"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p12179191810226">content</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p717971852218">String</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p217916185229">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p21791018132217">Specifies the event content. Enter up to 4,096 characters.</p>
</td>
</tr>
<tr id="ces_03_0075__row817961810222"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p14179131812228">group_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p11791418132216">String</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p1179151817226">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p1217912184229">Specifies the resource group the event belongs to. This ID must be an existing resource group ID.</p>
</td>
</tr>
<tr id="ces_03_0075__row1017911852212"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p1317991812225">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p15179618152211">String</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p81791318172220">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p71794185221">Specifies the resource ID, which can contain a maximum of 128 characters.</p>
</td>
</tr>
<tr id="ces_03_0075__row6179418182212"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p41791918182219">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p3179918112210">String</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p8179151818224">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p131796183222">Specifies the resource name, which can contain a maximum of 128 characters.</p>
</td>
</tr>
<tr id="ces_03_0075__row517991813221"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p1017961892213">event_state</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p517941813226">String</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p15179618172211">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p138271228102619">Specifies the event status.</p>
<p id="ces_03_0075__p6179171818229">The value can be <strong id="ces_03_0075__b842352706154129">normal</strong>, <strong id="ces_03_0075__b842352706154133">warning</strong>, or <strong id="ces_03_0075__b842352706154144">incident</strong>.</p>
</td>
</tr>
<tr id="ces_03_0075__row191791184223"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p12179111817221">event_level</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p1317921813229">String</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p21791918112217">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p16662239102720">Specifies the event severity.</p>
<p id="ces_03_0075__p191791318202210">The value can be <strong id="ces_03_0075__b84235270619531">Critical</strong>, <strong id="ces_03_0075__b84235270619534">Major</strong>, <strong id="ces_03_0075__b84235270619538">Minor</strong>, or <strong id="ces_03_0075__b842352706195318">Info</strong>.</p>
</td>
</tr>
<tr id="ces_03_0075__row17179191872219"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p11797185227">event_user</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p017931813226">String</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p191790184223">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p31796186228">Specifies the event user. Enter up to 64 characters.</p>
</td>
</tr>
<tr id="ces_03_0075__row420615546311"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p1816661819313">event_type</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p10167191811313">String</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p1220685443115">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p103431068349">Specifies the event type.</p>
<p id="ces_03_0075__p916714188318">The value can be <strong id="ces_03_0075__b13703445216">EVENT.SYS</strong> (system event) or <strong id="ces_03_0075__b737934105218">EVENT.CUSTOM</strong> (custom event).</p>
</td>
</tr>
<tr id="ces_03_0075__row8591622530"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.5.1.1 "><p id="ces_03_0075__p459112205313">dimensions</p>
</td>
<td class="cellrowborder" valign="top" width="15.22%" headers="mcps1.3.4.5.2.5.1.2 "><p id="ces_03_0075__p175441335175318">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ces_03_0075__p1544435205311">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ces_03_0075__p5726195935311">Specifies one or more resource dimensions.</p>
<p id="ces_03_0075__p1494844185613">For details, see <a href="#ces_03_0075__table18171172815712">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0075__table18171172815712"></a><a name="table18171172815712"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0075__table18171172815712" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="ces_03_0075__b695320710164">dimensions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0075__row417232817573"><th align="left" class="cellrowborder" valign="top" width="9.15%" id="mcps1.3.4.6.2.5.1.1"><p id="ces_03_0075__p19204163610587">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.870000000000001%" id="mcps1.3.4.6.2.5.1.2"><p id="ces_03_0075__p7204163685815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.43%" id="mcps1.3.4.6.2.5.1.3"><p id="ces_03_0075__p1020412360587">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.55%" id="mcps1.3.4.6.2.5.1.4"><p id="ces_03_0075__p17204936195819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0075__row7172328135710"><td class="cellrowborder" valign="top" width="9.15%" headers="mcps1.3.4.6.2.5.1.1 "><p id="ces_03_0075__p9588164019308">name</p>
</td>
<td class="cellrowborder" valign="top" width="12.870000000000001%" headers="mcps1.3.4.6.2.5.1.2 "><p id="ces_03_0075__p858811407301">String</p>
</td>
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.6.2.5.1.3 "><p id="ces_03_0075__p207498065511">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.55%" headers="mcps1.3.4.6.2.5.1.4 "><p id="ces_03_0075__p228921325315">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0075__b8966111591612">instance_id</strong>. For details about the dimension of each service, see the <strong id="ces_03_0075__b1195792913161">key</strong> column in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
</td>
</tr>
<tr id="ces_03_0075__row017362885710"><td class="cellrowborder" valign="top" width="9.15%" headers="mcps1.3.4.6.2.5.1.1 "><p id="ces_03_0075__p19588184023011">value</p>
</td>
<td class="cellrowborder" valign="top" width="12.870000000000001%" headers="mcps1.3.4.6.2.5.1.2 "><p id="ces_03_0075__p1588154012306">String</p>
</td>
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.6.2.5.1.3 "><p id="ces_03_0075__p10480204213015">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.55%" headers="mcps1.3.4.6.2.5.1.4 "><p id="ces_03_0075__p11371113251615">Specifies the dimension value, for example, an ECS ID.</p>
<p id="ces_03_0075__p1798291054314">Enter 1 to 256 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0075__table642174817533"></a><a name="table642174817533"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0075__table642174817533" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="ces_03_0075__b173044583014">meta_data</strong> data structure description</caption><thead align="left"><tr id="ces_03_0075__row1976575335315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.5.1.1"><p id="ces_03_0075__p676520531536">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.5.1.2"><p id="ces_03_0075__p15765115325320">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.5.1.3"><p id="ces_03_0075__p14765145395312">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.5.1.4"><p id="ces_03_0075__p1876515395315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0075__row1943512487538"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.5.1.1 "><p id="ces_03_0075__p18435134814533">total</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.5.1.2 "><p id="ces_03_0075__p1543515485538">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.5.1.3 "><p id="ces_03_0075__p9435184855311">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.5.1.4 "><p id="ces_03_0075__p144351648155313">Specifies the total number of events.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<ul id="ces_03_0075__ul33777478184830"><li id="ces_03_0075__li35561846184830">Example response<pre class="screen" id="ces_03_0075__screen2358389810228">{
"event_name": "rebootServer",
"event_type": "EVENT.SYS",
"event_users": [
""
],
"event_sources": [
"SYS.ECS"
],
"event_info": [
{
"event_id": "ev1606302402256R6doP5YeZ",
"event_name": "rebootServer",
"event_source": "SYS.ECS",
"time": 1606302400000,
"detail": {
"content": "{\"resourceSpecCode\":\"kc1.4xlarge.2.linux\",\"enterpriseProjectId\":\"6efb843e-391a-46a8-afc8-7fe51c9dd575\"}",
"group_id": "",
"resource_id": "ef8dad27-0488-4de7-bb43-1a0df9806d90",
"resource_name": "CES-POROS-0001",
"event_state": "normal",
"event_level": "Minor",
"event_user": "",
"event_type": "EVENT.SYS",
"dimensions": [
{
"name": "instance_id",
"value": "fddad01f-e3b6-420d-8fdc-a42451de7c34"
}
]
}
},
{
"event_id": "ev1606296088071wGoAOxVYa",
"event_name": "rebootServer",
"event_source": "SYS.ECS",
"time": 1606296086000,
"detail": {
"content": "{\"resourceSpecCode\":\"kc1.4xlarge.2.linux\",\"enterpriseProjectId\":\"6efb843e-391a-46a8-afc8-7fe51c9dd575\"}",
"group_id": "",
"resource_id": "ef8dad27-0488-4de7-bb43-1a0df9806d90",
"resource_name": "CES-POROS-0001",
"event_state": "normal",
"event_level": "Minor",
"event_user": "",
"event_type": "EVENT.SYS",
"dimensions": [
{
"name": "instance_id",
"value": "fddad01f-e3b6-420d-8fdc-a42451de7c34"
}
]
}
},
{
"event_id": "ev1604654426090g7g37E6Yb",
"event_name": "rebootServer",
"event_source": "SYS.ECS",
"time": 1604654425000,
"detail": {
"content": "{\"resourceSpecCode\":\"c6.4xlarge.2.linux\",\"enterpriseProjectId\":\"129559eb-f795-4b5f-9e46-cbd43a462362\"}",
"group_id": "",
"resource_id": "0bfa63ee-31f5-40a9-b992-50992c80c58a",
"resource_name": "ndrv2-pod-ops-0001",
"event_state": "normal",
"event_level": "Minor",
"event_user": "",
"event_type": "EVENT.SYS",
"dimensions": [
{
"name": "instance_id",
"value": "fddad01f-e3b6-420d-8fdc-a42451de7c34"
}
]
}
}
],
"meta_data": {
"total": 5
}
}</pre>
</li></ul>
<div class="section" id="ces_03_0075__section13823158141819"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0075__ul10781759141820"><li id="ces_03_0075__li8784595186">Normal<p id="ces_03_0075__p167865914187"><a name="ces_03_0075__li8784595186"></a><a name="li8784595186"></a>200</p>
</li><li id="ces_03_0075__li17812590185">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0075__table10364173623214" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0075__row03645369329"><th align="left" class="cellrowborder" valign="top" width="32.1%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="ces_03_0075__p1849030182924">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.9%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="ces_03_0075__p15553712182924">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0075__row236413368320"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="ces_03_0075__p581987519168">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="ces_03_0075__p164784039168">Request error.</p>
</td>
</tr>
<tr id="ces_03_0075__row1736413365328"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="ces_03_0075__p2691669168">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="ces_03_0075__p218024949168">The authentication information is not provided or is incorrect.</p>
</td>
</tr>
<tr id="ces_03_0075__row16364113663218"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="ces_03_0075__p563264059168">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="ces_03_0075__p661449719168">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="ces_03_0075__row9364103633216"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="ces_03_0075__p355199299168">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="ces_03_0075__p585420329168">The request timed out.</p>
</td>
</tr>
<tr id="ces_03_0075__row173648363321"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="ces_03_0075__p630127129168">429 Too Many Requests</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="ces_03_0075__p37560249168">Concurrent requests are excessive.</p>
</td>
</tr>
<tr id="ces_03_0075__row1736483643220"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="ces_03_0075__p537873819168">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="ces_03_0075__p618106189168">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="ces_03_0075__row2036473613329"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="ces_03_0075__p298930079168">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="ces_03_0075__p54144829168">The service is currently unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="ces_03_0075__section282724211478"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0075__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>