vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ces/api-ref/ces_03_0023.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

322 lines
25 KiB
HTML
Raw Blame History

<a name="ces_03_0023"></a><a name="ces_03_0023"></a>
<h1 class="topictitle1">Querying Metrics</h1>
<div id="body38092103"><div class="section" id="ces_03_0023__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0023__p65561530">This API is used to query metrics supported by Cloud Eye. You can specify the namespace, metric, dimension, sorting order, start records, and the maximum number of records when using this API to query metrics.</p>
</div>
<div class="section" id="ces_03_0023__section62331491"><h4 class="sectiontitle">URI</h4><p id="ces_03_0023__p48490504">GET /V1.0/{project_id}/metrics</p>
<ul id="ces_03_0023__ul877151695511"><li id="ces_03_0023__li107715160552">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0023__table35298993175334" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0023__row56207076175334"><th align="left" class="cellrowborder" valign="top" width="20.792079207920793%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="ces_03_0023__p56479321175334">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="ces_03_0023__p11422274175334">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63.366336633663366%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="ces_03_0023__p52789000175334">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0023__row48050578175334"><td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0023__p66891592175334">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0023__p49509908175334">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="63.366336633663366%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0023__p50879579175334">Specifies the project ID.</p>
<p id="ces_03_0023__p35013331952">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_0023__p19167103355114">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0023__table35416756" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameter description</caption><thead align="left"><tr id="ces_03_0023__row27598891"><th align="left" class="cellrowborder" valign="top" width="20.3%" id="mcps1.3.2.3.1.2.1.2.5.1.1"><p id="ces_03_0023__p20917673">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.6%" id="mcps1.3.2.3.1.2.1.2.5.1.2"><p id="ces_03_0023__p16609919">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.2.3.1.2.1.2.5.1.3"><p id="ces_03_0023__p3884242163044">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.18%" id="mcps1.3.2.3.1.2.1.2.5.1.4"><p id="ces_03_0023__p3226198">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0023__row59995477"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0023__p27795493">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0023__p36842478">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0023__p46188171163044">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0023__p2687838193910">Query 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_0023__p1529914911223">The namespace must be in the <strong id="ces_03_0023__b842352706195615">service.item</strong> format and contain 3 to 32 characters. <strong id="ces_03_0023__b842352706195450">service</strong> and <strong id="ces_03_0023__b842352706195455">item</strong> each must start with a letter and contain only letters, digits, and underscores (_). </p>
</td>
</tr>
<tr id="ces_03_0023__row14620943"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0023__p43445707">metric_name</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0023__p29441404">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0023__p50254369163044">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0023__p1351411315505">Specifies the metric ID. For example, if the monitoring metric of an ECS is CPU usage, <strong id="ces_03_0023__b142915321147">metric_name</strong> is <strong id="ces_03_0023__b24290321848">cpu_util</strong>. For details, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
</td>
</tr>
<tr id="ces_03_0023__row55056607"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0023__p30400195">dim</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0023__p46496694">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0023__p44072059163044">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0023__p228921325315">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0023__b55391154171612">instance_id</strong>. For details about each service dimension, see <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
<p id="ces_03_0023__p19158445162638">A maximum of three dimensions are supported, and the dimensions are numbered from 0 in <strong id="ces_03_0023__b15916112071517">dim.{i}=key,value</strong> format. <strong id="ces_03_0023__b10515162815168">key</strong> cannot exceed 32 characters and <strong id="ces_03_0023__b14722366168">value</strong> cannot exceed 256 characters.</p>
<p id="ces_03_0023__p8135907">Single dimension: <strong id="ces_03_0023__b916844495712">dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d</strong></p>
<p id="ces_03_0023__p134693117211">Multiple dimensions: <strong id="ces_03_0023__b35998583577">dim.0=key,value&amp;dim.1=key,value</strong></p>
</td>
</tr>
<tr id="ces_03_0023__row6114302"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0023__p25496434">start</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0023__p51945267">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0023__p13067009163044">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0023__p53938779205119">Specifies the paging start value.</p>
<p id="ces_03_0023__p3308015715032">The format is <strong id="ces_03_0023__b27794473205024">namespace.metric_name.key:value</strong>.</p>
<p id="ces_03_0023__p62847380164456">Example: <strong id="ces_03_0023__b33318075145433">start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d</strong>.</p>
</td>
</tr>
<tr id="ces_03_0023__row18700393"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0023__p38336904">limit</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0023__p18281552">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0023__p51794845163044">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0023__p4410728">Supported range: <strong id="ces_03_0023__b6013100620539">1</strong> to <strong id="ces_03_0023__b25293232205313">1000</strong> (default)</p>
<p id="ces_03_0023__p39696553">This parameter is used to limit the number of query results.</p>
</td>
</tr>
<tr id="ces_03_0023__row21724664"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.2.3.1.2.1.2.5.1.1 "><p id="ces_03_0023__p14867369">order</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.2.3.1.2.1.2.5.1.2 "><p id="ces_03_0023__p63406242">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.3.1.2.1.2.5.1.3 "><p id="ces_03_0023__p34632884163044">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.2.3.1.2.1.2.5.1.4 "><p id="ces_03_0023__p35632012">Specifies the result sorting method, which is sorted by timestamp.</p>
<p id="ces_03_0023__p52252659">The default method is <strong id="ces_03_0023__b27407972205024">desc</strong>.</p>
<ul id="ces_03_0023__ul4241055916271"><li id="ces_03_0023__li1487080716271"><strong id="ces_03_0023__b56442258145930">asc</strong>: The query results are displayed in the ascending order.</li><li id="ces_03_0023__li3629133716271"><strong id="ces_03_0023__b54242000145945">desc</strong>: The query results are displayed in the descending order.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li><li id="ces_03_0023__li536019218333">Example requests<div class="p" id="ces_03_0023__p19876545183312"><a name="ces_03_0023__li536019218333"></a><a name="li536019218333"></a>Example request 1: Query all metrics that can be monitored.<pre class="screen" id="ces_03_0023__screen19889056194625">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/metrics</pre>
</div>
<div class="p" id="ces_03_0023__p2019573433014">Example request 2: Query the CPU usage of the ECS whose ID is <strong id="ces_03_0023__b13784145281010">6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d</strong>. Retain 10 records in descending order by timestamp.<pre class="screen" id="ces_03_0023__screen531212242616">GET https://{Cloud Eye endpoint}/V1.0/{project_id}/metrics?namespace=SYS.ECS&amp;metric_name=cpu_util&amp;dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d&amp;limit=10&amp;order=desc</pre>
</div>
</li></ul>
</div>
<div class="section" id="ces_03_0023__section24112512"><h4 class="sectiontitle">Request</h4><p id="ces_03_0023__p45638969">None</p>
</div>
<div class="section" id="ces_03_0023__section15686020"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0023__ul5769005"><li id="ces_03_0023__li62568603152631">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0023__table26246518152631" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0023__row29602547152631"><th align="left" class="cellrowborder" valign="top" width="22.66%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="ces_03_0023__p48996072152631">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.869999999999997%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="ces_03_0023__p11771280152631">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.47%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="ces_03_0023__p13949586152631">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0023__row39341340152631"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0023__p32531944152631">metrics</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0023__p35902407152631">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0023__p22413865152631">Specifies the list of metric objects.</p>
<p id="ces_03_0023__p9149533195013">For details, see <a href="#ces_03_0023__table363011386367">Table 4</a>.</p>
</td>
</tr>
<tr id="ces_03_0023__row398200152631"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0023__p185733280374">meta_data</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0023__p20573192843719">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0023__p8573192811378">Specifies the metadata of query results, including the pagination information.</p>
<p id="ces_03_0023__p1991019716501">For details, see <a href="#ces_03_0023__table2048015400368">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0023__table363011386367"></a><a name="table363011386367"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0023__table363011386367" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0023__b249715931218">metrics</strong> data structure description</caption><thead align="left"><tr id="ces_03_0023__row1463018384369"><th align="left" class="cellrowborder" valign="top" width="22.66%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="ces_03_0023__p8630738103611">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.869999999999997%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="ces_03_0023__p263020388366">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.47%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="ces_03_0023__p13630438133618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0023__row9632338163613"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0023__p2632938193619">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0023__p8632538113612">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0023__p1163253814361">Specifies the metric namespace.</p>
</td>
</tr>
<tr id="ces_03_0023__row863393813366"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0023__p13633173883611">dimensions</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0023__p17633238143612">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0023__p86333383365">Specifies the list of metric dimensions.</p>
<p id="ces_03_0023__p034915531507">For details, see <a href="#ces_03_0023__table2024213426364">Table 5</a>.</p>
</td>
</tr>
<tr id="ces_03_0023__row131721037132313"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0023__p1632163814369">metric_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0023__p17632143883613">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0023__p1963218384362">Specifies the metric name, such as <strong id="ces_03_0023__b443035911204">cpu_util</strong>.</p>
</td>
</tr>
<tr id="ces_03_0023__row136801240152316"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0023__p76326384363">unit</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0023__p86324389363">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0023__p156324389368">Specifies the metric unit.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0023__table2024213426364"></a><a name="table2024213426364"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0023__table2024213426364" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="ces_03_0023__b1569618107149">dimensions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0023__row1224234213619"><th align="left" class="cellrowborder" valign="top" width="22.66%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="ces_03_0023__p1524215426367">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.869999999999997%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="ces_03_0023__p1424394213614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.47%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="ces_03_0023__p1324394263611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0023__row2024612424367"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0023__p824618425365">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0023__p3246194283614">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0023__p7551220145010">Specifies the dimension. For example, the ECS dimension is <strong id="ces_03_0023__b76201318151716">instance_id</strong>. For details about the dimension of each service, see the <strong id="ces_03_0023__b1865732122112">key</strong> column in <a href="ces_03_0059.html">Services Interconnected with Cloud Eye</a>.</p>
</td>
</tr>
<tr id="ces_03_0023__row20547244255"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0023__p5547124122511">value</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0023__p19547154122519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0023__p11371113251615">Specifies the dimension value, for example, an ECS ID.</p>
<p id="ces_03_0023__p12480161492518">Enter 1 to 256 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ces_03_0023__table2048015400368"></a><a name="table2048015400368"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0023__table2048015400368" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="ces_03_0023__b8604833201619">meta_data</strong> data structure description</caption><thead align="left"><tr id="ces_03_0023__row16481164019363"><th align="left" class="cellrowborder" valign="top" width="22.66%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="ces_03_0023__p14481194083615">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.869999999999997%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="ces_03_0023__p5481134019368">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.47%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="ces_03_0023__p3481740153611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0023__row8481540153615"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0023__p13481174011361">count</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0023__p134811140133617">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0023__p9481104053612">Specifies the number of returned results.</p>
</td>
</tr>
<tr id="ces_03_0023__row1248220406364"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0023__p748214015361">marker</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0023__p13750151725818">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0023__p4482104043610">Specifies the pagination marker.</p>
<p id="ces_03_0023__p632235322917">For example, you have queried 10 records this time and the tenth record is about <strong id="ces_03_0023__b20648210143212">cpu_util</strong>. In your next query, if <strong id="ces_03_0023__b364411189325">start</strong> is set to <strong id="ces_03_0023__b159981522193214">cpu_util</strong>, you can start your query from the next metric of <strong id="ces_03_0023__b574315653219">cpu_util</strong>.</p>
</td>
</tr>
<tr id="ces_03_0023__row20477125219253"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="ces_03_0023__p44811040173612">total</p>
</td>
<td class="cellrowborder" valign="top" width="16.869999999999997%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="ces_03_0023__p1348113409364">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.47%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="ces_03_0023__p448244013616">Specifies the total number of metrics.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="ces_03_0023__li51921052">Example response<pre class="screen" id="ces_03_0023__screen38141381193838">{
"metrics": [
{
"namespace": "SYS.ECS",
"dimensions": [
{
"name": "instance_id",
"value": "d9112af5-6913-4f3b-bd0a-3f96711e004d"
}
],
"metric_name": "cpu_util",
"unit": "%"
}
],
"meta_data": {
"count": 1,
"marker": "SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d",
"total": 7
}
}</pre>
</li></ul>
</div>
<div class="section" id="ces_03_0023__section6956456"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0023__ul20226985"><li id="ces_03_0023__li47825138">Normal<p id="ces_03_0023__p27773061"><a name="ces_03_0023__li47825138"></a><a name="li47825138"></a>200</p>
</li><li id="ces_03_0023__li48630964">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0023__table10364173623214" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0023__row03645369329"><th align="left" class="cellrowborder" valign="top" width="32.1%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="ces_03_0023__p1849030182924">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="67.9%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="ces_03_0023__p15553712182924">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ces_03_0023__row236413368320"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0023__p581987519168">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0023__p164784039168">Request error.</p>
</td>
</tr>
<tr id="ces_03_0023__row1736413365328"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0023__p2691669168">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0023__p218024949168">The authentication information is not provided or is incorrect.</p>
</td>
</tr>
<tr id="ces_03_0023__row16364113663218"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0023__p563264059168">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0023__p661449719168">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="ces_03_0023__row9364103633216"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0023__p355199299168">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0023__p585420329168">The request timed out.</p>
</td>
</tr>
<tr id="ces_03_0023__row173648363321"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0023__p630127129168">429 Too Many Requests</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0023__p37560249168">Concurrent requests are excessive.</p>
</td>
</tr>
<tr id="ces_03_0023__row1736483643220"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0023__p537873819168">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0023__p618106189168">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="ces_03_0023__row2036473613329"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0023__p298930079168">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0023__p54144829168">The service is currently unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="ces_03_0023__section4614115614510"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0023__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_0022.html">Metrics</a></div>
</div>
</div>
View Git Blame Copy Permalink