vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/aom/api-ref/aom_04_1011.html
Hasko, Vladimir bbf8757cdf AOM API 0929 (recreate of #275) 
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>
2022-11-29 12:44:31 +00:00

411 lines
29 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<a name="aom_04_1011"></a><a name="aom_04_1011"></a>
<h1 class="topictitle1">Querying Metrics</h1>
<div id="body1606983050214"><div class="section" id="aom_04_1011__section13566355"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="aom_04_1011__p295566">This API is used to query the metrics that can be monitored in the system. You can specify the namespace, metric name, dimension, resource ID (format: <strong id="aom_04_1011__b8676939154918">resType_resId</strong>), start position, and maximum number of returned records in pagination queries. </p>
</div>
<div class="section" id="aom_04_1011__section54988338"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="aom_04_1011__p23940876">POST /v2/{project_id}/ams/metrics?type={type}&amp;limit={limit}&amp;start={start}</p>
<p class="msonormal" id="aom_04_1011__p14141296"><a href="#aom_04_1011__table186473594509">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="aom_04_1011__table186473594509"></a><a name="table186473594509"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1011__table186473594509" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="aom_04_1011__row50373246"><th align="left" class="cellrowborder" valign="top" width="32.65%" id="mcps1.3.2.4.2.4.1.1"><p id="aom_04_1011__p53701151">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_1011__p54826013">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_1011__p11722079">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1011__row9964366"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.4.2.4.1.1 "><p id="aom_04_1011__p1807313">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_1011__p12174673">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.86%" headers="mcps1.3.2.4.2.4.1.3 "><p id="aom_04_1011__p46624437">Project ID obtained from IAM. Generally, a project ID contains 32 characters.</p>
</td>
</tr>
<tr id="aom_04_1011__row16966752"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.4.2.4.1.1 "><p id="aom_04_1011__p32129686">type</p>
</td>
<td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.2.4.2.4.1.2 "><p id="aom_04_1011__p52367780">No</p>
</td>
<td class="cellrowborder" valign="top" width="42.86%" headers="mcps1.3.2.4.2.4.1.3 "><p id="aom_04_1011__p13931827">Metric query mode. The information carried by <strong id="aom_04_1011__b1267775545105154">metricItems</strong> in the request body is used to query metrics.</p>
</td>
</tr>
<tr id="aom_04_1011__row58277587"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.4.2.4.1.1 "><p id="aom_04_1011__p22864069">limit</p>
</td>
<td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.2.4.2.4.1.2 "><p id="aom_04_1011__p40050316">No</p>
</td>
<td class="cellrowborder" valign="top" width="42.86%" headers="mcps1.3.2.4.2.4.1.3 "><p id="aom_04_1011__p22850192">Maximum number of returned records. Value range: 1–1000. Default value: 1000.</p>
</td>
</tr>
<tr id="aom_04_1011__row38926264"><td class="cellrowborder" valign="top" width="32.65%" headers="mcps1.3.2.4.2.4.1.1 "><p id="aom_04_1011__p66019693">start</p>
</td>
<td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.2.4.2.4.1.2 "><p id="aom_04_1011__p45994902">No</p>
</td>
<td class="cellrowborder" valign="top" width="42.86%" headers="mcps1.3.2.4.2.4.1.3 "><p id="aom_04_1011__p34599580">Start position of a pagination query. The value is a non-negative integer.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="aom_04_1011__section25133000"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="aom_04_1011__p51102566"><strong id="aom_04_1011__b57269912">Request parameters</strong></p>
<p class="msonormal" id="aom_04_1011__p45667164"><a href="#aom_04_1011__table1221212122718">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="aom_04_1011__table1221212122718"></a><a name="table1221212122718"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1011__table1221212122718" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="aom_04_1011__row62039823"><th align="left" class="cellrowborder" valign="top" width="19.79%" id="mcps1.3.3.4.2.6.1.1"><p id="aom_04_1011__p59169766">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.5%" id="mcps1.3.3.4.2.6.1.2"><p id="aom_04_1011__p28021733">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.71%" id="mcps1.3.3.4.2.6.1.3"><p id="aom_04_1011__p55167925">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.6.1.4"><p id="aom_04_1011__p39416958">Value Range</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.6.1.5"><p id="aom_04_1011__p38656999">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1011__row39993016572"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.3.4.2.6.1.1 "><p id="aom_04_1011__p90171125719">metricItems</p>
</td>
<td class="cellrowborder" valign="top" width="12.5%" headers="mcps1.3.3.4.2.6.1.2 "><p id="aom_04_1011__p502165718">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.71%" headers="mcps1.3.3.4.2.6.1.3 "><p id="aom_04_1011__p160215573">Arrays</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.6.1.4 "><p id="aom_04_1011__p1521416579">See <a href="#aom_04_1011__table71641056115911">Table 3</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.6.1.5 "><p id="aom_04_1011__p202311574">If <strong id="aom_04_1011__b531492987105154">type</strong> (a URI parameter) is not <strong id="aom_04_1011__b159058607105154">inventory</strong>, the information carried by the array is used to query metrics.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="aom_04_1011__table71641056115911"></a><a name="table71641056115911"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1011__table71641056115911" frame="border" border="1" rules="all"><caption><b>Table 3 </b>metricItems parameters</caption><thead align="left"><tr id="aom_04_1011__row16166115655915"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.6.1.1"><p id="aom_04_1011__p41011842409">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.6.1.2"><p id="aom_04_1011__p11019428011">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.6.1.3"><p id="aom_04_1011__p18102042603">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.6.1.4"><p id="aom_04_1011__p19102342206">Value Range</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.6.1.5"><p id="aom_04_1011__p110204220010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1011__row51661856125917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.1 "><p id="aom_04_1011__p6782471318">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.2 "><p id="aom_04_1011__p18783157618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.3 "><p id="aom_04_1011__p17783872110">String</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.4 "><p id="aom_04_1011__p1578318718113">PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, CUSTOMMETRICS, and so on.</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.5 "><p id="aom_04_1011__p5783273119">Metric namespace.</p>
<p id="aom_04_1011__p4783871813">PAAS.CONTAINER: application metric.</p>
<p id="aom_04_1011__p77831178117">PAAS.NODE: node metric.</p>
<p id="aom_04_1011__p77831079118">PAAS.SLA: Service Level Agreement (SLA) metric. </p>
<p id="aom_04_1011__p11783572118">PAAS.AGGR: cluster metric.</p>
<p id="aom_04_1011__p078327113">CUSTOMMETRICS: custom metric.</p>
</td>
</tr>
<tr id="aom_04_1011__row5166656115917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.1 "><p id="aom_04_1011__p1578317711117">dimensions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.2 "><p id="aom_04_1011__p1378316719111">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.3 "><p id="aom_04_1011__p878416717117">Array</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.4 "><p id="aom_04_1011__p77843718113">-</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.5 "><p id="aom_04_1011__p97841876113">Metric dimension.</p>
<p id="aom_04_1011__p37841177110">dimensions.name: dimension name, such as clusterName, clusterId, appName, appID, deploymentName, podName, podID, containerName, or containerID.</p>
<p id="aom_04_1011__p207841771818">dimensions.value: dimension value, such as a specific application instance ID.</p>
</td>
</tr>
<tr id="aom_04_1011__row171665569593"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.1 "><p id="aom_04_1011__p11784167911">metricName</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.2 "><p id="aom_04_1011__p16784172113">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.3 "><p id="aom_04_1011__p47841671813">String</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.4 "><p id="aom_04_1011__p1078497618">1–1000 characters.</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.6.1.5 "><p id="aom_04_1011__p67841272115">Metric name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="aom_04_1011__p13501584343"><strong id="aom_04_1011__b1024195414120">Request headers</strong></p>
<p class="msonormal" id="aom_04_1011__p19248500157"><a href="#aom_04_1011__table17428844137">Table 4</a> describes the request headers.</p>
<div class="tablenoborder"><a name="aom_04_1011__table17428844137"></a><a name="table17428844137"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1011__table17428844137" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request headers</caption><thead align="left"><tr id="aom_04_1011__row1542824171318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.4.1.1"><p id="aom_04_1011__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_1011__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_1011__p1742816441311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1011__row1942834191319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.4.1.1 "><p id="aom_04_1011__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_1011__p464591643812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.8.2.4.1.3 "><p id="aom_04_1011__p156451416173813">User token obtained from IAM.</p>
</td>
</tr>
<tr id="aom_04_1011__row2428124181313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.4.1.1 "><p id="aom_04_1011__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_1011__p464631663813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.8.2.4.1.3 "><p id="aom_04_1011__p1464691683810">Content type, which is <strong id="aom_04_1011__b1189614646105154">application/json</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="aom_04_1011__p30356242"><strong id="aom_04_1011__b4770728">Example request</strong></p>
<p id="aom_04_1011__p116811412125913">(Query by namespace+appName+clusterName)</p>
<pre class="screen" id="aom_04_1011__screen15945484">/v2/{projectId}/ams/metrics
{
"metricItems": [
{
"namespace": "PAAS.CONTAINER",
"dimensions":[
{
"name":"appName",
"value":"demo"
},
{
"name":"clusterName",
"value":"test"
}
]
}
]
}</pre>
</div>
<div class="section" id="aom_04_1011__section24870414"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="aom_04_1011__p16515789"><strong id="aom_04_1011__b14424376">Response parameters</strong></p>
<p class="msonormal" id="aom_04_1011__p62710527"><a href="#aom_04_1011__table6943113915268">Table 5</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="aom_04_1011__table6943113915268"></a><a name="table6943113915268"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1011__table6943113915268" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameters</caption><thead align="left"><tr id="aom_04_1011__row49770795"><th align="left" class="cellrowborder" valign="top" width="29.592959295929592%" id="mcps1.3.4.4.2.4.1.1"><p id="aom_04_1011__p4902603">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_1011__p61566543">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_1011__p20834080">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1011__row9838885"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1011__p58752198">errorCode</p>
</td>
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1011__p61307629">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1011__p7859755144511">Response code. Example: AOM.0200, which indicates a success response.</p>
</td>
</tr>
<tr id="aom_04_1011__row65867005"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1011__p33627165">errorMessage</p>
</td>
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1011__p39445854">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1011__p40997607">Response message.</p>
</td>
</tr>
<tr id="aom_04_1011__row29523177"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1011__p42567097">metrics</p>
</td>
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1011__p25382805">JSON array</p>
</td>
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1011__p42741350">List of metrics.</p>
</td>
</tr>
<tr id="aom_04_1011__row49127838"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1011__p19931961">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1011__p3876157">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1011__p45533264">Namespace.</p>
</td>
</tr>
<tr id="aom_04_1011__row7146200"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1011__p41971336">metricName</p>
</td>
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1011__p44235036">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1011__p26268157">Metric name.</p>
</td>
</tr>
<tr id="aom_04_1011__row35086821"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1011__p23460259">unit</p>
</td>
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1011__p21232866">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1011__p42140618">Metric unit.</p>
</td>
</tr>
<tr id="aom_04_1011__row43721244"><td class="cellrowborder" valign="top" width="29.592959295929592%" headers="mcps1.3.4.4.2.4.1.1 "><p id="aom_04_1011__p51759891">dimensions</p>
</td>
<td class="cellrowborder" valign="top" width="36.733673367336735%" headers="mcps1.3.4.4.2.4.1.2 "><p id="aom_04_1011__p8634594">JSON array</p>
</td>
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.4.2.4.1.3 "><p id="aom_04_1011__p25798559">List of metric dimensions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="aom_04_1011__p30860444"><strong id="aom_04_1011__b9308548">Example response</strong></p>
<pre class="screen" id="aom_04_1011__screen5755517165818">{
"errorCode": "AOM.0200",
"errorMessage": "success",
"metrics": [{
"namespace": "abc",
"metricName": "cpuUsage",
"unit":"Percent",
"dimensions": [{
"name": "instance_id",
"value": "demo1"
}]
}]
}</pre>
</div>
<div class="section" id="aom_04_1011__section22507142"><h4 class="sectiontitle">Status Code</h4><ul id="aom_04_1011__ul64578178"><li id="aom_04_1011__li44332693">Success response<p id="aom_04_1011__p63449920"><a name="aom_04_1011__li44332693"></a><a name="li44332693"></a><a href="#aom_04_1011__table86491459125016">Table 6</a> describes the status code.</p>
<div class="tablenoborder"><a name="aom_04_1011__table86491459125016"></a><a name="table86491459125016"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1011__table86491459125016" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status code</caption><thead align="left"><tr id="aom_04_1011__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_1011__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_1011__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_1011__p17060819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1011__row39749137"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="aom_04_1011__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_1011__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_1011__p19579466497">The request has succeeded.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="aom_04_1011__ul14309333"><li id="aom_04_1011__li61675141">Error response<p id="aom_04_1011__p18205362"><a name="aom_04_1011__li61675141"></a><a name="li61675141"></a><a href="#aom_04_1011__table7649145915013">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_1011__table7649145915013"></a><a name="table7649145915013"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1011__table7649145915013" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Status codes</caption><thead align="left"><tr id="aom_04_1011__row13716216"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.3.1.2.2.4.1.1"><p id="aom_04_1011__p37271751">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_1011__p71702038162316">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_1011__p66221887">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1011__row62372615"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1011__p19017031">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_1011__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_1011__p2431727192515">The request is invalid.</p>
<p id="aom_04_1011__p34352717254">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="aom_04_1011__row38990060"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1011__p4078305">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_1011__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_1011__p1371123810254">The authorization information provided by the client is incorrect or invalid.</p>
</td>
</tr>
<tr id="aom_04_1011__row20294558"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1011__p33246481">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_1011__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_1011__p10447844263">The request is rejected.</p>
<p id="aom_04_1011__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_1011__row10384848"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1011__p35866396">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_1011__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_1011__p1815584516269">The server is able to receive the request but unable to understand the request.</p>
</td>
</tr>
<tr id="aom_04_1011__row41254657"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.1.2.2.4.1.1 "><p id="aom_04_1011__p53292943">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_1011__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_1011__p4668115672614">The requested service is invalid. </p>
<p id="aom_04_1011__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_1011__section1031718191744"><h4 class="sectiontitle">Error Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_1011__table19843152719510" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Error codes</caption><thead align="left"><tr id="aom_04_1011__row88441927656"><th align="left" class="cellrowborder" valign="top" width="33.36333633363336%" id="mcps1.3.6.2.2.4.1.1"><p id="aom_04_1011__p1664218538510">Error Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.3033303330333%" id="mcps1.3.6.2.2.4.1.2"><p id="aom_04_1011__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_1011__p18642145310513">Solution</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_1011__row68442272514"><td class="cellrowborder" valign="top" width="33.36333633363336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1011__p1523916469">AOM.0101</p>
</td>
<td class="cellrowborder" valign="top" width="33.3033303330333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1011__p7221141155112">Invalid namespace.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1011__p13238161362">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1011__row138447276513"><td class="cellrowborder" valign="top" width="33.36333633363336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1011__p19242160616">AOM.0102</p>
</td>
<td class="cellrowborder" valign="top" width="33.3033303330333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1011__p142213175114">Invalid inventoryId.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1011__p3245164618">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1011__row1384414271159"><td class="cellrowborder" valign="top" width="33.36333633363336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1011__p324716167">AOM.0103</p>
</td>
<td class="cellrowborder" valign="top" width="33.3033303330333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1011__p92221117511">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_1011__p02441616618">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1011__row084552711518"><td class="cellrowborder" valign="top" width="33.36333633363336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1011__p5246161069">AOM.0105</p>
</td>
<td class="cellrowborder" valign="top" width="33.3033303330333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1011__p15222814515">Invalid limit.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1011__p42441615616">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1011__row128451727759"><td class="cellrowborder" valign="top" width="33.36333633363336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1011__p42571620614">AOM.0106</p>
</td>
<td class="cellrowborder" valign="top" width="33.3033303330333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1011__p0222201145110">Invalid start.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1011__p192517161867">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1011__row18845127251"><td class="cellrowborder" valign="top" width="33.36333633363336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1011__p14252163614">AOM.0109</p>
</td>
<td class="cellrowborder" valign="top" width="33.3033303330333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1011__p92229155116">Invalid metricName.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1011__p16253162066">Check whether the parameter meets requirements.</p>
</td>
</tr>
<tr id="aom_04_1011__row14473432564"><td class="cellrowborder" valign="top" width="33.36333633363336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1011__p1223111615613">AOM.0501</p>
</td>
<td class="cellrowborder" valign="top" width="33.3033303330333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1011__p1422214155111">The Cassandra session 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_1011__p182312160618">Contact technical support.</p>
</td>
</tr>
<tr id="aom_04_1011__row1722913364195"><td class="cellrowborder" valign="top" width="33.36333633363336%" headers="mcps1.3.6.2.2.4.1.1 "><p id="aom_04_1011__p10230123610195">AOM.0502</p>
</td>
<td class="cellrowborder" valign="top" width="33.3033303330333%" headers="mcps1.3.6.2.2.4.1.2 "><p id="aom_04_1011__p1423133641916">The Cassandra execution is abnormal.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.2.4.1.3 "><p id="aom_04_1011__p1223193671919">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>
View Git Blame Copy Permalink