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>
430 lines
31 KiB
HTML
430 lines
31 KiB
HTML
<a name="aom_04_1013"></a><a name="aom_04_1013"></a>
|
||
|
||
<h1 class="topictitle1">Adding Monitoring Data</h1>
|
||
<div id="body1606983050254"><div class="section" id="aom_04_1013__section66765654"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="aom_04_1013__p6398755">This API is used to add one or more monitoring data records to a server.</p>
|
||
</div>
|
||
<div class="section" id="aom_04_1013__section64019978"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="aom_04_1013__p48537165">POST /v2/{project_id}/ams/report/metricdata</p>
|
||
<p class="msonormal" id="aom_04_1013__p34181304"><a href="#aom_04_1013__table369962415599">Table 1</a> describes the parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1013__table369962415599"></a><a name="table369962415599"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table369962415599" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="aom_04_1013__row21708033"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.4.2.4.1.1"><p id="aom_04_1013__p13520221">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.2.4.2.4.1.2"><p id="aom_04_1013__p21396142">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="42.86%" id="mcps1.3.2.4.2.4.1.3"><p id="aom_04_1013__p55365980">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row55459406"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.4.2.4.1.1 "><p id="aom_04_1013__p63026925">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.2.4.2.4.1.2 "><p id="aom_04_1013__p4907296">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="42.86%" headers="mcps1.3.2.4.2.4.1.3 "><p id="aom_04_1013__p61946704">Project ID obtained from IAM. Generally, a project ID contains 32 characters.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="aom_04_1013__section39308890"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="aom_04_1013__p51627108"><strong id="aom_04_1013__b61990791">Request parameters</strong></p>
|
||
<p class="msonormal" id="aom_04_1013__p21046213"><a href="#aom_04_1013__table539122593914">Table 2</a> describes the request parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1013__table539122593914"></a><a name="table539122593914"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table539122593914" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="aom_04_1013__row30793786"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.4.2.6.1.1"><p id="aom_04_1013__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_1013__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_1013__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_1013__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_1013__p31410612">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row61231615"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1013__p60813787">metric</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1013__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_1013__p37063012">JSON object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.282328232823282%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1013__p49314018">See <a href="#aom_04_1013__table682420139176">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_1013__p35012496">Metric data.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row435925419306"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1013__p1236012544308">values</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1013__p6360054193010">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1013__p1454751364615">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_1013__p123612541306">See <a href="#aom_04_1013__table15287516161811">Table 4</a>.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="26.212621262126213%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1013__p20361165411307">-</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row11829013110"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1013__p19859143">collect_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1013__p65086735">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1013__p37534159">UNIX timestamp</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.282328232823282%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1013__p20368048">UNIX timestamp, in ms.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="26.212621262126213%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1013__p56634251102">Data collection time, which must meet the following requirement:</p>
|
||
<p id="aom_04_1013__p112467351603">Current UTC time – Data collection time ≤ 24 hours, or Data collection time – Current UTC time ≤ 30 minutes</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1013__table682420139176"></a><a name="table682420139176"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table682420139176" frame="border" border="1" rules="all"><caption><b>Table 3 </b>metric parameters</caption><thead align="left"><tr id="aom_04_1013__row98251713111711"><th align="left" class="cellrowborder" valign="top" width="20.1%" id="mcps1.3.3.5.2.6.1.1"><p id="aom_04_1013__en-us_topic_0082628669_p15958447">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15.36%" id="mcps1.3.3.5.2.6.1.2"><p id="aom_04_1013__p454854111197">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="18.08%" id="mcps1.3.3.5.2.6.1.3"><p id="aom_04_1013__en-us_topic_0082628669_p17565813">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17.95%" id="mcps1.3.3.5.2.6.1.4"><p id="aom_04_1013__p6165115951919">Value Range</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="28.51%" id="mcps1.3.3.5.2.6.1.5"><p id="aom_04_1013__en-us_topic_0082628669_p13544785">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row128261313121718"><td class="cellrowborder" valign="top" width="20.1%" headers="mcps1.3.3.5.2.6.1.1 "><p id="aom_04_1013__p882681316176">namespace</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.36%" headers="mcps1.3.3.5.2.6.1.2 "><p id="aom_04_1013__p14507142017206">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.08%" headers="mcps1.3.3.5.2.6.1.3 "><p id="aom_04_1013__p1950716207208">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.3.5.2.6.1.4 "><p id="aom_04_1013__p45082204202">Namespace, which must be in the format of service.item. The value must be 3 to 32 characters starting with a letter. Only letters, digits, and underscores (_) are allowed. In addition, <strong id="aom_04_1013__b1566787353105024">service</strong> cannot start with <strong id="aom_04_1013__b119017772105024">PAAS</strong> or <strong id="aom_04_1013__b1876418645105024">SYS</strong>.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="28.51%" headers="mcps1.3.3.5.2.6.1.5 "><p id="aom_04_1013__p550892015206">Metric namespace.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row28269130174"><td class="cellrowborder" valign="top" width="20.1%" headers="mcps1.3.3.5.2.6.1.1 "><p id="aom_04_1013__p2845101302715">dimensions</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.36%" headers="mcps1.3.3.5.2.6.1.2 "><p id="aom_04_1013__p1484515131277">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.08%" headers="mcps1.3.3.5.2.6.1.3 "><p id="aom_04_1013__p68451113122718">JSON array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.3.5.2.6.1.4 "><p id="aom_04_1013__p208451313122720">Each dimension is a JSON object, and its structure is as follows:</p>
|
||
<p id="aom_04_1013__p1884521315275">dimension.name: 1–32 characters.</p>
|
||
<p id="aom_04_1013__p28451913162717">dimension.value: 1–64 characters.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="28.51%" headers="mcps1.3.3.5.2.6.1.5 "><p id="aom_04_1013__p28461313152715">List of metric dimensions.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1013__table15287516161811"></a><a name="table15287516161811"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table15287516161811" frame="border" border="1" rules="all"><caption><b>Table 4 </b>values parameters</caption><thead align="left"><tr id="aom_04_1013__row528815164183"><th align="left" class="cellrowborder" valign="top" width="18.238176182381757%" id="mcps1.3.3.6.2.6.1.1"><p id="aom_04_1013__p82881416121817">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17.22827717228277%" id="mcps1.3.3.6.2.6.1.2"><p id="aom_04_1013__p162861977298">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15.298470152984697%" id="mcps1.3.3.6.2.6.1.3"><p id="aom_04_1013__p328815161185">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20.72792720727927%" id="mcps1.3.3.6.2.6.1.4"><p id="aom_04_1013__p129951023112919">Value Range</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="28.50714928507149%" id="mcps1.3.3.6.2.6.1.5"><p id="aom_04_1013__p3288131617182">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row132882166183"><td class="cellrowborder" valign="top" width="18.238176182381757%" headers="mcps1.3.3.6.2.6.1.1 "><p id="aom_04_1013__p142881116111811">unit</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.22827717228277%" headers="mcps1.3.3.6.2.6.1.2 "><p id="aom_04_1013__p174134510291">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.298470152984697%" headers="mcps1.3.3.6.2.6.1.3 "><p id="aom_04_1013__p114113454297">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20.72792720727927%" headers="mcps1.3.3.6.2.6.1.4 "><p id="aom_04_1013__p174154517298">-</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="28.50714928507149%" headers="mcps1.3.3.6.2.6.1.5 "><p id="aom_04_1013__p14124552920">Data unit.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row1328801613188"><td class="cellrowborder" valign="top" width="18.238176182381757%" headers="mcps1.3.3.6.2.6.1.1 "><p id="aom_04_1013__p1928815166187">metric_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.22827717228277%" headers="mcps1.3.3.6.2.6.1.2 "><p id="aom_04_1013__p5660125319294">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.298470152984697%" headers="mcps1.3.3.6.2.6.1.3 "><p id="aom_04_1013__p7661165314296">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20.72792720727927%" headers="mcps1.3.3.6.2.6.1.4 "><p id="aom_04_1013__p196611653152919">-</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="28.50714928507149%" headers="mcps1.3.3.6.2.6.1.5 "><p id="aom_04_1013__p14661753202919">Metric name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row52881516141817"><td class="cellrowborder" valign="top" width="18.238176182381757%" headers="mcps1.3.3.6.2.6.1.1 "><p id="aom_04_1013__p3289316161811">type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.22827717228277%" headers="mcps1.3.3.6.2.6.1.2 "><p id="aom_04_1013__p655615223010">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.298470152984697%" headers="mcps1.3.3.6.2.6.1.3 "><p id="aom_04_1013__p955613214305">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20.72792720727927%" headers="mcps1.3.3.6.2.6.1.4 "><p id="aom_04_1013__p12556223301">Integer or floating number</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="28.50714928507149%" headers="mcps1.3.3.6.2.6.1.5 "><p id="aom_04_1013__p85567223011">Data type.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row82890167185"><td class="cellrowborder" valign="top" width="18.238176182381757%" headers="mcps1.3.3.6.2.6.1.1 "><p id="aom_04_1013__p52894162182">value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.22827717228277%" headers="mcps1.3.3.6.2.6.1.2 "><p id="aom_04_1013__p15824181616307">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.298470152984697%" headers="mcps1.3.3.6.2.6.1.3 "><p id="aom_04_1013__p8824171643013">Floating number</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20.72792720727927%" headers="mcps1.3.3.6.2.6.1.4 "><p id="aom_04_1013__p68241416133015">Valid numeral type.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="28.50714928507149%" headers="mcps1.3.3.6.2.6.1.5 "><p id="aom_04_1013__p13824016173017">Metric value.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="aom_04_1013__p13501584343"><strong id="aom_04_1013__b1024195414120">Request headers</strong></p>
|
||
<p class="msonormal" id="aom_04_1013__p19248500157"><a href="#aom_04_1013__table17428844137">Table 5</a> describes the request headers.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1013__table17428844137"></a><a name="table17428844137"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table17428844137" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Request headers</caption><thead align="left"><tr id="aom_04_1013__row1542824171318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.4.1.1"><p id="aom_04_1013__p18428241134">Name</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.4.1.2"><p id="aom_04_1013__p1142819412139">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.3.9.2.4.1.3"><p id="aom_04_1013__p1742816441311">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row1942834191319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.4.1.1 "><p id="aom_04_1013__p166451516193818">X-Auth-Token</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.4.1.2 "><p id="aom_04_1013__p464591643812">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.9.2.4.1.3 "><p id="aom_04_1013__p156451416173813">User token obtained from IAM.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row2428124181313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.4.1.1 "><p id="aom_04_1013__p464641619384">Content-Type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.4.1.2 "><p id="aom_04_1013__p464631663813">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.9.2.4.1.3 "><p id="aom_04_1013__p1464691683810">Content type, which is <strong id="aom_04_1013__b1495874354105024">application/json</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p class="msonormal" id="aom_04_1013__p50909398"><strong id="aom_04_1013__b55531400">Example request</strong></p>
|
||
<pre class="screen" id="aom_04_1013__screen148860101857">[
|
||
{
|
||
"metric": {
|
||
"namespace": "NOPAAS.ESC",
|
||
"dimensions": [
|
||
{
|
||
"name": "instance_id",
|
||
"value": "instance-101"
|
||
}
|
||
]
|
||
},
|
||
"values": [
|
||
{
|
||
"unit": "percent",
|
||
"metric_name": "cpu_util",
|
||
"type": "int",
|
||
"value": 35
|
||
}
|
||
],
|
||
"collect_time": 1467787152000
|
||
}
|
||
]</pre>
|
||
</div>
|
||
<div class="section" id="aom_04_1013__section18235697"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="aom_04_1013__p45340597"><strong id="aom_04_1013__b5412196">Response parameters</strong></p>
|
||
<p class="msonormal" id="aom_04_1013__p48709769"><a href="#aom_04_1013__table03641013479">Table 6</a> describes the response parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1013__table03641013479"></a><a name="table03641013479"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table03641013479" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response parameters</caption><thead align="left"><tr id="aom_04_1013__row40195198"><th align="left" class="cellrowborder" valign="top" width="29.592959295929592%" id="mcps1.3.4.4.2.4.1.1"><p id="aom_04_1013__p34585577">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_1013__p49968357">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_1013__p20905113">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row15592622"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1013__p55042892">errorCode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1013__p29289242">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1013__p23618368">Response code.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row11238724"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1013__p37921442">errorMessage</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1013__p51737965">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1013__p30025612">Response message.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p class="msonormal" id="aom_04_1013__p1795055"><strong id="aom_04_1013__b16155496">Example response</strong></p>
|
||
<pre class="screen" id="aom_04_1013__screen1444843857">{
|
||
"errorCode": "AOM.0200",
|
||
"errorMessage": "success"
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="aom_04_1013__section29903551"><h4 class="sectiontitle">Status Code</h4><ul id="aom_04_1013__ul10172581"><li id="aom_04_1013__li24444371">Success response<p id="aom_04_1013__p18672752"><a name="aom_04_1013__li24444371"></a><a name="li24444371"></a><a href="#aom_04_1013__table86491459125016">Table 7</a> describes the status code.</p>
|
||
|
||
<div class="tablenoborder"><a name="aom_04_1013__table86491459125016"></a><a name="table86491459125016"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table86491459125016" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Status code</caption><thead align="left"><tr id="aom_04_1013__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_1013__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_1013__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_1013__p17060819">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row39749137"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="aom_04_1013__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_1013__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_1013__p19579466497">The request has succeeded.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="aom_04_1013__ul7434555"><li id="aom_04_1013__li66911001">Error response<p id="aom_04_1013__p65328098"><a name="aom_04_1013__li66911001"></a><a name="li66911001"></a><a href="#aom_04_1013__table939134985614">Table 8</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_1013__table939134985614"></a><a name="table939134985614"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table939134985614" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Status codes</caption><thead align="left"><tr id="aom_04_1013__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_1013__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_1013__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_1013__p35922469">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row24038881"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1013__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_1013__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_1013__p2431727192515">The request is invalid.</p>
|
||
<p id="aom_04_1013__p34352717254">The client should not repeat the request without modifications.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row52328576"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1013__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_1013__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_1013__p1371123810254">The authorization information provided by the client is incorrect or invalid.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row56712700"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1013__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_1013__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_1013__p10447844263">The request is rejected.</p>
|
||
<p id="aom_04_1013__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_1013__row28828553"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1013__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_1013__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_1013__p1815584516269">The server is able to receive the request but unable to understand the request.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row13793060"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1013__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_1013__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_1013__p4668115672614">The requested service is invalid. </p>
|
||
<p id="aom_04_1013__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_1013__section180881121217"><h4 class="sectiontitle">Error Code</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1013__table4880211161220" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Error codes</caption><thead align="left"><tr id="aom_04_1013__row58767117124"><th align="left" class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.3.6.2.2.4.1.1"><p id="aom_04_1013__p1287611131219">Error Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.3.6.2.2.4.1.2"><p id="aom_04_1013__p14876141115124">Message</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.3.6.2.2.4.1.3"><p id="aom_04_1013__p1687631110123">Solution</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="aom_04_1013__row148771811151216"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p087618117126">AOM.0001</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p5888134143415">Invalid request parameter.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p11876151161211">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row12878711151219"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p12878151151217">AOM.0002</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p18888124117343">Invalid namespace.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p1587810111126">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row1787811111214"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p48782011121215">AOM.0003</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p168891241133413">Dimensions are left blank.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p15878411161210">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row1987812113121"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p1387818115127">AOM.0005</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p158891041113416">Invalid metric data type.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p14878181141217">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row1187971116125"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p487812113120">AOM.0006</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p2088910413344">The metric data value is left blank.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p18879151181218">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row16879181115128"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p118794116128">AOM.0007</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p1488994111343">Invalid name or value length in the dimension.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p19879111114127">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row128792110126"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p1087961117129">AOM.0008</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p11889184110346">The request exceeds 40 KB.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p68791611151214">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row887931191214"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p587941131214">AOM.0009</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p11889134153416">A metric supports a maximum of 20 dimensions.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p1879161161212">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row1687961171220"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p158798112127">AOM.0010</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p688974173410">Invalid collection time.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p6879131181220">Check whether the parameter meets requirements.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="aom_04_1013__row16880411161212"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1013__p98801411181217">AOM.0500</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1013__p15889104117342">Internal server error.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1013__p1888051131215">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>
|
||
|