forked from docs/doc-exports
Reviewed-by: gtema <artem.goncharov@gmail.com> Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
432 lines
31 KiB
HTML
432 lines
31 KiB
HTML
<a name="aom_04_1012"></a><a name="aom_04_1012"></a>
|
||
|
||
<h1 class="topictitle1">Querying Monitoring Data</h1>
|
||
<div id="body1606983050235"><div class="section" id="aom_04_1012__section44676604"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="aom_04_1012__p14218791">This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query data.</p>
|
||
</div>
|
||
<div class="section" id="aom_04_1012__section66545117"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="aom_04_1012__p10871421">POST /v2/{project_id}/ams/metricdata</p>
|
||
<p class="msonormal" id="aom_04_1012__p30733926"><a href="#aom_04_1012__table113891249135611">Table 1</a> describes the parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1012__table113891249135611"></a><a name="table113891249135611"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1012__table113891249135611" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="aom_04_1012__row29287756"><th align="left" class="cellrowborder" valign="top" width="28.282828282828287%" id="mcps1.3.2.4.2.6.1.1"><p id="aom_04_1012__p183891549115618">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10.101010101010102%" id="mcps1.3.2.4.2.6.1.2"><p id="aom_04_1012__p43891349105619">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="8.080808080808081%" id="mcps1.3.2.4.2.6.1.3"><p id="aom_04_1012__p1181073319177">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.2.4.2.6.1.4"><p id="aom_04_1012__p5384837181712">Value Range</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="36.36363636363637%" id="mcps1.3.2.4.2.6.1.5"><p id="aom_04_1012__p1538910497565">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1012__row18847690"><td class="cellrowborder" valign="top" width="28.282828282828287%" headers="mcps1.3.2.4.2.6.1.1 "><p id="aom_04_1012__p13891549175617">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.4.2.6.1.2 "><p id="aom_04_1012__p18389144912562">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="8.080808080808081%" headers="mcps1.3.2.4.2.6.1.3 "><p id="aom_04_1012__p581003351715">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.2.4.2.6.1.4 "><p id="aom_04_1012__p1638473761711">-</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="36.36363636363637%" headers="mcps1.3.2.4.2.6.1.5 "><p id="aom_04_1012__p038934910563">Project ID obtained from IAM. Generally, a project ID contains 32 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row17311253165712"><td class="cellrowborder" valign="top" width="28.282828282828287%" headers="mcps1.3.2.4.2.6.1.1 "><p id="aom_04_1012__p630573220165">fillValue</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.4.2.6.1.2 "><p id="aom_04_1012__p5305163213163">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="8.080808080808081%" headers="mcps1.3.2.4.2.6.1.3 "><p id="aom_04_1012__p188105337171">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.2.4.2.6.1.4 "><p id="aom_04_1012__p0385837161714">–1, 0, null, and average</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="36.36363636363637%" headers="mcps1.3.2.4.2.6.1.5 "><p id="aom_04_1012__p19305532101619">Filled value for breakpoints in monitoring data. Default value: –1.</p>
|
||
<ul id="aom_04_1012__ul18810182132915"><li id="aom_04_1012__li1781002122913">–1: Breakpoints are filled with –1.</li><li id="aom_04_1012__li1381011218299">0: Breakpoints are filled with 0.</li><li id="aom_04_1012__li1181012116294">null: Breakpoints are filled with null.</li><li id="aom_04_1012__li281042112297">average: Breakpoints are filled with the average value of adjacent valid data. If there is no valid data, breakpoints are filled with null.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="aom_04_1012__section62035148"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="aom_04_1012__p8284944"><strong id="aom_04_1012__b7455633">Request parameters</strong></p>
|
||
<p class="msonormal" id="aom_04_1012__p67100700"><a href="#aom_04_1012__table539122593914">Table 2</a> describes the request parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1012__table539122593914"></a><a name="table539122593914"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1012__table539122593914" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="aom_04_1012__row30793786"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.4.2.6.1.1"><p id="aom_04_1012__p11268747">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="13.13131313131313%" id="mcps1.3.3.4.2.6.1.2"><p id="aom_04_1012__p40353316">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17.17171717171717%" id="mcps1.3.3.4.2.6.1.3"><p id="aom_04_1012__p47393198">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="23.282328232823282%" id="mcps1.3.3.4.2.6.1.4"><p id="aom_04_1012__p13643857">Value Range</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="26.212621262126213%" id="mcps1.3.3.4.2.6.1.5"><p id="aom_04_1012__p31410612">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1012__row61231615"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1012__p1896543115406">metrics</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1012__p26969711">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1012__p37063012">JSON array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.282328232823282%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1012__p49314018">A maximum of 20 metrics are supported. See <a href="#aom_04_1012__table1357332718015">Table 3</a>.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="26.212621262126213%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1012__p11693413">List of metrics.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row435925419306"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1012__p1236012544308">period</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1012__p107115824215">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1012__p7711386428">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.282328232823282%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1012__p207214813426">Enumerated value. Options:</p>
|
||
<ul id="aom_04_1012__ul2725819429"><li id="aom_04_1012__li207216814428">60: The data monitoring granularity is 1 minute.</li><li id="aom_04_1012__li187288114219">300: The data monitoring granularity is 5 minutes.</li><li id="aom_04_1012__li4729844216">900: The data monitoring granularity is 15 minutes.</li><li id="aom_04_1012__li17721481428">3600: The data monitoring granularity is 1 hour.</li></ul>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="26.212621262126213%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1012__p187317864216">Data monitoring granularity.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row11829013110"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1012__p17447584117">timerange</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1012__p5730310">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1012__p61501942">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.282328232823282%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1012__p15601415">Format: start time (UTC, in ms).end time (UTC, in ms).number of minutes in the time period. When the start time and end time are –1, it indicates the latest <em id="aom_04_1012__i595397714105044">N</em> minutes. <em id="aom_04_1012__i1783859324105044">N</em> indicates the time period by the granularity of minute.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="26.212621262126213%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1012__p18841153317293">Query time period. For example, <strong id="aom_04_1012__b1440471307105044">–1.–1.5</strong> indicates the last 5 minutes. <strong id="aom_04_1012__b1608338694105044">1501545600000.1501632000000.1440</strong> indicates the fixed time period from 08:00:00 on August 1, 2017 to 08:00:00 on August 2, 2017.</p>
|
||
<div class="note" id="aom_04_1012__note64285414395"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="aom_04_1012__p18429941113910">Time range/Period ≤ 1440</p>
|
||
<p id="aom_04_1012__p132106813408">The <strong id="aom_04_1012__b1148043315384">timerange</strong> and <strong id="aom_04_1012__b12680123653813">period</strong> must use the same unit.</p>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row19481454104018"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1012__p1849145412404">statistics</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1012__p56540535">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1012__p1075619354379">JSON array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.282328232823282%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1012__p51759639">maximum, minimum, sum, average, or sampleCount.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="26.212621262126213%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1012__p31781267">Statistic.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1012__table1357332718015"></a><a name="table1357332718015"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1012__table1357332718015" frame="border" border="1" rules="all"><caption><b>Table 3 </b>metrics parameters</caption><thead align="left"><tr id="aom_04_1012__row19809996"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.6.1.1"><p id="aom_04_1012__p61105833">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.5.2.6.1.2"><p id="aom_04_1012__p50625422">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.5.2.6.1.3"><p id="aom_04_1012__p7018532">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.3.5.2.6.1.4"><p id="aom_04_1012__p31630226">Value Range</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.3.5.2.6.1.5"><p id="aom_04_1012__p11911553">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1012__row38131860"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.1 "><p id="aom_04_1012__p1672954">namespace</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.5.2.6.1.2 "><p id="aom_04_1012__p1291556">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.5.2.6.1.3 "><p id="aom_04_1012__p37507194">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.5.2.6.1.4 "><p id="aom_04_1012__p18183910">PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, and CUSTOMMETRICS.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.5.2.6.1.5 "><p id="aom_04_1012__p63610573">Metric namespace.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row35624251"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.1 "><p id="aom_04_1012__p66992105">metricName</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.5.2.6.1.2 "><p id="aom_04_1012__p57651399">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.5.2.6.1.3 "><p id="aom_04_1012__p39251709">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.5.2.6.1.4 "><p id="aom_04_1012__p25271860">1–255 characters.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.5.2.6.1.5 "><p id="aom_04_1012__p33754771">Metric name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row35357490"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.1 "><p id="aom_04_1012__p45384417">dimensions</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.5.2.6.1.2 "><p id="aom_04_1012__p52259149">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.5.2.6.1.3 "><p id="aom_04_1012__p5132637">JSON array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.5.2.6.1.4 "><p id="aom_04_1012__p13090425">Neither the array nor the name/value of any dimension in the array can be left blank.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.5.2.6.1.5 "><p id="aom_04_1012__p53691530">Metric dimension.</p>
|
||
<p id="aom_04_1012__p13277162535619">dimensions.name: dimension name. Example: appName.</p>
|
||
<p id="aom_04_1012__p0717785615">dimensions.value: dimension value, such as a specific application name.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="aom_04_1012__p13501584343"><strong id="aom_04_1012__b1024195414120">Request headers</strong></p>
|
||
<p class="msonormal" id="aom_04_1012__p19248500157"><a href="#aom_04_1012__table17428844137">Table 4</a> describes the request headers.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1012__table17428844137"></a><a name="table17428844137"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1012__table17428844137" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request headers</caption><thead align="left"><tr id="aom_04_1012__row1542824171318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.4.1.1"><p id="aom_04_1012__p18428241134">Name</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.4.1.2"><p id="aom_04_1012__p1142819412139">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.3.8.2.4.1.3"><p id="aom_04_1012__p1742816441311">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1012__row1942834191319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.4.1.1 "><p id="aom_04_1012__p166451516193818">X-Auth-Token</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.4.1.2 "><p id="aom_04_1012__p464591643812">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.8.2.4.1.3 "><p id="aom_04_1012__p156451416173813">User token obtained from IAM.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row2428124181313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.4.1.1 "><p id="aom_04_1012__p464641619384">Content-Type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.4.1.2 "><p id="aom_04_1012__p464631663813">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.8.2.4.1.3 "><p id="aom_04_1012__p1464691683810">Content type, which is <strong id="aom_04_1012__b186752851105044">application/json</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p class="msonormal" id="aom_04_1012__p17595947"><strong id="aom_04_1012__b24145802">Example request</strong></p>
|
||
<pre class="screen" id="aom_04_1012__screen18921322011">{
|
||
"metrics": [
|
||
{
|
||
"namespace": "abc",
|
||
"metricName": "def",
|
||
"dimensions": [
|
||
{
|
||
"name": "instance_id",
|
||
"value": "demo1"
|
||
}
|
||
]
|
||
}
|
||
],
|
||
"period": 60,
|
||
"timerange": "-1.-1.5",//Last 5 minutes
|
||
"statistics": [
|
||
"maximum",
|
||
"minimum",
|
||
"sum"
|
||
]
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="aom_04_1012__section21445425"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="aom_04_1012__p26550711"><strong id="aom_04_1012__b37629813">Response parameters</strong></p>
|
||
<p class="msonormal" id="aom_04_1012__p3124002"><a href="#aom_04_1012__table538365710452">Table 5</a> describes the response parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1012__table538365710452"></a><a name="table538365710452"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1012__table538365710452" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameters</caption><thead align="left"><tr id="aom_04_1012__row40547213"><th align="left" class="cellrowborder" valign="top" width="29.592959295929592%" id="mcps1.3.4.4.2.4.1.1"><p id="aom_04_1012__p63098814">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="36.733673367336735%" id="mcps1.3.4.4.2.4.1.2"><p id="aom_04_1012__p10730275">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.673367336733676%" id="mcps1.3.4.4.2.4.1.3"><p id="aom_04_1012__p63845924">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1012__row4137387"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1012__p66692893">errorCode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1012__p33415268">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1012__p22282216">Response code.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row66322220"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1012__p3390741">errorMessage</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1012__p6214639">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1012__p33623778">Response message.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row34178548"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1012__p16998974">metrics</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1012__p34739636">JSON object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1012__p62447168">-</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p class="msonormal" id="aom_04_1012__p25153600"><strong id="aom_04_1012__b25055815">Example response</strong></p>
|
||
<pre class="screen" id="aom_04_1012__screen48353636">{
|
||
"errorCode": "AOM.0200",
|
||
"errorMessage": "success",
|
||
"metrics": [{
|
||
"metric": {
|
||
"namespace": "abc",
|
||
"metricName": "def",
|
||
"dimensions": [{
|
||
"name": "ghi",
|
||
"value": "lmn"
|
||
}]
|
||
},
|
||
"dataPoints": [{
|
||
"timestamp": 1467892800000,
|
||
"unit": "Percent",
|
||
"statistics": [{
|
||
"statistic": "maximum",
|
||
"value": 23
|
||
}]
|
||
}]
|
||
}]
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="aom_04_1012__section58791101"><h4 class="sectiontitle">Status Code</h4><ul id="aom_04_1012__ul24330482"><li id="aom_04_1012__li17647751">Success response<p id="aom_04_1012__p24612036"><a name="aom_04_1012__li17647751"></a><a name="li17647751"></a><a href="#aom_04_1012__table86491459125016">Table 6</a> describes the status code.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1012__table86491459125016"></a><a name="table86491459125016"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1012__table86491459125016" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status code</caption><thead align="left"><tr id="aom_04_1012__row58979846"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="aom_04_1012__p12638194">Status Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="aom_04_1012__p18261589486">Message</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="aom_04_1012__p17060819">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1012__row39749137"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="aom_04_1012__p65563539">200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="aom_04_1012__p115208125323">OK</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="aom_04_1012__p19579466497">The request has succeeded.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="aom_04_1012__ul53916176"><li id="aom_04_1012__li15483537">Error response<p id="aom_04_1012__p5134112"><a name="aom_04_1012__li15483537"></a><a name="li15483537"></a><a href="#aom_04_1012__table939134985614">Table 7</a> describes the status codes. For more information, see <a href="aom_04_0018.html">Status Codes</a>.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1012__table939134985614"></a><a name="table939134985614"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1012__table939134985614" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Status codes</caption><thead align="left"><tr id="aom_04_1012__row44141239"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.3.1.2.2.4.1.1"><p id="aom_04_1012__p18670586">Status Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.3.1.2.2.4.1.2"><p id="aom_04_1012__p47075245288">Message</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.3.1.2.2.4.1.3"><p id="aom_04_1012__p35922469">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1012__row24038881"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1012__p992341">400</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1012__p126271018112520">Bad Request</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1012__p2431727192515">The request is invalid.</p>
|
||
<p id="aom_04_1012__p34352717254">The client should not repeat the request without modifications.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row52328576"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1012__p10756297">401</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1012__p195759466253">Unauthorized</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1012__p1371123810254">The authorization information provided by the client is incorrect or invalid.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row56712700"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1012__p30325987">403</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1012__p15185125614254">Forbidden</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1012__p10447844263">The request is rejected.</p>
|
||
<p id="aom_04_1012__p20447941267">The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications. </p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row28828553"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1012__p53411432">500</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1012__p2945812153211">Internal Server Error</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1012__p1815584516269">The server is able to receive the request but unable to understand the request.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row13793060"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1012__p43496037">503</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.2 "><p id="aom_04_1012__p205675500263">Service Unavailable</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.3.1.2.2.4.1.3 "><p id="aom_04_1012__p4668115672614">The requested service is invalid.</p>
|
||
<p id="aom_04_1012__p14669256182611">The client should not repeat the request without modifications.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="aom_04_1012__section1031718191744"><h4 class="sectiontitle">Error Code</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1012__table19843152719510" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Error codes</caption><thead align="left"><tr id="aom_04_1012__row88441927656"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.2.4.1.1"><p id="aom_04_1012__p1664218538510">Error Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.2.4.1.2"><p id="aom_04_1012__p146421953155">Message</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.2.4.1.3"><p id="aom_04_1012__p18642145310513">Solution</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1012__row138447276513"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p149884561991">AOM.0101</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p11116136173116">Projectid is left blank.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p16988165618910">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row1384414271159"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p1998835611920">AOM.0102</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p71161936193116">The metric data parameter is null.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p14988156691">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row084552711518"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p17988115610913">AOM.0103</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p1711663613111">Invalid period.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p39881356196">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row128451727759"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p998895616919">AOM.0104</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p141167360316">Invalid statistics.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p598813561298">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row18845127251"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p1799013568917">AOM.0105</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p17117103612317">Invalid metrics.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p499010562919">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row14473432564"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p2990135613919">AOM.0106</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p131177363318">Invalid time range.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p8990165612910">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row480710321293"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p149901568910">AOM.0107</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p71171836133110">The number of data points in a time range exceeds 1440.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p1399016560917">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row880623218910"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p499015562910">AOM.0110</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p1111715366316">Invalid fillValue.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p2099019561393">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1012__row7805143212910"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1012__p69887561094">AOM.0500</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1012__p1711783610317">Internal server error.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1012__p1398814567919">Contact technical support.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_1045.html">Monitoring APIs</a></div>
|
||
</div>
|
||
</div>
|
||
|