forked from docs/doc-exports
Yang, Tong
d75e275491
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
310 lines
28 KiB
HTML
310 lines
28 KiB
HTML
<a name="ces_03_0033"></a><a name="ces_03_0033"></a>
|
|
|
|
<h1 class="topictitle1">Querying Monitoring Data of a Metric</h1>
|
|
<div id="body1442972132823"><div class="section" id="ces_03_0033__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0033__p65561530">This API is used to query the monitoring data of a specified metric at a specified granularity in a specified time range. You can specify the dimension of data to be queried.</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0033__section62331491"><h4 class="sectiontitle">URI</h4><p id="ces_03_0033__p48490504">GET /V1.0/{project_id}/metric-data?namespace={namespace}&metric_name={metric_name}&dim.{i}=key,value&from={from}&to={to}&period={period}&filter={filter}</p>
|
|
<ul id="ces_03_0033__ul8883693"><li id="ces_03_0033__li33761356">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0033__table75058417558" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0033__row6325008217558"><th align="left" class="cellrowborder" valign="top" width="18.67%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="ces_03_0033__p2298303317558"><strong id="ces_03_0033__b842352706181027">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.520000000000003%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="ces_03_0033__p4968641317558"><strong id="ces_03_0033__b842352706181047">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.81%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="ces_03_0033__p6517651717558"><strong id="ces_03_0033__b842352706181042">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0033__row4480653817558"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0033__p545094717558">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.520000000000003%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0033__p3887356117558">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.81%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0033__p6175070717558">Specifies the project ID.</p>
|
|
<p id="ces_03_0033__p875712401269">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>
|
|
<div class="p" id="ces_03_0033__p103010442017">
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0033__table35416756" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameter description</caption><thead align="left"><tr id="ces_03_0033__row27598891"><th align="left" class="cellrowborder" valign="top" width="18.610000000000003%" id="mcps1.3.2.3.1.2.1.2.5.1.1"><p id="ces_03_0033__p20917673"><strong id="ces_03_0033__b842352706181055">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.610000000000001%" id="mcps1.3.2.3.1.2.1.2.5.1.2"><p id="ces_03_0033__p16609919"><strong id="ces_03_0033__b84235270618110">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.470000000000002%" id="mcps1.3.2.3.1.2.1.2.5.1.3"><p id="ces_03_0033__p29058925163547"><strong id="ces_03_0033__b84235270618114">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.31%" id="mcps1.3.2.3.1.2.1.2.5.1.4"><p id="ces_03_0033__p3226198"><strong id="ces_03_0033__b84235270618118">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0033__row59995477"><td class="cellrowborder" valign="top" width="18.610000000000003%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0033__p3900147595641">namespace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.610000000000001%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0033__p500289695641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.470000000000002%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0033__p4962713163547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.31%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0033__p2687838193910">Specifies the namespace of a service. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
|
|
<p id="ces_03_0033__p1529914911223">The namespace must be in the <strong id="ces_03_0033__b764416333813">service.item</strong> format and contain 3 to 32 characters. <strong id="ces_03_0033__b1364443315817">service</strong> and <strong id="ces_03_0033__b26453333818">item</strong> each must start with a letter and contain only letters, digits, and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row14620943"><td class="cellrowborder" valign="top" width="18.610000000000003%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0033__p280237695641">metric_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.610000000000001%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0033__p2566588195641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.470000000000002%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0033__p123650473169">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.31%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0033__p35943562">Specifies the metric name. You can obtain the metric names of existing alarm rules by referring to <a href="ces_03_0023.html">Querying Metrics</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row55056607"><td class="cellrowborder" valign="top" width="18.610000000000003%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0033__p2518324095641">from</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.610000000000001%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0033__p2657653695641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.470000000000002%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0033__p12560965163547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.31%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0033__p1629915295010">Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms.</p>
|
|
<p id="ces_03_0033__p3211163415419">Rollup aggregates the raw data generated within a period to the start time of the period. If <strong id="ces_03_0033__b122519565343">from</strong> and <strong id="ces_03_0033__b12252195673414">to</strong> are within a period, the query result will be empty due to the rollup failure. Set <strong id="ces_03_0033__b32530569347">from</strong> to at least one period earlier than the current time.</p>
|
|
<p id="ces_03_0033__p876641194536">Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30. In this example, if <strong id="ces_03_0033__b5797758163410">period</strong> is 5 minutes, <strong id="ces_03_0033__b13798658113415">from</strong> should be 10:30.</p>
|
|
<div class="note" id="ces_03_0033__note9599005105534"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0033__p19282181105534">Cloud Eye rounds up <strong id="ces_03_0033__b842352706171848">from</strong> based on the level of granularity required to perform the rollup.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row6114302"><td class="cellrowborder" valign="top" width="18.610000000000003%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0033__p4423458695641">to</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.610000000000001%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0033__p2623169995641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.470000000000002%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0033__p10805270163547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.31%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0033__p15132095151021">Specifies the end time of the query.</p>
|
|
<p id="ces_03_0033__p14253410151029">The time is a UNIX timestamp and the unit is ms.</p>
|
|
<p id="ces_03_0033__p22491901151010"><strong id="ces_03_0033__b5146242315922">from</strong> must be earlier than <strong id="ces_03_0033__b6050863115922">to</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row18700393"><td class="cellrowborder" valign="top" width="18.610000000000003%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0033__p1593206195641">period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.610000000000001%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0033__p1542856995641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.470000000000002%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0033__p1276519458171">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.31%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0033__p4175457395641">Specifies how often Cloud Eye aggregates data, which can be</p>
|
|
<ul id="ces_03_0033__ul22530818141337"><li id="ces_03_0033__li1450776141337"><strong id="ces_03_0033__b552517490572">1</strong>: Cloud Eye performs no aggregation and displays raw data.</li></ul>
|
|
<ul id="ces_03_0033__ul5025435916374"><li id="ces_03_0033__li1144664916374"><strong id="ces_03_0033__b75335211571">300</strong>: Cloud Eye aggregates data every 5 minutes.</li><li id="ces_03_0033__li2310812316374"><strong id="ces_03_0033__b1354655335718">1200</strong>: Cloud Eye aggregates data every 20 minutes.</li><li id="ces_03_0033__li1347195716374"><strong id="ces_03_0033__b1940211553578">3600</strong>: Cloud Eye aggregates data every hour.</li><li id="ces_03_0033__li713876916374"><strong id="ces_03_0033__b2196957195718">14400</strong>: Cloud Eye aggregates data every 4 hours.</li><li id="ces_03_0033__li6259003216374"><strong id="ces_03_0033__b236905920578">86400</strong>: Cloud Eye aggregates data every 24 hours.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row21724664"><td class="cellrowborder" valign="top" width="18.610000000000003%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0033__p5033039295641">filter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.610000000000001%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0033__p5022994295641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.470000000000002%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0033__p95857523172">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.31%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0033__p4209350595641">Specifies the data rollup method, which can be</p>
|
|
<ul id="ces_03_0033__en-us_topic_0046434864_ul7891893153925"><li id="ces_03_0033__en-us_topic_0046434864_li43492545153925"><strong id="ces_03_0033__b106371482515">average</strong>: Cloud Eye calculates the average value of metric data within a rollup period.</li><li id="ces_03_0033__li16199819381"><strong id="ces_03_0033__b152929534514">max</strong>: Cloud Eye calculates the maximum value of metric data within a rollup period.</li><li id="ces_03_0033__li1664629123819"><strong id="ces_03_0033__b1121562511">min</strong>: Cloud Eye calculates the minimum value of metric data within a rollup period.</li><li id="ces_03_0033__li9248811153817"><strong id="ces_03_0033__b1422410581158">sum</strong>: Cloud Eye calculates the sum of metric data within a rollup period.</li><li id="ces_03_0033__en-us_topic_0046434864_li48786427153939"><strong id="ces_03_0033__b9393101565">variance</strong>: Cloud Eye calculates the variance value of metric data within a rollup period.</li></ul>
|
|
<div class="note" id="ces_03_0033__en-us_topic_0046434864_note4729782611523"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0033__en-us_topic_0046434864_p42043046195213">Rollup uses a rollup method to aggregate raw data generated within a specific period. Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row6189824095632"><td class="cellrowborder" valign="top" width="18.610000000000003%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0033__p6296468095641">dim</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.610000000000001%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0033__p6697434595641">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.470000000000002%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0033__p136772055161716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.31%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0033__p5555162513185">A maximum of three metric dimensions are supported, and the dimensions are numbered from zero in the <strong id="ces_03_0033__b945954991816">dim.{i}=key,value</strong> format. <strong id="ces_03_0033__b7459949111818">key</strong> cannot exceed 32 characters and <strong id="ces_03_0033__b645974951818">value</strong> cannot exceed 256 characters.</p>
|
|
<p id="ces_03_0033__p12330174623112">The following dimensions are only examples. For details about whether multiple dimensions are supported, see the dimension description in the <a href="ces_03_0059.html">monitoring indicator description of each service</a>.</p>
|
|
<p id="ces_03_0033__p5621290395641">Single dimension: <strong id="ces_03_0033__b334134417119">dim.0=instance_id,i-12345</strong></p>
|
|
<p id="ces_03_0033__p20992145915">Multiple dimensions: <strong id="ces_03_0033__b6401112910594">dim.0=instance_id,i-12345&dim.1=instance_name,i-1234</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="ces_03_0033__note1091914802810"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="ces_03_0033__ul8507111462317"><li id="ces_03_0033__li115071814192316"><strong id="ces_03_0033__b12978878333">dimensions</strong> can be obtained from the response body by calling the API for <a href="ces_03_0023.html">Querying Metrics</a>.</li><li id="ces_03_0033__li2170192042315">OBS metric data can be queried only when the related OBS APIs are called.</li></ul>
|
|
</div></div>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="ces_03_0033__ul50416246175516"><li id="ces_03_0033__li11909133112264">Example:<p id="ces_03_0033__p1826193552620"><a name="ces_03_0033__li11909133112264"></a><a name="li11909133112264"></a>Request example 1: View the CPU usage of ECS whose ID is <strong id="ces_03_0033__b14555515550">6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d</strong> from 2019-04-30 20:00:00 to 2019-04-30 22:00:00. The monitoring interval is 20 minutes.</p>
|
|
<pre class="screen" id="ces_03_0033__screen10539181873210">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/metric-data?namespace=SYS.ECS&metric_name=cpu_util&dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d&from=1556625600000&to=1556632800000&period=1200&filter=min</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0033__section24112512"><h4 class="sectiontitle">Request</h4><p id="ces_03_0033__p45638969">None</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0033__section15686020"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0033__ul5769005"><li id="ces_03_0033__li15619415152815">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0033__table6357015152815" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0033__row57952149152815"><th align="left" class="cellrowborder" valign="top" width="21.40785921407859%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="ces_03_0033__p63612496152815"><strong id="ces_03_0033__b842352706181120">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.14848515148485%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="ces_03_0033__p11562283152815"><strong id="ces_03_0033__b842352706181128">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.44365563443656%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="ces_03_0033__p64129691152815"><strong id="ces_03_0033__b842352706181132">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0033__row27122455152815"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0033__p49435272152815">datapoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0033__p18618155512194">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0033__p226620208334">Specifies the metric data list. For details, see <a href="#ces_03_0033__table1017018361914">Table 4</a>.</p>
|
|
<p id="ces_03_0033__p40931000151127"></p>
|
|
<p id="ces_03_0033__p12932214151010">Since Cloud Eye rounds up <strong id="ces_03_0033__b1473920010172743">from</strong> based on the level of granularity for data query, <strong id="ces_03_0033__b842352706173039">datapoints</strong> may contain more data points than expected.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row13930709152815"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0033__p54645615152815">metric_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0033__p34330385152815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0033__p1351411315505">Specifies the metric ID. For example, if the monitoring metric of an ECS is CPU usage, <strong id="ces_03_0033__b59631516131">metric_name</strong> is <strong id="ces_03_0033__b49647591314">cpu_util</strong>. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0033__table1017018361914"></a><a name="table1017018361914"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0033__table1017018361914" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0033__b658512201325">datapoints</strong> data structure description</caption><thead align="left"><tr id="ces_03_0033__row191717367119"><th align="left" class="cellrowborder" valign="top" width="21.40785921407859%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="ces_03_0033__p121712368117"><strong id="ces_03_0033__b1898916192">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.14848515148485%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="ces_03_0033__p817112361619"><strong id="ces_03_0033__b334184707">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.44365563443656%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="ces_03_0033__p1117115361718"><strong id="ces_03_0033__b1889727827">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0033__row11989102513422"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0033__p11985202594212">average</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0033__p1598532564212">Double</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0033__p12175748155513">Specifies the average value of metric data within a rollup period.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row5989182515423"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0033__p1663910598479">max</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0033__p6639175918474">Double</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0033__p127226285616">Specifies the maximum value of metric data within a rollup period.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row498912513424"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0033__p7848101011485">min</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0033__p8848101013487">Double</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0033__p1889141435616">Specifies the minimum value of metric data within a rollup period.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row14989192516426"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0033__p2142714104819">sum</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0033__p14142314154811">Double</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0033__p6683172714564">Specifies the sum of metric data within a rollup period.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row398912255429"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0033__p8162141615480">variance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0033__p17162191664816">Double</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0033__p891995065612">Specifies the variance of metric data within a rollup period.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row189889254425"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0033__p40923954191739">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0033__p9182852143611">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0033__p26617833191739">Specifies when the metric is collected. It is a UNIX timestamp in milliseconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row5263834174218"><td class="cellrowborder" valign="top" width="21.40785921407859%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0033__p717211364117">unit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.14848515148485%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0033__p317219361713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.44365563443656%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0033__p617218361216">Specifies the metric unit.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="ces_03_0033__li51921052">Example response<div class="p" id="ces_03_0033__p2054134916277"><a name="ces_03_0033__li51921052"></a><a name="li51921052"></a>Example response 1: The dimension is SYS.ECS, and the average CPU usage of ECSs is displayed.<pre class="screen" id="ces_03_0033__screen1565134314276">{
|
|
"datapoints": [
|
|
{
|
|
"average": 0.23,
|
|
"timestamp": 1442341200000,
|
|
"unit": "%"
|
|
}
|
|
],
|
|
"metric_name": "cpu_util"
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="ces_03_0033__p18194113573111">Example response 2: The dimension is SYS.ECS, and the sum CPU usage of ECSs is displayed.<pre class="screen" id="ces_03_0033__screen171942357314">{
|
|
"datapoints": [
|
|
{
|
|
"sum": 0.53,
|
|
"timestamp": 1442341200000,
|
|
"unit": "%"
|
|
}
|
|
],
|
|
"metric_name": "cpu_util"
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="ces_03_0033__p181031200343">Example response 3: The dimension is SYS.ECS, and the maximum CPU usage of ECSs is displayed.<pre class="screen" id="ces_03_0033__screen1103112012347">{
|
|
"datapoints": [
|
|
{
|
|
"max": 0.13,
|
|
"timestamp": 1442341200000,
|
|
"unit": "%"
|
|
}
|
|
],
|
|
"metric_name": "cpu_util"
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0033__section6956456"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0033__ul20226985"><li id="ces_03_0033__li47825138">Normal<p id="ces_03_0033__p27773061"><a name="ces_03_0033__li47825138"></a><a name="li47825138"></a>200</p>
|
|
</li><li id="ces_03_0033__li48630964">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0033__table46793998" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0033__row65573909"><th align="left" class="cellrowborder" valign="top" width="33.08%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="ces_03_0033__p1849030182924">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="66.92%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="ces_03_0033__p15553712182924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0033__row37564172"><td class="cellrowborder" valign="top" width="33.08%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0033__p581987519168">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.92%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0033__p164784039168">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row66248115"><td class="cellrowborder" valign="top" width="33.08%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0033__p2691669168">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.92%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0033__p218024949168">The authentication information is not provided or is incorrect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row44282627"><td class="cellrowborder" valign="top" width="33.08%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0033__p563264059168">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.92%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0033__p661449719168">Access to the requested page is forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row1815156"><td class="cellrowborder" valign="top" width="33.08%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0033__p355199299168">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.92%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0033__p585420329168">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row25675773"><td class="cellrowborder" valign="top" width="33.08%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0033__p630127129168">429 Too Many Requests</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.92%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0033__p37560249168">Concurrent requests are excessive.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row47530006"><td class="cellrowborder" valign="top" width="33.08%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0033__p537873819168">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.92%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0033__p618106189168">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0033__row20561848"><td class="cellrowborder" valign="top" width="33.08%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0033__p298930079168">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.92%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0033__p54144829168">The service is currently unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0033__section18702135964612"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0033__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_0032.html">Monitoring Data</a></div>
|
|
</div>
|
|
</div>
|
|
|