doc-exports/docs/ces/api-ref/ces_03_0034.html
Yang, Tong d75e275491 CES API 20241015 version
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>
2024-10-22 11:17:42 +00:00

705 lines
56 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="ces_03_0034"></a><a name="ces_03_0034"></a>
<h1 class="topictitle1">Querying Monitoring Data of Multiple Metrics</h1>
<div id="body1490095051386"><div class="section" id="ces_03_0034__section28757494191739"><h4 class="sectiontitle">Function</h4><p id="ces_03_0034__p26108320142218">You can query the monitoring data of specified metrics within a specified time range and at a specified granularity. You can query the monitoring data of up to 10 metrics in one batch.</p>
</div>
<div class="section" id="ces_03_0034__section26247582191739"><h4 class="sectiontitle">URI</h4><p id="ces_03_0034__p9041823191739">POST /V1.0/{project_id}/batch-query-metric-data</p>
<ul id="ces_03_0034__ul45679374191739"><li id="ces_03_0034__li14267547191739">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table61299064191739" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0034__row46292936191739"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="ces_03_0034__p58740307191739"><strong id="ces_03_0034__b842352706201552">Parameter</strong></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="ces_03_0034__p60344431191739"><strong id="ces_03_0034__b842352706201556">Mandatory</strong></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="ces_03_0034__p56060739191739"><strong id="ces_03_0034__b842352706201559">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row44626040191739"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0034__p57939510191739">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="ces_03_0034__p62588708191739">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60.199999999999996%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0034__p36520554191739">Specifies the project ID.</p>
<p id="ces_03_0034__p55701252564">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></ul>
</div>
<div class="section" id="ces_03_0034__section60249534191739"><h4 class="sectiontitle">Request</h4><div class="notice" id="ces_03_0034__note32713504191739"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><ol id="ces_03_0034__ol19471824142259"><li class="cautiontext" id="ces_03_0034__li23087290142259">The size of a POST request cannot exceed 512 KB. Otherwise, the request will be denied.</li><li id="ces_03_0034__li6544389714235">The default maximum query intervals of different periods are different.<p id="ces_03_0034__p14910396142238"><a name="ces_03_0034__li6544389714235"></a><a name="li6544389714235"></a>If <strong id="ces_03_0034__b842352706203315">period</strong> is <strong id="ces_03_0034__b8423527061594">1</strong>, the maximum interval between <strong id="ces_03_0034__b842352706203434">from</strong> and <strong id="ces_03_0034__b842352706203437">to</strong> is 4 hours. If the interval between <strong id="ces_03_0034__b906303934203520">from</strong> and <strong id="ces_03_0034__b1256668538203520">to</strong> is longer than 4 hours, adjust the value of <strong id="ces_03_0034__b842352706203621">from</strong> to <strong id="ces_03_0034__b8423527069522">to</strong> - <strong id="ces_03_0034__b84235270615935">4*3600*1000</strong>.</p>
<p id="ces_03_0034__p67084704142238">If <strong id="ces_03_0034__b431043346">period</strong> is <strong id="ces_03_0034__b84235270615910">300</strong>, the maximum interval between <strong id="ces_03_0034__b1902082751">from</strong> and <strong id="ces_03_0034__b764938100">to</strong> is one day. If the interval between <strong id="ces_03_0034__b1971334678">from</strong> and <strong id="ces_03_0034__b799759686">to</strong> is longer than one day, adjust the value of <strong id="ces_03_0034__b2014706796">from</strong> to <strong id="ces_03_0034__b113876025695230">to</strong> - <strong id="ces_03_0034__b84235270615942">24*3600*1000</strong>.</p>
<p id="ces_03_0034__p66891431142238">If <strong id="ces_03_0034__b2000159809">period</strong> is <strong id="ces_03_0034__b84235270615948">1200</strong>, the maximum interval between <strong id="ces_03_0034__b1802399346">from</strong> and <strong id="ces_03_0034__b1899176682">to</strong> is three days. If the interval between <strong id="ces_03_0034__b1357595599">from</strong> and <strong id="ces_03_0034__b407569195">to</strong> is longer than three days, adjust the value of <strong id="ces_03_0034__b1371551130">from</strong> to <strong id="ces_03_0034__b207915521595239">to</strong> - <strong id="ces_03_0034__b84235270615954">3*24*3600*1000</strong>.</p>
<p id="ces_03_0034__p65151968142238">If <strong id="ces_03_0034__b1915917956">period</strong> is <strong id="ces_03_0034__b84235270615100">3600</strong>, the maximum interval between <strong id="ces_03_0034__b1003065043">from</strong> and <strong id="ces_03_0034__b104234547">to</strong> is 10 days. If the interval between <strong id="ces_03_0034__b1712415966">from</strong> and <strong id="ces_03_0034__b288727314">to</strong> is longer than 10 days, adjust the value of <strong id="ces_03_0034__b2079869707">from</strong> to <strong id="ces_03_0034__b29566411095244">to</strong> - <strong id="ces_03_0034__b84235270615105">10*24*3600*1000</strong>.</p>
<p id="ces_03_0034__p49496806142238">If <strong id="ces_03_0034__b1103348150">period</strong> is <strong id="ces_03_0034__b842352706151012">14400</strong>, the maximum interval between <strong id="ces_03_0034__b1198931917">from</strong> and <strong id="ces_03_0034__b1913362515">to</strong> is 30 days. If the interval between <strong id="ces_03_0034__b1377459376">from</strong> and <strong id="ces_03_0034__b713496183">to</strong> is longer than 30 days, adjust the value of <strong id="ces_03_0034__b956568088">from</strong> to <strong id="ces_03_0034__b169539223295253">to</strong> - <strong id="ces_03_0034__b842352706151015">30*24*3600*1000</strong>.</p>
<p id="ces_03_0034__p42818073142238">If <strong id="ces_03_0034__b365488457">period</strong> is <strong id="ces_03_0034__b842352706151022">86400,</strong> the maximum interval between <strong id="ces_03_0034__b1458164809">from</strong> and <strong id="ces_03_0034__b613433593">to</strong> is 180 days. If the interval between <strong id="ces_03_0034__b669973101">from</strong> and <strong id="ces_03_0034__b2053000151">to</strong> is longer than 180 days, adjust the value of <strong id="ces_03_0034__b2079553629">from</strong> to <strong id="ces_03_0034__b558057969533">to</strong> - <strong id="ces_03_0034__b842352706151025">180*24*3600*1000</strong>.</p>
</li></ol>
</div></div>
<ul id="ces_03_0034__ul1490862191739"><li id="ces_03_0034__li13417765191739">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table126111056191313" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="ces_03_0034__row9612145681314"><th align="left" class="cellrowborder" valign="top" width="19.84%" id="mcps1.3.3.3.1.1.2.5.1.1"><p id="ces_03_0034__p11612105614136"><strong id="ces_03_0034__b842352706201721">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.840000000000002%" id="mcps1.3.3.3.1.1.2.5.1.2"><p id="ces_03_0034__p26121256161314"><strong id="ces_03_0034__b842352706201727">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.94%" id="mcps1.3.3.3.1.1.2.5.1.3"><p id="ces_03_0034__p15612956111314"><strong id="ces_03_0034__b842352706201732">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.379999999999995%" id="mcps1.3.3.3.1.1.2.5.1.4"><p id="ces_03_0034__p20612205681313"><strong id="ces_03_0034__b842352706201738">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row661213566135"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="ces_03_0034__p2061214566138">metrics</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="ces_03_0034__p126121656191320">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.94%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="ces_03_0034__p1612356131312">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="45.379999999999995%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="ces_03_0034__p3612135691311">Specifies the metric data. The maximum length of the array is 10.</p>
<p id="ces_03_0034__p9586154053018">For details, see <a href="#ces_03_0034__table53651023191739">Table 3</a>.</p>
</td>
</tr>
<tr id="ces_03_0034__row14613165620136"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="ces_03_0034__p19613145621317">from</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="ces_03_0034__p1061395631319">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.94%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="ces_03_0034__p1276519458171">Long</p>
</td>
<td class="cellrowborder" valign="top" width="45.379999999999995%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="ces_03_0034__p156131056141313">Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms. Set <strong id="ces_03_0034__b84235270617327">from</strong> to at least one period earlier than the current time. Rollup aggregates the raw data generated within a period to the start time of the period. If <strong id="ces_03_0034__b84235270617852">from</strong> and <strong id="ces_03_0034__b84235270617856">to</strong> are within a period, the query result will be empty due to the rollup failure. Set <strong id="ces_03_0034__b59113991318926">from</strong> to at least one period earlier than the current time. 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_0034__b842352706171230">period</strong> is 5 minutes, <strong id="ces_03_0034__b842352706171445">from</strong> should be 10:30.</p>
<div class="note" id="ces_03_0034__note261365613131"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ces_03_0034__p3614125613130">Cloud Eye rounds up <strong id="ces_03_0034__b842352706171848">from</strong> based on the level of granularity required to perform the rollup.</p>
</div></div>
</td>
</tr>
<tr id="ces_03_0034__row261415569133"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="ces_03_0034__p5614115615138">to</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="ces_03_0034__p26141356131313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.94%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="ces_03_0034__p1895091934710">Long</p>
</td>
<td class="cellrowborder" valign="top" width="45.379999999999995%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="ces_03_0034__p56149563137">Specifies the end time of the query. The time is a UNIX timestamp and the unit is ms. <strong id="ces_03_0034__b14360145152210">from</strong> must be earlier than <strong id="ces_03_0034__b636120450222">to</strong>.</p>
</td>
</tr>
<tr id="ces_03_0034__row186144562138"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="ces_03_0034__p9614185613136">period</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="ces_03_0034__p861417562138">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.94%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="ces_03_0034__p4226363272">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.379999999999995%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="ces_03_0034__p761415611136">Specifies how often Cloud Eye aggregates data, which can be</p>
<ul id="ces_03_0034__ul15614205613137"><li id="ces_03_0034__li166149563138"><strong id="ces_03_0034__b842352706202151">1</strong>: Cloud Eye performs no aggregation and displays raw data.</li><li id="ces_03_0034__li2614205610131"><strong id="ces_03_0034__b1894518714564">300</strong>: Cloud Eye aggregates data every 5 minutes.</li><li id="ces_03_0034__li176144566136"><strong id="ces_03_0034__b579814318567">1200</strong>: Cloud Eye aggregates data every 20 minutes.</li><li id="ces_03_0034__li761435601317"><strong id="ces_03_0034__b1142910597558">3600</strong>: Cloud Eye aggregates data every hour.</li><li id="ces_03_0034__li15614456131318"><strong id="ces_03_0034__b192071250115512">14400</strong>: Cloud Eye aggregates data every 4 hours.</li><li id="ces_03_0034__li16614175612134"><strong id="ces_03_0034__b158591354195519">86400</strong>: Cloud Eye aggregates data every 24 hours.</li></ul>
</td>
</tr>
<tr id="ces_03_0034__row4614956161314"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="ces_03_0034__p361445615133">filter</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="ces_03_0034__p1261485611131">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.94%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="ces_03_0034__p56146564139">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.379999999999995%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="ces_03_0034__p166141756101314">Specifies the data rollup method, which can be</p>
<ul id="ces_03_0034__en-us_topic_0046434864_ul7891893153925"><li id="ces_03_0034__en-us_topic_0046434864_li43492545153925"><strong id="ces_03_0034__b1791999952">average</strong>: Cloud Eye calculates the average value of metric data within a rollup period.</li><li id="ces_03_0034__li16199819381"><strong id="ces_03_0034__b525318153513">max</strong>: Cloud Eye calculates the maximum value of metric data within a rollup period.</li><li id="ces_03_0034__li1664629123819"><strong id="ces_03_0034__b9581131719512">min</strong>: Cloud Eye calculates the minimum value of metric data within a rollup period.</li><li id="ces_03_0034__li9248811153817"><strong id="ces_03_0034__b163601219456">sum</strong>: Cloud Eye calculates the sum of metric data within a rollup period.</li><li id="ces_03_0034__en-us_topic_0046434864_li48786427153939"><strong id="ces_03_0034__b12232132318510">variance</strong>: Cloud Eye calculates the variance value of metric data within a rollup period.</li></ul>
<p id="ces_03_0034__p361495615137"><strong id="ces_03_0034__b842352706202454">filter</strong> does not affect the query result of raw data. (The period is <strong id="ces_03_0034__b3821784215552">1</strong>.)</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0034__table53651023191739"></a><a name="table53651023191739"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table53651023191739" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0034__b94557497225">metrics</strong> data structure description</caption><thead align="left"><tr id="ces_03_0034__row41871473191739"><th align="left" class="cellrowborder" valign="top" width="18.9%" id="mcps1.3.3.3.1.2.2.5.1.1"><p id="ces_03_0034__p36146190191739"><strong id="ces_03_0034__b284120746">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.840000000000002%" id="mcps1.3.3.3.1.2.2.5.1.2"><p id="ces_03_0034__p42160267191739"><strong id="ces_03_0034__b993120847">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.55%" id="mcps1.3.3.3.1.2.2.5.1.3"><p id="ces_03_0034__p59538448191739"><strong id="ces_03_0034__b721144350">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.71%" id="mcps1.3.3.3.1.2.2.5.1.4"><p id="ces_03_0034__p57884998191739"><strong id="ces_03_0034__b657893702">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row37226944191739"><td class="cellrowborder" valign="top" width="18.9%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="ces_03_0034__p62592488191739">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="ces_03_0034__p36826781191739">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="ces_03_0034__p30179270191739">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="ces_03_0034__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_0034__p1529914911223">The namespace must be in the <strong id="ces_03_0034__b1772319555102011">service.item</strong> format and contain 3 to 32 characters. <strong id="ces_03_0034__b966993296102011">service</strong> and <strong id="ces_03_0034__b9201158102011">item</strong> each must start with a letter and contain only letters, digits, and underscores (_).</p>
</td>
</tr>
<tr id="ces_03_0034__row12862050101510"><td class="cellrowborder" valign="top" width="18.9%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="ces_03_0034__p92442516150">metric_name</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="ces_03_0034__p14244151201510">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="ces_03_0034__p14573015279">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="ces_03_0034__p1351411315505">Specifies the metric ID. For example, if the monitoring metric of an ECS is CPU usage, <strong id="ces_03_0034__b2997301102011">metric_name</strong> is <strong id="ces_03_0034__b1999330845102011">cpu_util</strong>. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
<p id="ces_03_0034__p325025814342">The value must start with a letter. Enter 1 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
<tr id="ces_03_0034__row34331234133010"><td class="cellrowborder" valign="top" width="18.9%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="ces_03_0034__p32753092191739">dimensions</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="ces_03_0034__p35754801191739">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="ces_03_0034__p10457787191739">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="ces_03_0034__p41774409191739">Specifies metric dimensions. <strong id="ces_03_0034__b113893313259">dimensions</strong> is an array consisting of a maximum of four JSON objects.</p>
<p id="ces_03_0034__p40425365191739">One dimension is a JSON object, and its structure is as follows:</p>
<p id="ces_03_0034__p485214919175">{</p>
<p id="ces_03_0034__p685215495171">"name": "instance_id",</p>
<p id="ces_03_0034__p2654105914173">"value": "33328f02-3814-422e-b688-bfdba93d4050"</p>
<p id="ces_03_0034__p1785218497174">}</p>
<p id="ces_03_0034__p1374219413211">For details, see <a href="#ces_03_0034__table346618584132">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0034__table346618584132"></a><a name="table346618584132"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table346618584132" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0034__b888321172311">dimensions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0034__row0468185851318"><th align="left" class="cellrowborder" valign="top" width="19.84%" id="mcps1.3.3.3.1.3.2.5.1.1"><p id="ces_03_0034__p16468105821312"><strong id="ces_03_0034__b477438199">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.840000000000002%" id="mcps1.3.3.3.1.3.2.5.1.2"><p id="ces_03_0034__p046812587133"><strong id="ces_03_0034__b268396986">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.94%" id="mcps1.3.3.3.1.3.2.5.1.3"><p id="ces_03_0034__p18468185813136"><strong id="ces_03_0034__b1896031954">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.379999999999995%" id="mcps1.3.3.3.1.3.2.5.1.4"><p id="ces_03_0034__p16468158101318"><strong id="ces_03_0034__b837312968">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row1047175861314"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.3.2.5.1.1 "><p id="ces_03_0034__p9588164019308">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.3.2.5.1.2 "><p id="ces_03_0034__p6471105841315">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.94%" headers="mcps1.3.3.3.1.3.2.5.1.3 "><p id="ces_03_0034__p3662932162713">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.379999999999995%" headers="mcps1.3.3.3.1.3.2.5.1.4 "><p id="ces_03_0034__p7551220145010">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0034__b7962131715816">instance_id</strong>. For details about the dimension of each service, see the <strong id="ces_03_0034__b114451220175819">key</strong> column in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
<p id="ces_03_0034__p3963077184830">Start with a letter. Enter 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
<tr id="ces_03_0034__row10471155851315"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.3.2.5.1.1 "><p id="ces_03_0034__p19588184023011">value</p>
</td>
<td class="cellrowborder" valign="top" width="15.840000000000002%" headers="mcps1.3.3.3.1.3.2.5.1.2 "><p id="ces_03_0034__p1047245861319">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.94%" headers="mcps1.3.3.3.1.3.2.5.1.3 "><p id="ces_03_0034__p1588154012306">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.379999999999995%" headers="mcps1.3.3.3.1.3.2.5.1.4 "><p id="ces_03_0034__p11371113251615">Specifies the dimension value, for example, an ECS ID. <strong id="ces_03_0034__b1115157100102011">dimensions</strong> can be obtained from the response body by calling the API for <a href="ces_03_0023.html">querying metrics</a>.</p>
<p id="ces_03_0034__p91691546145115">Start with a letter or a digit. Enter 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="ces_03_0034__note1091914802810"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="ces_03_0034__ul14928134133219"><li id="ces_03_0034__li119281541153219"><strong id="ces_03_0034__b174491514347">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_0034__li228974953212">OBS metric data can be queried only when the related OBS APIs are called.</li></ul>
</div></div>
</li></ul>
<ul id="ces_03_0034__ul58490076191739"><li id="ces_03_0034__li56648642191739">Example request<p id="ces_03_0034__en-us_topic_0000001604750246_p946795232412"><a name="ces_03_0034__li56648642191739"></a><a name="li56648642191739"></a>Request example 1: Query the average disk usage of the OS on the ECS whose <strong id="ces_03_0034__en-us_topic_0000001604750246_b19776192911499">instance_id</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b3807113324919">07d878a9-2243-4e84-aeef-c47747d18024</strong> and <strong id="ces_03_0034__en-us_topic_0000001604750246_b16258193814492">mount_point</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b1878194320494">012bec14bc176310c19f40e384fd629b</strong> from 20:00:00 to 22:00:00 on April 30, 2019.</p>
<pre class="screen" id="ces_03_0034__en-us_topic_0000001604750246_screen466116712616">{
"from": 1556625600000,
"to": 1556632800000,
"period": "1",
"filter": "average",
"metrics": [{
"dimensions": [{
"name": "instance_id",
"value": "07d878a9-2243-4e84-aeef-c47747d18024"
}, {
"name": "mount_point",
"value": "012bec14bc176310c19f40e384fd629b"
}],
"metric_name": "disk_usedPercent",
"namespace": "AGT.ECS"
}]
}</pre>
<p id="ces_03_0034__en-us_topic_0000001604750246_p10944181632613">Request example 2: Query the average memory usage of the OS of the ECS whose <strong id="ces_03_0034__en-us_topic_0000001604750246_b39544498716">instance_id</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b010519551476">238764d4-c4e1-4274-88a1-5956b057766b</strong> from 20:00:00 to 22:00:00 on April 30, 2019.</p>
<pre class="screen" id="ces_03_0034__en-us_topic_0000001604750246_screen1867182282712">{
"from": 1556625600000,
"to": 1556632800000,
"period": "1",
"filter": "average",
"metrics": [{
"dimensions": [{
"name": "instance_id",
"value": "238764d4-c4e1-4274-88a1-5956b057766b"
}],
"metric_name": "mem_usedPercent",
"namespace": "AGT.ECS"
}]
}</pre>
<p id="ces_03_0034__en-us_topic_0000001604750246_p3160154920261">Request example 3: Query the average <strong id="ces_03_0034__en-us_topic_0000001604750246_b102218123920">cpu_util</strong> of the five ECSs whose <strong id="ces_03_0034__en-us_topic_0000001604750246_b938219442919">instance_id</strong> are <strong id="ces_03_0034__en-us_topic_0000001604750246_b3441251192">faea5b75-e390-4e2b-8733-9226a9026070</strong>, <strong id="ces_03_0034__en-us_topic_0000001604750246_b1495112277104">faea5b75-e390-4e2b-8733-9226a9026071</strong>, <strong id="ces_03_0034__en-us_topic_0000001604750246_b7517534131018">faea5b75-e390-4e2b-8733-9226a9026072</strong>, <strong id="ces_03_0034__en-us_topic_0000001604750246_b51349405104">faea5b75-e390-4e2b-8733-9226a9026073</strong>, and <strong id="ces_03_0034__en-us_topic_0000001604750246_b18696174771018">faea5b75-e390-4e2b-8733-9226a9026074</strong> from 00:00:00 to 23:59:59 on August 21, 2024. Query five metrics. The monitoring period is 60,000 ms. The maximum value of (<strong id="ces_03_0034__en-us_topic_0000001604750246_b1668641184212">to</strong>-<strong id="ces_03_0034__en-us_topic_0000001604750246_b125134154423">from</strong>) is 36,000,000. The value of the request parameter (<strong id="ces_03_0034__en-us_topic_0000001604750246_b244612911425">to</strong>-<strong id="ces_03_0034__en-us_topic_0000001604750246_b144461329174213">from</strong>) is 86,399,000, which exceeds the maximum value 36,000,000. The formula is as follows: The number of metrics × (<strong id="ces_03_0034__en-us_topic_0000001604750246_b1677113518423">to</strong>-<strong id="ces_03_0034__en-us_topic_0000001604750246_b1977135174211">from</strong>)/Monitoring period ≤ 3000. The value of <strong id="ces_03_0034__en-us_topic_0000001604750246_b108078193818">from</strong> in the request parameter is automatically changed to <strong id="ces_03_0034__en-us_topic_0000001604750246_b10971747164219">to</strong>-36,000,000, that is, 1,724,219,999,000.</p>
<pre class="screen" id="ces_03_0034__en-us_topic_0000001604750246_screen111256542510">{
"metrics": [
{
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "faea5b75-e390-4e2b-8733-9226a9026070"
}
],
"metric_name": "cpu_util"
},
{
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "faea5b75-e390-4e2b-8733-9226a9026071"
}
],
"metric_name": "cpu_util"
},
{
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "faea5b75-e390-4e2b-8733-9226a9026072"
}
],
"metric_name": "cpu_util"
},
{
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "faea5b75-e390-4e2b-8733-9226a9026073"
}
],
"metric_name": "cpu_util"
},
{
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "faea5b75-e390-4e2b-8733-9226a9026074"
}
],
"metric_name": "cpu_util"
},
],
"from": 1724169600000,
"to": 1724255999000,
"period": "1",
"filter": "average"
}
</pre>
<div class="p" id="ces_03_0034__en-us_topic_0000001604750246_p6935162418597">Request example 4: View the average <strong id="ces_03_0034__en-us_topic_0000001604750246_b1762301410">cpu_util</strong> of the ECS whose <strong id="ces_03_0034__en-us_topic_0000001604750246_b53081117419">instance_id</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b095417151444">faea5b75-e390-4e2b-8733-9226a9026070</strong> and the average <strong id="ces_03_0034__en-us_topic_0000001604750246_b201934571750">network_vm_connections</strong> of the ECS whose <strong id="ces_03_0034__en-us_topic_0000001604750246_b104331968617">instance_id</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b106501712868">06b4020f-461a-4a52-84da-53fa71c2f42b</strong>. The monitoring data was collected from 20:00:00 to 22:00:00 on April 30, 2019.<pre class="screen" id="ces_03_0034__en-us_topic_0000001604750246_screen6139114455820">{
"metrics": [
{
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "faea5b75-e390-4e2b-8733-9226a9026070"
}
],
"metric_name": "cpu_util"
},
{
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "06b4020f-461a-4a52-84da-53fa71c2f42b"
}
],
"metric_name": "network_vm_connections"
}
],
"from": 1556625600000,
"to": 1556632800000,
"period": "1",
"filter": "average"
}
</pre>
</div>
<div class="p" id="ces_03_0034__en-us_topic_0000001604750246_p1857151619716">Request example 5: View the sums of <strong id="ces_03_0034__en-us_topic_0000001604750246_b87591647122910">rds021_myisam_buf_usage</strong> of the RDS instance whose <strong id="ces_03_0034__en-us_topic_0000001604750246_b576074713295">rds_cluster_id</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b07617474295">3c8cc15614ab46f5b8743317555e0de2in01</strong> and the RDS instance whose <strong id="ces_03_0034__en-us_topic_0000001604750246_b1976144792912">rds_cluster_id</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b37621947142914">3b2fa8b55a9b4adca3713962a9d31884in01</strong>. The monitoring data was collected from 20:00:00 to 22:00:00 on April 30, 2019.<pre class="screen" id="ces_03_0034__en-us_topic_0000001604750246_screen131629449214">{
"metrics": [
{
"namespace": "SYS.RDS",
"dimensions": [
{
"name": "rds_cluster_id",
"value": "3c8cc15614ab46f5b8743317555e0de2in01"
}
],
"metric_name": "rds021_myisam_buf_usage"
},
{
"namespace": "SYS.RDS",
"dimensions": [
{
"name": "rds_cluster_id",
"value": "3b2fa8b55a9b4adca3713962a9d31884in01"
}
],
"metric_name": "rds021_myisam_buf_usage"
}
],
"from": 1556625600000,
"to": 1556632800000,
"period": "1",
"filter": "sum"
}</pre>
</div>
<div class="p" id="ces_03_0034__en-us_topic_0000001604750246_p9776143277">Example request 6: View the minimum <strong id="ces_03_0034__en-us_topic_0000001604750246_b8781164914439">proc_specified_count</strong> of the server whose <strong id="ces_03_0034__en-us_topic_0000001604750246_b1281475544315">instance_id</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b1559151184411">cd841102-f6b1-407d-a31f-235db796dcbb</strong> and <strong id="ces_03_0034__en-us_topic_0000001604750246_b34571179457">proc</strong> is <strong id="ces_03_0034__en-us_topic_0000001604750246_b1911356453">b28354b543375bfa94dabaeda722927f</strong>. The monitoring data is collected from 20:00:00 to 22:00:00 on April 30, 2019 and the rollup period is 20 minutes.<pre class="screen" id="ces_03_0034__en-us_topic_0000001604750246_screen1077654312715">{
"metrics": [
{
"namespace": "AGT.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "cd841102-f6b1-407d-a31f-235db796dcbb"
},
{
"name": "proc",
"value": "b28354b543375bfa94dabaeda722927"
}
],
"metric_name": "proc_specified_count"
}
],
"from": 1556625600000,
"to": 1556632800000,
"period": "1200",
"filter": "min"
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="ces_03_0034__section25137312191739"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0034__ul22856366191739"><li id="ces_03_0034__li4380702191739">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table39426324191739" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0034__row53703872191739"><th align="left" class="cellrowborder" valign="top" width="18.24182418241824%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="ces_03_0034__p55046364191739"><strong id="ces_03_0034__b842352706203043">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.631463146314633%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="ces_03_0034__p46397032191739"><strong id="ces_03_0034__b224240388">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.12671267126713%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="ces_03_0034__p63273191739"><strong id="ces_03_0034__b842352706203052">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row5125191191739"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0034__p12487337191739">metrics</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0034__p56609115191739">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0034__p21935611191739">Specifies the metric data.</p>
<p id="ces_03_0034__p172665194275">For details, see <a href="#ces_03_0034__table8753531192320">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0034__table8753531192320"></a><a name="table8753531192320"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table8753531192320" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="ces_03_0034__b176894920259">metrics</strong> data structure description</caption><thead align="left"><tr id="ces_03_0034__row17752173192319"><th align="left" class="cellrowborder" valign="top" width="18.24182418241824%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="ces_03_0034__p1575173132314"><strong id="ces_03_0034__b389494964">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.631463146314633%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="ces_03_0034__p127511931102317"><strong id="ces_03_0034__b833123149">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.12671267126713%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="ces_03_0034__p275113132313"><strong id="ces_03_0034__b2145092673">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row3668159122515"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0034__p8678510152516">unit</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0034__p667891072518">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0034__p86781310162514">Specifies the metric unit.</p>
</td>
</tr>
<tr id="ces_03_0034__row1728144112517"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0034__p2678191012252">datapoints</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0034__p467819100259">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0034__p86781010162510">Specifies the metric data list. Cloud Eye rounds up the value of <strong id="ces_03_0034__b1473920010172743">from</strong> based on the selected granularity for data query, so <strong id="ces_03_0034__b842352706173039">datapoints</strong> may contain more data points than expected. Up to 3,000 data points can be returned.</p>
<p id="ces_03_0034__p12628543182913">For details, see <a href="#ces_03_0034__table776113112239">Table 8</a>.</p>
</td>
</tr>
<tr id="ces_03_0034__row956045965010"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0034__p123045818513">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0034__p5304188105112">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0034__p230478155114">Specifies the metric namespace, which must be in the <strong id="ces_03_0034__b189629281058">service.item</strong> format and contain 3 to 32 characters. <strong id="ces_03_0034__b20962028956">service</strong> and <strong id="ces_03_0034__b89630287510">item</strong> each must start with a letter and contain only letters, digits, and underscores (_).</p>
</td>
</tr>
<tr id="ces_03_0034__row12582417515"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0034__p9304178165114">dimensions</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0034__p1321914122293">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0034__p13304288519">Specifies the list of metric dimensions.</p>
<p id="ces_03_0034__p103046865111">Each dimension is a JSON object, and its structure is as follows:</p>
<p id="ces_03_0034__p1130419855113">{</p>
<p id="ces_03_0034__p1930415895112">"name": "instance_id",</p>
<p id="ces_03_0034__p1430412865119">"value": "33328f02-3814-422e-b688-bfdba93d4050"</p>
<p id="ces_03_0034__p11304108165115">}</p>
<p id="ces_03_0034__p3304128175119">For details, see <a href="#ces_03_0034__table14755123118236">Table 7</a>.</p>
</td>
</tr>
<tr id="ces_03_0034__row1889026105113"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0034__p1030514814513">metric_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0034__p7305158125114">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0034__p113054810512">Specifies the metric name. Start with a letter. Enter 1 to 64 characters. Only letters, digits, and underscores (_) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0034__table14755123118236"></a><a name="table14755123118236"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table14755123118236" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="ces_03_0034__b8904152632519">dimensions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0034__row14754143118239"><th align="left" class="cellrowborder" valign="top" width="18.24182418241824%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="ces_03_0034__p1975415316232"><strong id="ces_03_0034__b890209368">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.631463146314633%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="ces_03_0034__p67542031102320"><strong id="ces_03_0034__b2025997914">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.12671267126713%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="ces_03_0034__p17543319231"><strong id="ces_03_0034__b1125208738">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row16755143114233"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0034__p2618131922615">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0034__p32021649142716">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0034__p1168451854813">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0034__b32115226575">instance_id</strong>. For details about the dimension of each service, see the <strong id="ces_03_0034__b79160242573">key</strong> column in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
<p id="ces_03_0034__p1661871910269">Start with a letter. Enter 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
<tr id="ces_03_0034__row1375516313231"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0034__p66191819102618">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0034__p176192019102610">String</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0034__p1684517374483">Specifies the dimension value, for example, an ECS ID.</p>
<p id="ces_03_0034__p1961910191267">Start with a letter or a digit. Enter 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0034__table776113112239"></a><a name="table776113112239"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table776113112239" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="ces_03_0034__b1489804172611">datapoints</strong> data structure description</caption><thead align="left"><tr id="ces_03_0034__row97565318232"><th align="left" class="cellrowborder" valign="top" width="18.24182418241824%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="ces_03_0034__p167551431202315"><strong id="ces_03_0034__b588732994">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.631463146314633%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="ces_03_0034__p20756123152313"><strong id="ces_03_0034__b2007189310">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.12671267126713%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="ces_03_0034__p10756123132310"><strong id="ces_03_0034__b1100474168">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row1175615318237"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0034__p1417110364118">average</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0034__p8319164091818">Double</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0034__p12175748155513">Specifies the average value of metric data within a rollup period.</p>
</td>
</tr>
<tr id="ces_03_0034__row5680103994511"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0034__p1663910598479">max</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0034__p6639175918474">Double</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0034__p127226285616">Specifies the maximum value of metric data within a rollup period.</p>
</td>
</tr>
<tr id="ces_03_0034__row07144394520"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0034__p7848101011485">min</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0034__p8848101013487">Double</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0034__p1889141435616">Specifies the minimum value of metric data within a rollup period.</p>
</td>
</tr>
<tr id="ces_03_0034__row158831248174516"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0034__p2142714104819">sum</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0034__p14142314154811">Double</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0034__p6683172714564">Specifies the sum of metric data within a rollup period.</p>
</td>
</tr>
<tr id="ces_03_0034__row2596251184514"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0034__p8162141615480">variance</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0034__p17162191664816">Double</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0034__p891995065612">Specifies the variance of metric data within a rollup period.</p>
</td>
</tr>
<tr id="ces_03_0034__row16756331192316"><td class="cellrowborder" valign="top" width="18.24182418241824%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0034__p40923954191739">timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="14.631463146314633%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0034__p9182852143611">Long</p>
</td>
<td class="cellrowborder" valign="top" width="67.12671267126713%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0034__p26617833191739">Specifies when the metric is collected. It is a UNIX timestamp in milliseconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="ces_03_0034__ul64079661191739"><li id="ces_03_0034__li39846037191739">Example response<div class="p" id="ces_03_0034__p187805269325"><a name="ces_03_0034__li39846037191739"></a><a name="li39846037191739"></a>Example response 1: The average <strong id="ces_03_0034__b16427210151712">cpu_util</strong> of the ECS whose <strong id="ces_03_0034__b236283115174">instance_id</strong> is <strong id="ces_03_0034__b4346139101719">faea5b75-e390-4e2b-8733-9226a9026070</strong> and the average <strong id="ces_03_0034__b1310210460153">network_vm_connections</strong> of the ECS whose <strong id="ces_03_0034__b1482185213178">instance_id</strong> is <strong id="ces_03_0034__b8891656111719">06b4020f-461a-4a52-84da-53fa71c2f42b</strong> are displayed.<pre class="screen" id="ces_03_0034__screen212419238320">{
"metrics": [
{
"namespace": "SYS.ECS",
"metric_name": "cpu_util",
"dimensions": [
{
"name": "instance_id",
"value": "faea5b75-e390-4e2b-8733-9226a9026070"
}
],
"datapoints": [
{
"average": 0.69,
"timestamp": 1556625610000
},
{
"average": 0.7,
"timestamp": 1556625715000
}
],
"unit": "%"
},
{
"namespace": "SYS.ECS",
"metric_name": "network_vm_connections",
"dimensions": [
{
"name": "instance_id",
"value": "06b4020f-461a-4a52-84da-53fa71c2f42b"
}
],
"datapoints": [
{
"average": 1,
"timestamp": 1556625612000
},
{
"average": 3,
"timestamp": 1556625717000
}
],
"unit": "count"
}
]
}</pre>
</div>
<div class="p" id="ces_03_0034__p9617122319403">Response example 2: The <strong id="ces_03_0034__b1821015471936">rds021_myisam_buf_usage</strong> sums of the RDS instance whose <strong id="ces_03_0034__b569044671019">rds_cluster_id</strong> are <strong id="ces_03_0034__b1214313121111">3c8cc15614ab46f5b8743317555e0de2in01</strong> is displayed, and those of the RDS instance whose <strong id="ces_03_0034__b85855410150">rds_cluster_id</strong> is <strong id="ces_03_0034__b1326131911151">3b2fa8b55a9b4adca3713962a9d31884in01</strong> are displayed.<pre class="screen" id="ces_03_0034__screen1061719236409">{
"metrics": [
{
"unit": "Ratio",
"datapoints": [
{
"sum": 0.07,
"timestamp": 1556625628000
},
{
"sum": 0.07,
"timestamp": 1556625688000
}
],
"namespace": "SYS.RDS",
"dimensions": [
{
"name": "rds_cluster_id",
"value": "3c8cc15614ab46f5b8743317555e0de2in01"
}
],
"metric_name": "rds021_myisam_buf_usage"
},
{
"unit": "Ratio",
"datapoints": [
{
"sum": 0.06,
"timestamp": 1556625614000
},
{
"sum": 0.07,
"timestamp": 1556625674000
}
],
"namespace": "SYS.RDS",
"dimensions": [
{
"name": "rds_cluster_id",
"value": "3b2fa8b55a9b4adca3713962a9d31884in01"
}
],
"metric_name": "rds021_myisam_buf_usage"
}
]
}</pre>
</div>
<div class="p" id="ces_03_0034__p813411586464">Response example 3: The minimum <strong id="ces_03_0034__b1534455163312">rds021_myisam_buf_usage</strong> of the server whose <strong id="ces_03_0034__b149723373339">instance_id</strong> is <strong id="ces_03_0034__b197981842163314">cd841102-f6b1-407d-a31f-235db796dcbb</strong> and <strong id="ces_03_0034__b16348145123414">proc</strong> is <strong id="ces_03_0034__b1224091123418">b28354b543375bfa94dabaeda722927f</strong> is displayed.<pre class="screen" id="ces_03_0034__screen1213405817465">{
"metrics": [
{
"unit": "Ratio",
"datapoints": [
{
"min": 0,
"timestamp": 1556625612000
},
{
"min": 0,
"timestamp": 1556625672000
}
],
"namespace": "AGT.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "cd841102-f6b1-407d-a31f-235db796dcbb"
},
{
"name": "proc",
"value": "b28354b543375bfa94dabaeda722927f"
}
],
"metric_name": "rds021_myisam_buf_usage"
}
]
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="ces_03_0034__section40827282191739"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0034__ul18675578191739"><li id="ces_03_0034__li33862476191739">Normal<p id="ces_03_0034__p36326834191739"><a name="ces_03_0034__li33862476191739"></a><a name="li33862476191739"></a>200</p>
</li><li id="ces_03_0034__li58506051191739">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0034__table56792418191739" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0034__row38483636191739"><th align="left" class="cellrowborder" valign="top" width="32.519999999999996%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="ces_03_0034__p30166797191739">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.47999999999999%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="ces_03_0034__p27591491191739">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0034__row20318269191739"><td class="cellrowborder" valign="top" width="32.519999999999996%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0034__p35167075191739">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0034__p29960863191739">Request error.</p>
</td>
</tr>
<tr id="ces_03_0034__row1212311191739"><td class="cellrowborder" valign="top" width="32.519999999999996%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0034__p31088396191739">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0034__p35132170191739">The authentication information is not provided or is incorrect.</p>
</td>
</tr>
<tr id="ces_03_0034__row47754075191739"><td class="cellrowborder" valign="top" width="32.519999999999996%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0034__p42874872191739">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0034__p50312626191739">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="ces_03_0034__row50160453191739"><td class="cellrowborder" valign="top" width="32.519999999999996%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0034__p36464884191739">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0034__p865652191739">The request timed out.</p>
</td>
</tr>
<tr id="ces_03_0034__row7790874191739"><td class="cellrowborder" valign="top" width="32.519999999999996%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0034__p27081046191739">429 Too Many Requests</p>
</td>
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0034__p46081078191739">Concurrent requests are excessive.</p>
</td>
</tr>
<tr id="ces_03_0034__row12076519191739"><td class="cellrowborder" valign="top" width="32.519999999999996%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0034__p38673977191739">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0034__p45584419191739">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="ces_03_0034__row7606593191739"><td class="cellrowborder" valign="top" width="32.519999999999996%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0034__p12154307191739">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0034__p44974834191739">The service is currently unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="ces_03_0034__section142437169473"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0034__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>