Compare commits
136 Commits
gtema-patc
...
ims_api_04
| Author | SHA1 | Date | |
|---|---|---|---|
| 7b69c0fd5b | |||
| ef0114d1cb | |||
| 9dc3cf685a | |||
| caf6a13046 | |||
| a08f68fbc7 | |||
| a6e2b5f473 | |||
| 00887d3d3c | |||
| 32b9354795 | |||
| a80bb7d522 | |||
| 31704f0318 | |||
| b920308ce6 | |||
| 3878697a01 | |||
| 3ddd15d9ee | |||
| 3afe914820 | |||
| bf0cbd66f9 | |||
| 0c90df93b1 | |||
| e00cefc755 | |||
| 5a1135747c | |||
| 5b5876528a | |||
| 70c0715827 | |||
| f15f2de664 | |||
| f173c9af19 | |||
| c24a3e0de3 | |||
| f8abb220af | |||
| 2374069890 | |||
| eda19245f1 | |||
| 4a12a1caba | |||
| bdd7833dbb | |||
| 2ce2f88b51 | |||
| a217e13b31 | |||
| 5eee175e13 | |||
| 5b28b6b590 | |||
| 90a67c482c | |||
| d2cf04063e | |||
| c4a04d1412 | |||
| 58b2c5fa4f | |||
| e721f171fe | |||
| d84e24d182 | |||
| 245e895951 | |||
| 8b0d556fba | |||
| 9b080603e7 | |||
| c4bbd6f5f5 | |||
| 14be84ba51 | |||
| 1ad28cc33e | |||
| 24b2a3635e | |||
| ca474a9a73 | |||
| 00fefcaaba | |||
| c4cb455200 | |||
| 5838e911a2 | |||
| 4e812dec9e | |||
| c8d7a6f7c1 | |||
| 6edd5bfe3a | |||
| 7492b7b30f | |||
| 55786917ca | |||
| 65bcfb9cda | |||
| 9e0bcb70c6 | |||
| 2cf321eb3d | |||
| 1a76d1b3b4 | |||
| 14f2171339 | |||
| a64ca9cc06 | |||
| 37582ed59f | |||
| b421d4c681 | |||
| 1b372eb4c2 | |||
| 55da809bbb | |||
| 9506c3feb1 | |||
| 0749423d6d | |||
| b55a939a8a | |||
| f3b09e5d2f | |||
| f37f5291ef | |||
| 894279c39a | |||
| cfec39ba1b | |||
| 313c8b6ba0 | |||
| beb52111d9 | |||
| 6a0fb20d02 | |||
| a98e12fea0 | |||
| 3f5759eed2 | |||
| a24ca60074 | |||
| a037336b6b | |||
| 60010eb9d0 | |||
| 05f2df2618 | |||
| 256e58e5d1 | |||
| 21e968a153 | |||
| 79b1bc1455 | |||
| b1e6b7227a | |||
| 4194b50d78 | |||
| 894de44a4e | |||
| b24bb72138 | |||
| c5fcb46315 | |||
| 3b1f73dece | |||
| 8682f10aa4 | |||
| 558bee8536 | |||
| b974c4b77e | |||
| ea05d1a734 | |||
| 50686af1a0 | |||
| 96aa3747dc | |||
| 5e34f6ce26 | |||
| 6182f91ba8 | |||
| 14be087a3b | |||
| 947c3381e0 | |||
| 54b39691a8 | |||
| 901ea67b42 | |||
| e227be9021 | |||
| 5523220f09 | |||
| 82285f686d | |||
| 7f68b84da4 | |||
| dd8a3a658b | |||
| 5bdbeeee8c | |||
| f6f2ca6fa5 | |||
| 6b71b4a1fa | |||
| 99eb66ab8a | |||
| 7ae2eeb5f1 | |||
| a044aa42ec | |||
| a810508850 | |||
| 78c80b1b46 | |||
| db3ca7e730 | |||
| 66a9aa2aa1 | |||
| 354bef10dd | |||
| 9a315f235c | |||
| a3ce99ce37 | |||
| 4ab0cf8c88 | |||
| 255730fbf9 | |||
| d849643c68 | |||
| 46435e6aee | |||
| bbf8757cdf | |||
| 0c9f4e49a3 | |||
| 04da47cae2 | |||
| ec78a6ee8e | |||
| 48118813e5 | |||
| 231618c804 | |||
| 89ea9efbc6 | |||
| a8436b1d56 | |||
| c483984844 | |||
| 519944c837 | |||
| 630e17b453 | |||
| c5ad20504f | |||
| 6ffc35f074 |
5
.gitignore
vendored
@ -134,6 +134,11 @@ dmypy.json
|
||||
**/temp/
|
||||
**/tmp_result/
|
||||
|
||||
.stestr/
|
||||
|
||||
# Some people build submodule because of not understanding git basics
|
||||
doc-exports
|
||||
|
||||
# Drop userless content of the docs
|
||||
docs/**/*.js
|
||||
docs/**/*.css
|
||||
|
||||
3
.stestr.conf
Normal file
@ -0,0 +1,3 @@
|
||||
[DEFAULT]
|
||||
test_path=./otc_doc_convertor/tests/unit
|
||||
top_dir=./
|
||||
182
docs/aom/api-ref/ALL_META.TXT.json
Normal file
164
docs/aom/api-ref/CLASS.TXT.json
Normal file
3
docs/aom/api-ref/PARAMETERS.txt
Normal file
@ -0,0 +1,3 @@
|
||||
version=""
|
||||
language="en-us"
|
||||
type=""
|
||||
8
docs/aom/api-ref/aom_04_0000.html
Normal file
@ -0,0 +1,8 @@
|
||||
<a name="aom_04_0000"></a><a name="aom_04_0000"></a>
|
||||
|
||||
<h1 class="topictitle1">API Usage Guidelines</h1>
|
||||
<div id="body8662426"><p id="aom_04_0000__en-us_topic_0175303967_p7933938392">Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://<em id="aom_04_0000__en-us_topic_0175303967_i193313381196">Endpoint/uri</em>. In the URL, <em id="aom_04_0000__en-us_topic_0175303967_i193311389910">uri</em> indicates the resource path, that is, the API access path.</p>
|
||||
<p id="aom_04_0000__en-us_topic_0175303967_p39330381094">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by <strong id="aom_04_0000__en-us_topic_0175303967_b49339387910">Application/json</strong>.</p>
|
||||
<p id="aom_04_0000__en-us_topic_0175303967_p139331638999">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
|
||||
</div>
|
||||
|
||||
72
docs/aom/api-ref/aom_04_0008.html
Normal file
@ -0,0 +1,72 @@
|
||||
<a name="aom_04_0008"></a><a name="aom_04_0008"></a>
|
||||
|
||||
<h1 class="topictitle1">Common Request Headers</h1>
|
||||
<div id="body8662426">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_table64174151155930" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common request headers</caption><thead align="left"><tr id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_row18821928155930"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.1.2.5.1.1"><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p30977633155930">Name</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.1.2.5.1.2"><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p26160330155930">Description</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.1.2.5.1.3"><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p38611984155930">Mandatory</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.1.2.5.1.4"><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p40562970155930">Example</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_row43118600102939"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.1 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p18086042102942">X-Auth-Token</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.2 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p55683299102942">User token.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.3 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p59371788102942">Yes for token-based authentication</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.4 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p886047511">-</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_row5739337155930"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.1 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p9459319141229">Content-Type</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.2 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p65029354141258">Content type,</p>
|
||||
<p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p32709868141244">which is <strong id="aom_04_0008__en-us_topic_0096010422_b84235270695515">application/json;charset=utf-8</strong>.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.3 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p15183231141236">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.4 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p63820878155930">application/json;charset=utf8</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_row48630036141920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.1 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p11407824141920">x-sdk-date</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.2 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p51618533141920">Time to send a request,</p>
|
||||
<p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p61913619141920">which is in the format of YYYYMMDD'T'HHMMSS'Z'. GMT time is used.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.3 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p37871689141920">Yes for Access Key ID/Secret Access Key (AK/SK)-based authentication</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.4 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p47708008141920">20160629T101459Z</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_row35229499141920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.1 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p16746930141920">Authorization</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.2 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p14324105141920">Signature authentication information,</p>
|
||||
<p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p61808088141920">which is obtained from the result of request signing.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.3 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p51113090141920">Yes for AK/SK-based authentication</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.4 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p46519660141920">-</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_row3914388141920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.1 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p22856425141920">Host</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.2 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p39431107141920">Request server information, which is obtained from the URL of a service API. The value is <strong id="aom_04_0008__en-us_topic_0096010422_b84235270612057">hostname[:port]</strong>. If no port is specified, the default port will be used. For HTTPS, port 443 is used by default.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.3 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p22683417141920">Yes for AK/SK-based authentication</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.2.5.1.4 "><p id="aom_04_0008__en-us_topic_0096010422_en-us_topic_0095259731_en-us_topic_0073180055_p25417485141920">-</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0066.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
51
docs/aom/api-ref/aom_04_0009.html
Normal file
@ -0,0 +1,51 @@
|
||||
<a name="aom_04_0009"></a><a name="aom_04_0009"></a>
|
||||
|
||||
<h1 class="topictitle1">Common Response Headers</h1>
|
||||
<div id="body8662426"><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p5023366916959">A response usually contains the following headers:</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_table431633395935" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response headers</caption><thead align="left"><tr id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_row5838132395935"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.4.1.1"><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p2208706210115">Name</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.4.1.2"><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p4259252810115">Description</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.4.1.3"><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p4178727010115">Example</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_row1643024095935"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.1 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p4152229495935">Date</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.2 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p4057779095935">(Standard HTTP header) Time when a message is sent. This field complies with RFC822 definitions.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.3 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p3667485695935">Mon, 12 Nov 2007 15:55:01 GMT</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_row6136471495935"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.1 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p306646695935">Server</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.2 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p6297619295935">(Standard HTTP header) Software that a server uses to process the request.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.3 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p2988296795935">Apache</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_row5278388395935"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.1 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p3816840495935">Content-Length</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.2 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p4460423795935">(Standard HTTP header) Length of the response body, which is represented by a decimal number and stored in bytes.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.3 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p1291061195935">xxx</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_row6263177095935"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.1 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p4341350695935">Content-Type</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.2 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p1726003895935">(Standard HTTP header) Media type of the response body sent to the recipient.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.4.1.3 "><p id="aom_04_0009__en-us_topic_0096010423_en-us_topic_0095259732_en-us_topic_0073180020_p940161295935">application/json</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0066.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
329
docs/aom/api-ref/aom_04_0018.html
Normal file
25
docs/aom/api-ref/aom_04_0020.html
Normal file
@ -0,0 +1,25 @@
|
||||
<a name="aom_04_0020"></a><a name="aom_04_0020"></a>
|
||||
|
||||
<h1 class="topictitle1">Change History</h1>
|
||||
<div id="body8662426">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_0020__table362916194354" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Change history</caption><thead align="left"><tr id="aom_04_0020__row66291119183510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.1.2.3.1.1"><p id="aom_04_0020__p77401240133520">Released On</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="80%" id="mcps1.3.1.2.3.1.2"><p id="aom_04_0020__p1574014400350">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="aom_04_0020__row894213871211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.3.1.1 "><p id="aom_04_0020__p10571154091215">2022-09-29</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.1.2.3.1.2 "><ul id="aom_04_0020__ul36282371325"><li id="aom_04_0020__li664333912217">Deleted the description of auto scaling APIs.</li><li id="aom_04_0020__li2628143717213">Optimized the solution description for error codes.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="aom_04_0020__row812920293715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.3.1.1 "><p id="aom_04_0020__p19397323789">2020-12-31</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.1.2.3.1.2 "><p id="aom_04_0020__p639719231788">This issue is the first official release.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
15
docs/aom/api-ref/aom_04_0066.html
Normal file
@ -0,0 +1,15 @@
|
||||
<a name="aom_04_0066"></a><a name="aom_04_0066"></a>
|
||||
|
||||
<h1 class="topictitle1">Appendix</h1>
|
||||
<div id="body1559812915770"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="aom_04_0018.html">Status Codes</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_0008.html">Common Request Headers</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_0009.html">Common Response Headers</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
13
docs/aom/api-ref/aom_04_1010.html
Normal file
@ -0,0 +1,13 @@
|
||||
<a name="aom_04_1010"></a><a name="aom_04_1010"></a>
|
||||
|
||||
<h1 class="topictitle1">APIs </h1>
|
||||
<div id="body1606983050194"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1045.html">Monitoring APIs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1047.html">Log APIs</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
410
docs/aom/api-ref/aom_04_1011.html
Normal file
431
docs/aom/api-ref/aom_04_1012.html
Normal file
429
docs/aom/api-ref/aom_04_1013.html
Normal file
518
docs/aom/api-ref/aom_04_1014.html
Normal file
322
docs/aom/api-ref/aom_04_1015.html
Normal file
263
docs/aom/api-ref/aom_04_1016.html
Normal file
227
docs/aom/api-ref/aom_04_1017.html
Normal file
517
docs/aom/api-ref/aom_04_1019.html
Normal file
573
docs/aom/api-ref/aom_04_1034.html
Normal file
29
docs/aom/api-ref/aom_04_1045.html
Normal file
@ -0,0 +1,29 @@
|
||||
<a name="aom_04_1045"></a><a name="aom_04_1045"></a>
|
||||
|
||||
<h1 class="topictitle1">Monitoring APIs</h1>
|
||||
<div id="body1606983050195"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1011.html">Querying Metrics</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1012.html">Querying Monitoring Data</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1013.html">Adding Monitoring Data</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1014.html">Adding a Threshold Rule</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1019.html">Modifying a Threshold Rule</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1015.html">Querying a Threshold Rule List</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1016.html">Querying a Threshold Rule</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1017.html">Deleting a Threshold Rule</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_1010.html">APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
15
docs/aom/api-ref/aom_04_1047.html
Normal file
@ -0,0 +1,15 @@
|
||||
<a name="aom_04_1047"></a><a name="aom_04_1047"></a>
|
||||
|
||||
<h1 class="topictitle1">Log APIs</h1>
|
||||
<div id="body1606983050446"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="aom_04_1034.html">Querying Logs</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_1010.html">APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
BIN
docs/aom/api-ref/public_sys-resources/caution_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/aom/api-ref/public_sys-resources/danger_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/aom/api-ref/public_sys-resources/delta.gif
Normal file
|
After Width: | Height: | Size: 836 B |
BIN
docs/aom/api-ref/public_sys-resources/deltaend.gif
Normal file
|
After Width: | Height: | Size: 834 B |
BIN
docs/aom/api-ref/public_sys-resources/icon-arrowdn.gif
Normal file
|
After Width: | Height: | Size: 68 B |
BIN
docs/aom/api-ref/public_sys-resources/icon-arrowrt.gif
Normal file
|
After Width: | Height: | Size: 70 B |
BIN
docs/aom/api-ref/public_sys-resources/icon-caution.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/aom/api-ref/public_sys-resources/icon-danger.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/aom/api-ref/public_sys-resources/icon-huawei.gif
Normal file
|
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/aom/api-ref/public_sys-resources/icon-note.gif
Normal file
|
After Width: | Height: | Size: 983 B |
BIN
docs/aom/api-ref/public_sys-resources/icon-notice.gif
Normal file
|
After Width: | Height: | Size: 962 B |
BIN
docs/aom/api-ref/public_sys-resources/icon-tip.gif
Normal file
|
After Width: | Height: | Size: 879 B |
BIN
docs/aom/api-ref/public_sys-resources/icon-warning.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/aom/api-ref/public_sys-resources/note_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/aom/api-ref/public_sys-resources/notice_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
BIN
docs/aom/api-ref/public_sys-resources/warning_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 3.1 KiB |
452
docs/aom/umn/ALL_META.TXT.json
Normal file
407
docs/aom/umn/CLASS.TXT.json
Normal file
3
docs/aom/umn/PARAMETERS.txt
Normal file
@ -0,0 +1,3 @@
|
||||
version=""
|
||||
language="en-us"
|
||||
type=""
|
||||
17
docs/aom/umn/aom_02_0001.html
Normal file
@ -0,0 +1,17 @@
|
||||
<a name="aom_02_0001"></a><a name="aom_02_0001"></a>
|
||||
|
||||
<h1 class="topictitle1">View Management</h1>
|
||||
<div id="body39451090"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="aom_02_0003.html">Dashboard</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_02_1117.html">Monitoring Metrics</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_06_6001.html">User Guide</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
121
docs/aom/umn/aom_02_0003.html
Normal file
35
docs/aom/umn/aom_02_0004.html
Normal file
@ -0,0 +1,35 @@
|
||||
<a name="aom_02_0004"></a><a name="aom_02_0004"></a>
|
||||
|
||||
<h1 class="topictitle1">Viewing Alarms</h1>
|
||||
<div id="body1534921092041"><p id="aom_02_0004__p812411178144">Alarms are the information reported when AOM or an external service such as Cloud Container Engine (CCE) is abnormal or may cause exceptions. Take measures to resolve faults. Otherwise, service exceptions may occur.</p>
|
||||
<div class="section" id="aom_02_0004__section1926111381416"><h4 class="sectiontitle">Viewing Alarms</h4><ol id="aom_02_0004__ol8214652112313"><li id="aom_02_0004__li637913444571"><span>Log in to the management console.</span></li><li id="aom_02_0004__li975084955716"><span>Under <strong id="aom_02_0004__b168042619214921">Application</strong>, click <strong id="aom_02_0004__b147816196914921">Application Operations Management</strong>.</span></li><li id="aom_02_0004__li14229814184718"><span>In the navigation pane, choose <strong id="aom_02_0004__b5435670814921">Alarm Center</strong> > <strong id="aom_02_0004__b115521198214921">Alarms</strong>.</span><p><div class="note" id="aom_02_0004__note1918716335019"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="aom_02_0004__ul318715325011"><li id="aom_02_0004__li1918793135016">Alarms are displayed by time. The alarm generated at the latest time is displayed at the topmost of the alarm list.</li><li id="aom_02_0004__li21871632508">You can also click <span><img id="aom_02_0004__image205362166314921" src="en-us_image_0297078492.png"></span> on the right of the page to view the latest three alarms.</li></ul>
|
||||
</div></div>
|
||||
</p></li><li id="aom_02_0004__li13952173133419"><a name="aom_02_0004__li13952173133419"></a><a name="li13952173133419"></a><span>Set the time range or filter criteria.</span><p><ol type="a" id="aom_02_0004__ol1745611179813"><li id="aom_02_0004__li145613171989">Set the time range.<p id="aom_02_0004__p14059147395"><a name="aom_02_0004__li145613171989"></a><a name="li145613171989"></a>View the alarms generated within the time range. There are two methods to set a time range:</p>
|
||||
<p id="aom_02_0004__p142140527235">Method 1: Use the predefined time label, such as <strong id="aom_02_0004__b47385016514921">Last 1 hour</strong>, <strong id="aom_02_0004__b112242967314921">Last 6 hours</strong>, or <strong id="aom_02_0004__b34703569014921">Last 1 day</strong>. You can select a time range as required.</p>
|
||||
<p id="aom_02_0004__p32141252202310">Method 2: Specify the start time and end time to customize a time range. You can specify 30 days at most.</p>
|
||||
</li><li id="aom_02_0004__li104561817187">Set filter criteria.<p id="aom_02_0004__p183764329490"><a name="aom_02_0004__li104561817187"></a><a name="li104561817187"></a>Enter an alarm status, name, or source, and click <strong id="aom_02_0004__b2658367414921">Search</strong>.</p>
|
||||
<div class="note" id="aom_02_0004__note16139143764920"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="aom_02_0004__ul830912446499"><li id="aom_02_0004__li1130913448491">You can click <strong id="aom_02_0004__b152003289114921">Reset</strong> to reset filter criteria.</li><li id="aom_02_0004__li11598517415">You can enter multiple alarm sources and separate them by using commas (,) to filter alarms.</li><li id="aom_02_0004__li930964411491">Alarm names and sources are case-sensitive.</li></ul>
|
||||
</div></div>
|
||||
</li></ol>
|
||||
</p></li><li id="aom_02_0004__li18949175018919"><span>View the search result.</span><p><ul id="aom_02_0004__ul83192527105"><li id="aom_02_0004__li125233875018">In the bar graph, view the statistics of alarms that meet the filter criterion within the time range specified in <a href="#aom_02_0004__li13952173133419">4</a>.<div class="fignone" id="aom_02_0004__fig49873214199"><span class="figcap"><b>Figure 1 </b>Alarm statistics</span><br><span><img id="aom_02_0004__image79881323191" src="en-us_image_0297078493.png" height="95.69416500000001" width="497.42" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</li><li id="aom_02_0004__li7187198195119">In the alarm list, view the information about alarms that meet the filter criterion within the time range specified in <a href="#aom_02_0004__li13952173133419">4</a>.<p id="aom_02_0004__p1218714825114">Click <strong id="aom_02_0004__b36050371914921">View Details</strong> in the <strong id="aom_02_0004__b185806114921">Operation</strong> column to view alarm details.</p>
|
||||
<div class="fignone" id="aom_02_0004__fig269717184186"><span class="figcap"><b>Figure 2 </b>Alarm list</span><br><span><img id="aom_02_0004__image5697201821813" src="en-us_image_0297078494.png" height="144.962419" width="497.42" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</li></ul>
|
||||
</p></li><li id="aom_02_0004__li06081945172013"><span>Clear alarms.</span><p><p id="aom_02_0004__p10134166345">In the <strong id="aom_02_0004__b185820980414921">Operation</strong> column of the target alarm, click <strong id="aom_02_0004__b11820451514921">Clear</strong>.</p>
|
||||
<p id="aom_02_0004__p1114175282011">In addition, AOM supports automatic clearance of alarms triggered by threshold rules. For example, you create a threshold rule. That is, if the CPU usage exceeds 85%, a threshold alarm will be generated. If the CPU usage is lower than 85%, the alarm will be cleared. In this case, you do not need to manually clear the alarm. When the CPU usage returns to normal, the threshold alarm will be automatically cleared. In addition, when the threshold rule is deleted, the threshold alarm will also be automatically cleared.</p>
|
||||
</p></li></ol>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_02_0044.html">Alarm Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
||||
36
docs/aom/umn/aom_02_0008.html
Normal file
@ -0,0 +1,36 @@
|
||||
<a name="aom_02_0008"></a><a name="aom_02_0008"></a>
|
||||
|
||||
<h1 class="topictitle1">Host Monitoring</h1>
|
||||
<div id="body1534930763573"><p id="aom_02_0008__en-us_topic_0201820731_p1119664285317">AOM monitors the resource usage and health status of hosts, common system devices such as disks and file systems of hosts, and service processes or instances running on hosts.</p>
|
||||
<div class="note" id="aom_02_0008__note1254015148448"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="aom_02_0008__p127962154520">The ICAgent reports resource information every ten minutes. The resource status changes are described as follows:</p>
|
||||
<ul id="aom_02_0008__ul145201634184519"><li id="aom_02_0008__li352019342459">If the ICAgent on a host does not report resource information <strong id="aom_02_0008__b1662263481615">for three consecutive times</strong>, the system determines that the resource has been deleted. Therefore, the host status is displayed as <strong id="aom_02_0008__b362713345167">Deleted</strong> within 30 minutes after the host is stopped or the ICAgent is uninstalled.</li><li id="aom_02_0008__li1180938164613">When the ICAgent on a host reports resource information <strong id="aom_02_0008__b4187103114147">for one time</strong>, the system determines that the resource is restored. The host status is displayed as <strong id="aom_02_0008__b141871031121417">Normal</strong> ten minutes after the host is started or the ICAgent is reinstalled.</li></ul>
|
||||
</div></div>
|
||||
<div class="section" id="aom_02_0008__section36211948143011"><h4 class="sectiontitle">Precautions</h4><ul id="aom_02_0008__ul18462456143015"><li id="aom_02_0008__li11424185817307">A maximum of five tags can be added to a host, and each tag must be unique.</li><li id="aom_02_0008__li169874438385">The same tag can be added to different hosts.</li><li id="aom_02_0008__li16931451411">For hosts created on the CCE or ServiceStage console, you cannot select clusters or create aliases for them.</li><li id="aom_02_0008__li4971161713200">The host status can be <strong id="aom_02_0008__b02581657142413">Normal</strong>, <strong id="aom_02_0008__b0258155722412">Abnormal</strong>, <strong id="aom_02_0008__b1125925717249">Warning</strong>, <strong id="aom_02_0008__b52596579245">Silent</strong>, or <strong id="aom_02_0008__b2034917306253">Deleted</strong>. The running status of a host is displayed as <strong id="aom_02_0008__b76997332019735">Abnormal</strong> when the host is faulty due to network failures, and power off or shut down of the host, or when the host generates a threshold alarm. If resources are not running properly, follow the instructions in <a href="aom_02_1012.html">What Can I Do If Resources Are Not Running Properly?</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="aom_02_0008__section4984135633115"><h4 class="sectiontitle">Procedure</h4><ol id="aom_02_0008__ol8452632743"><li id="aom_02_0008__li2396186125916"><span>Log in to the management console.</span></li><li id="aom_02_0008__li81851115911"><span>Under <strong id="aom_02_0008__b0727114451510">Application</strong>, click <strong id="aom_02_0008__b14727044131514">Application Operations Management</strong>.</span></li><li id="aom_02_0008__li65335398"><span>In the navigation pane, choose <strong id="aom_02_0008__b11409184514159">Host Monitoring</strong> and perform the following operations as required:</span><p><ul id="aom_02_0008__ul174529321747"><li id="aom_02_0008__li20452232348"><strong id="aom_02_0008__b1011114621510">Adding an alias</strong><p id="aom_02_0008__p84521232441">If a host name is too complex to identify, you can add an alias, which makes it easy to identify a host as required.</p>
|
||||
<p id="aom_02_0008__p15452203212410">In the host list, choose <strong id="aom_02_0008__b6936193161">More</strong> > <strong id="aom_02_0008__b159363915162">Add Alias</strong> in the <strong id="aom_02_0008__b10936293160">Operation</strong> column of a desired host.</p>
|
||||
</li><li id="aom_02_0008__li44521232743"><strong id="aom_02_0008__b69081123169">Adding a tag</strong><p id="aom_02_0008__p12452133210419">Tags are identifiers of hosts. You can manage hosts using tags. After a tag is added, you can quickly identify and select a host.</p>
|
||||
<p id="aom_02_0008__p16453153212414">In the host list, click <strong id="aom_02_0008__b469091471616">Add tags</strong> in the <strong id="aom_02_0008__b769015147164">Operation</strong> column of the row that contains the target host. In the displayed dialog box, click <span><img id="aom_02_0008__image23601514151613" src="en-us_image_0297092397.png"></span>, enter a tag, and click <span><img id="aom_02_0008__image510915563175" src="en-us_image_0297092398.png"></span> and <strong id="aom_02_0008__b86911314131618">OK</strong>. After a tag is added, you can enter a tag keyword in the search box in the upper right corner of the page to search for a host. The <strong id="aom_02_0008__b16548131891616">Tags</strong> column of the host list is hidden by default. You can click <span><img id="aom_02_0008__image1979915168144" src="en-us_image_0297092399.png"></span> in the upper right corner and select or deselect <strong id="aom_02_0008__b1549141816163">Show tag</strong>.</p>
|
||||
</li></ul>
|
||||
</p></li><li id="aom_02_0008__li44538323415"><span>Set filter criteria to search for the host to be monitored and monitor resource usage and health status of the host.</span><p><div class="fignone" id="aom_02_0008__fig8803427141720"><span class="figcap"><b>Figure 1 </b>Monitoring the resource usage and health status of the desired host</span><br><span><img id="aom_02_0008__image2803827181714" src="en-us_image_0297092400.png" height="33.915" width="523.6875" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</p></li><li id="aom_02_0008__li445310321418"><span>Click the host name to enter the <strong id="aom_02_0008__b113911920171614">Host Details</strong> page. In the instance list, monitor the resource usage and health status of the instances running on the host. Click the <strong id="aom_02_0008__b139118206166">View Monitor Graphs</strong> tab to monitor all the metrics of the host.</span><p><ul id="aom_02_0008__ul1177717441999"><li id="aom_02_0008__li6535321514"><strong id="aom_02_0008__b2407132131620">Creating a view template</strong><p id="aom_02_0008__p19535921019">AOM provides the default view template (<strong id="aom_02_0008__b467310223163">Host Template</strong>) that you can modify. You can also click the plus sign (+) in <span><img id="aom_02_0008__image109641941131213" src="en-us_image_0297092401.png"></span> to add you own template.</p>
|
||||
</li><li id="aom_02_0008__li7535821216"><strong id="aom_02_0008__b9839182481613">Adding a metric graph</strong><p id="aom_02_0008__p145353213114">You can click <span><img id="aom_02_0008__image115351321915" src="en-us_image_0297092402.png"></span> to add a line graph or <span><img id="aom_02_0008__image1953582118" src="en-us_image_0297092403.png"></span> to add a digit graph to the view template. You can also delete, move, and copy metric graphs in the view template according to <a href="aom_02_0003.html">Dashboard</a>.</p>
|
||||
</li><li id="aom_02_0008__li1535162010"><strong id="aom_02_0008__b116429992">Adding a view template to a dashboard</strong><p id="aom_02_0008__p1753510219112">On the host details page, choose <strong id="aom_02_0008__b833192026">More</strong> > <strong id="aom_02_0008__b1525855500">Add To Dashboard</strong> in the upper right corner to add the view template to a dashboard for monitoring.</p>
|
||||
</li></ul>
|
||||
</p></li><li id="aom_02_0008__li174539321340"><span>Monitor common system devices such as GPUs and NICs of the host.</span><p><ul id="aom_02_0008__ul945317328414"><li id="aom_02_0008__li14453123217411">Click the <strong id="aom_02_0008__b638138038">GPUs</strong> tab to view the basic information about the GPUs of the host. Click a GPU to monitor its metrics on the <strong id="aom_02_0008__b372677727">View Monitor Graphs</strong> page.</li><li id="aom_02_0008__li7454132642">Click the <strong id="aom_02_0008__b2048510289">NIC</strong> tab to view the basic information about the NICs of the host. Click a NIC to monitor its metrics on the <strong id="aom_02_0008__b948075976">View Monitor Graphs</strong> page.</li><li id="aom_02_0008__li74541632842">Click the <strong id="aom_02_0008__b1736571023">Disks</strong> tab to view the basic information about the disks of the host. Click a disk to monitor its metrics on the <strong id="aom_02_0008__b1760416721">View Monitor Graphs</strong> page.</li><li id="aom_02_0008__li104542321047">Click the <strong id="aom_02_0008__b1578552913166">File System</strong> tab to view the basic information about the file system of the host. Click a disk file partition to monitor its metrics on the <strong id="aom_02_0008__b0790529101617">View Monitor Graphs</strong> page.</li></ul>
|
||||
</p></li></ol>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_02_0048.html">Resource Monitoring</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
||||
36
docs/aom/umn/aom_02_0009.html
Normal file
@ -0,0 +1,36 @@
|
||||
<a name="aom_02_0009"></a><a name="aom_02_0009"></a>
|
||||
|
||||
<h1 class="topictitle1">Searching for Logs</h1>
|
||||
<div id="body1534921645538"><p id="aom_02_0009__p63443418">AOM enables you to quickly query logs, and use log source information and context to locate faults.</p>
|
||||
<ol id="aom_02_0009__ol9143273"><li id="aom_02_0009__li72081113014"><span>Log in to the management console.</span></li><li id="aom_02_0009__li17547135207"><span>Under <strong id="aom_02_0009__b1112018163012">Application</strong>, click <strong id="aom_02_0009__b71211416506">Application Operations Management</strong>.</span></li><li id="aom_02_0009__li1714210407316"><span>In the navigation pane, choose <strong id="aom_02_0009__b486841710019">Log</strong> <strong id="aom_02_0009__b13782121118250">Management</strong> > <strong id="aom_02_0009__b128681817109">Log Search</strong>.</span></li><li id="aom_02_0009__li21668983"><span>On the <strong id="aom_02_0009__b1222918323193">Log Search</strong> page, set filter criteria as prompted.</span><p><div class="note" id="aom_02_0009__note2045618441585"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ol type="a" id="aom_02_0009__ol788611114593"><li id="aom_02_0009__li178861411145920">You can search for logs by service, system, or host.<ul id="aom_02_0009__ul2634419013"><li id="aom_02_0009__li617802472717">For service logs, you can set filter criteria such as <strong id="aom_02_0009__b1078114914578">Cluster</strong>, <strong id="aom_02_0009__b9787164910575">Namespace</strong>, and <strong id="aom_02_0009__b20787249175714">Service</strong>. You can also click <strong id="aom_02_0009__b278719491570">Advanced Search</strong> and set filter criteria such as <strong id="aom_02_0009__b1178844917572">Instance</strong>, <strong id="aom_02_0009__b12788114935710">Host</strong>, and <strong id="aom_02_0009__b10788249195718">File Name</strong>, and choose whether to enable <strong id="aom_02_0009__b1278844985717">Hide System Service</strong>.</li><li id="aom_02_0009__li119186147">For system logs, you can set filter criteria such as <strong id="aom_02_0009__b122461026208">Cluster</strong> and <strong id="aom_02_0009__b52472026501">Host</strong>.</li><li id="aom_02_0009__li19841945540">For host logs, you can set filter criteria such as <strong id="aom_02_0009__b1966913271403">Cluster</strong> and <strong id="aom_02_0009__b64021613175714">IP Address</strong>.</li></ul>
|
||||
</li><li id="aom_02_0009__li111841514115915">Enter a keyword in the search box. Rules are as follows:<ul id="aom_02_0009__ul1645684417588"><li id="aom_02_0009__li174561044175813">Enter a case-sensitive keyword.</li><li id="aom_02_0009__li1245624465814">Enter a keyword for exact search. A keyword refers to a word between two adjacent delimiters.</li><li id="aom_02_0009__li1245634417580">Enter a keyword containing an asterisk (*) or a question mark (?) for fuzzy search. For example, enter <strong id="aom_02_0009__b171891936907">ER?OR</strong>, <strong id="aom_02_0009__b819016367010">*ROR</strong>, or <strong id="aom_02_0009__b1019033610016">ER*R</strong>.</li><li id="aom_02_0009__li545674410585">Enter a phrase for exact search. For example, enter <strong id="aom_02_0009__b741518318017">Start to refresh</strong> or <strong id="aom_02_0009__b542018312004">Start-to-refresh</strong>. Note that hyphens (-) are <a href="aom_02_0082.html">delimiters</a>.</li><li id="aom_02_0009__li44560440587">Enter a keyword containing AND (&&) or OR (||) for search. For example, enter <strong id="aom_02_0009__b12248143414014">query logs&&error*</strong> or <strong id="aom_02_0009__b10248834704">query logs||error</strong>.</li><li id="aom_02_0009__li131754480910">If no log is found, you are advised to narrow down the search scope and add an asterisk (*) before and after the keyword for fuzzy match.</li></ul>
|
||||
</li></ol>
|
||||
</div></div>
|
||||
</p></li><li id="aom_02_0009__li34212241"><a name="aom_02_0009__li34212241"></a><a name="li34212241"></a><span>View the search results of logs.</span><p><p id="aom_02_0009__p1777141917420">The search results are sorted based on the log collection time. The keywords in the search results are highlighted. </p>
|
||||
<p id="aom_02_0009__p6815132484415">By default, the descending order is used. You can click <span><img id="aom_02_0009__image14198155613451" src="en-us_image_0297092404.png"></span> in the <strong id="aom_02_0009__b5302185911457">Time</strong> column to change the order. <span><img id="aom_02_0009__image201441423194619" src="en-us_image_0297092725.png"></span> indicates the ascending order by time (that is, the latest log is displayed at the end). <span><img id="aom_02_0009__image8732105174613" src="en-us_image_0297092726.png"></span> indicates the descending order by time (that is, the latest log is displayed at the top).</p>
|
||||
<ol type="a" id="aom_02_0009__ol19728122"><li id="aom_02_0009__li43335374">Click <span><img id="aom_02_0009__image44761611173911" src="en-us_image_0227418531.png"></span> on the left of the log list to view details such as host IP address and source.</li><li id="aom_02_0009__li823995655615">AOM allows you to view the surrounding logs of a specified log by clicking <strong id="aom_02_0009__b756531192115">View Context</strong> in the <strong id="aom_02_0009__b957193117213">Operation</strong> column, facilitating fault locating. Therefore, you do not need to search for logs in raw files.<ul id="aom_02_0009__ul50321738"><li id="aom_02_0009__li50242460">In the <strong id="aom_02_0009__b24191230154415">Display Rows</strong> drop-down list, set the number of rows that display raw context data of the log.<div class="note" id="aom_02_0009__note49528960"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="aom_02_0009__p43107464">For example, select <strong id="aom_02_0009__b457322519454">200</strong> from the <strong id="aom_02_0009__b357312517452">Display Rows</strong> drop-down list.</p>
|
||||
<ul id="aom_02_0009__ul52422860"><li id="aom_02_0009__li2043692">If there are more than or equal to 100 logs printed prior to a log and more than or equal to 99 logs printed following the log, the preceding 100 logs and following 99 logs are displayed as the context.</li><li id="aom_02_0009__li18393235">If there are fewer than 100 logs (for example, 90) printed prior to a log and fewer than 99 logs (for example, 80) printed following the log, the preceding 90 logs and following 80 logs are displayed as the context.</li></ul>
|
||||
</div></div>
|
||||
</li><li class="subitemlist" id="aom_02_0009__li38551552422">Click <strong id="aom_02_0009__b842352706164356">Export Current Page</strong> to export displayed raw context data of the log to a local PC.</li></ul>
|
||||
</li></ol>
|
||||
<div class="note" id="aom_02_0009__note54004927"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="aom_02_0009__p16282296">To ensure that tenant hosts and services run properly, some components (for example, kube-dns) provided by the system will run on the tenant hosts. The logs of these components are also queried during tenant log query.</p>
|
||||
</div></div>
|
||||
</p></li><li id="aom_02_0009__li10229194714111"><span>(Optional) Click <span><img id="aom_02_0009__image179806362010" src="en-us_image_0297092727.png"></span> on the right of the <strong id="aom_02_0009__b44171351224">Log Search</strong> page, select an export format, and export the search result to a local PC.</span><p><p id="aom_02_0009__p13742134820119">Logs are sorted according to the order set in <a href="#aom_02_0009__li34212241">5</a> and a maximum of 5000 logs can be exported. For example, when 6000 logs in the search result are sorted in the descending order, only the first 5000 logs can be exported.</p>
|
||||
<p id="aom_02_0009__p3430230111313">Logs can be exported in CSV or TXT format. You can select a format as required. If you select the CSV format, detailed information (such as the log content, host IP address, and source) can be exported, as shown in <a href="#aom_02_0009__fig1785710409496">Figure 1</a>. Only log content will be exported when you select the TXT format (as shown in <a href="#aom_02_0009__fig9558111333018">Figure 2</a>). Each line indicates a log.</p>
|
||||
<div class="fignone" id="aom_02_0009__fig1785710409496"><a name="aom_02_0009__fig1785710409496"></a><a name="fig1785710409496"></a><span class="figcap"><b>Figure 1 </b>Exporting logs in CSV format</span><br><span><img id="aom_02_0009__image17858540134914" src="en-us_image_0297092728.png" height="74.8125" width="523.6875" title="Click to enlarge" class="imgResize"></span></div>
|
||||
<div class="fignone" id="aom_02_0009__fig9558111333018"><a name="aom_02_0009__fig9558111333018"></a><a name="fig9558111333018"></a><span class="figcap"><b>Figure 2 </b>Exporting logs in TXT format</span><br><span><img id="aom_02_0009__image7558413193019" src="en-us_image_0297092729.png" height="79.80000000000001" width="523.6875" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</p></li></ol>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_02_0054.html">Log Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
||||
138
docs/aom/umn/aom_02_0010.html
Normal file
32
docs/aom/umn/aom_02_0039.html
Normal file
@ -0,0 +1,32 @@
|
||||
<a name="aom_02_0039"></a><a name="aom_02_0039"></a>
|
||||
|
||||
<h1 class="topictitle1">Configuring VM Log Collection Paths</h1>
|
||||
<div id="body8662426"><p id="aom_02_0039__en-us_topic_0169698346_p9451651359">AOM can collect and display VM logs. VM refers to an Elastic Cloud Server (ECS) running Linux. Before collecting logs, configure a log collection path according to the following procedure.</p>
|
||||
<div class="section" id="aom_02_0039__en-us_topic_0169698346_section188528174444"><h4 class="sectiontitle">Prerequisites</h4><p id="aom_02_0039__en-us_topic_0169698346_p1740907555">You have installed the ICAgent on a VM according to <a href="aom_02_2012.html">Installing the ICAgent</a>. </p>
|
||||
</div>
|
||||
<div class="section" id="aom_02_0039__en-us_topic_0169698346_section0650147205514"><h4 class="sectiontitle">Precautions</h4><ul id="aom_02_0039__en-us_topic_0169698346_ul127115695413"><li id="aom_02_0039__en-us_topic_0169698346_li1434612187534">The ICAgent collects <strong id="aom_02_0039__en-us_topic_0169698346_b47261142131612">*.log</strong>, <strong id="aom_02_0039__en-us_topic_0169698346_b75811046181615">*.trace</strong>, and <strong id="aom_02_0039__en-us_topic_0169698346_b17465453191615">*.out</strong> log files only. For example, <strong id="aom_02_0039__en-us_topic_0169698346_b1062672020410">/opt/yilu/work/xig/debug_cpu.log</strong>.</li><li id="aom_02_0039__en-us_topic_0169698346_li24741354175011">Ensure that an absolute path of the log directory or file is configured and the path exists. For example, <strong id="aom_02_0039__en-us_topic_0169698346_b108911222302">/opt/yilu/work/xig</strong> or <strong id="aom_02_0039__en-us_topic_0169698346_b1461816914303">/opt/yilu/work/xig/debug_cpu.log</strong>.</li><li id="aom_02_0039__en-us_topic_0169698346_li8476854155018">The ICAgent does not collect log files from subdirectories. For example, the ICAgent does not collect log files from the <strong id="aom_02_0039__en-us_topic_0169698346_b373923710379">/opt/yilu/work/xig/debug</strong> subdirectory of <strong id="aom_02_0039__en-us_topic_0169698346_b1773953753714">/opt/yilu/work/xig</strong>.</li><li id="aom_02_0039__en-us_topic_0169698346_li166817595">A maximum of 20 log collection paths can be configured for a VM.</li><li id="aom_02_0039__li3336184010111">For ECSs in the same resource set, only the latest log collection configuration in the system will be used. AOM and LTS log collection configurations cannot take effect at the same time. For example, if you configure log collection paths in AOM for ECSs, the previous LTS collection configurations of all ECSs under the resource set become invalid.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="aom_02_0039__en-us_topic_0169698346_section18187161014116"><h4 class="sectiontitle">Procedure</h4><ol id="aom_02_0039__en-us_topic_0169698346_ol18682144114402"><li id="aom_02_0039__li177555413590"><span>Log in to the management console.</span></li><li id="aom_02_0039__li113591446145915"><span>Under <strong id="aom_02_0039__b9287666603453">Application</strong>, click <strong id="aom_02_0039__b15099776253453">Application Operations Management</strong>.</span></li><li id="aom_02_0039__li9899115915349"><span>In the navigation pane, choose <strong id="aom_02_0039__b20080378173453">Log Management</strong> > <strong id="aom_02_0039__b17803103173453">Path Configuration</strong>.</span></li><li id="aom_02_0039__en-us_topic_0169698346_li191014817485"><span>In the VM list, click <strong id="aom_02_0039__en-us_topic_0169698346_b11893103115376">Configure</strong> in the <strong id="aom_02_0039__en-us_topic_0169698346_b18894123113715">Operation</strong> column to configure one or more log collection paths for a VM.</span><p><div class="p" id="aom_02_0039__en-us_topic_0169698346_p6748151101613">You can use the paths automatically identified by the ICAgent or manually configure paths.<ul id="aom_02_0039__en-us_topic_0169698346_ul6557828164212"><li id="aom_02_0039__en-us_topic_0169698346_li1617516410478"><strong id="aom_02_0039__en-us_topic_0169698346_b594112620198">Using the paths automatically identified by the ICAgent</strong><p id="aom_02_0039__en-us_topic_0169698346_p141641868472">The ICAgent automatically scans the log files of your VM, and displays all the log files that have file handles and are suffixed with <strong id="aom_02_0039__en-us_topic_0169698346_b14828476182">.log</strong>, <strong id="aom_02_0039__en-us_topic_0169698346_b3642451181813">.trace</strong>, or <strong id="aom_02_0039__en-us_topic_0169698346_b47275514188">.out</strong> on the page.</p>
|
||||
<p id="aom_02_0039__en-us_topic_0169698346_p31061914182013">You can click <span><img id="aom_02_0039__en-us_topic_0169698346_image862314124916" src="en-us_image_0227418562.png"></span> in the <strong id="aom_02_0039__b12773175422214">Operation</strong> column to add a path automatically identified by the ICAgent to the log collection path list. To configure multiple paths, repeat this operation.</p>
|
||||
<div class="fignone" id="aom_02_0039__en-us_topic_0169698346_fig17711201993711"><span class="figcap"><b>Figure 1 </b>Using the paths automatically identified by the ICAgent</span><br><span><img id="aom_02_0039__image1578271218109" src="en-us_image_0297092742.png" width="492.1" height="239.09529700000002" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</li><li id="aom_02_0039__en-us_topic_0169698346_li13686152014313"><strong id="aom_02_0039__en-us_topic_0169698346_b321481144016">Manually configuring log collection paths</strong><p id="aom_02_0039__en-us_topic_0169698346_p470410123613">If the paths automatically identified by the ICAgent cannot meet your requirements, enter a log directory or file (for example, <strong id="aom_02_0039__b14971036183417">/opt/yilu/work/xig/debug_cpu.log</strong>) in the <strong id="aom_02_0039__b1866121944916">Log Collection Path</strong> text box, and then click <span><img id="aom_02_0039__en-us_topic_0169698346_image11989123315500" src="en-us_image_0227418562.png"></span> to add the path to the log collection path list. To configure multiple paths, repeat this operation.</p>
|
||||
<div class="fignone" id="aom_02_0039__en-us_topic_0169698346_fig729151074218"><span class="figcap"><b>Figure 2 </b>Manually configuring log collection paths</span><br><span><img id="aom_02_0039__image17469115831016" src="en-us_image_0297092743.png" width="492.1" height="259.197715" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</li></ul>
|
||||
</div>
|
||||
</p></li><li id="aom_02_0039__li63355523816"><span>Click <strong id="aom_02_0039__b7433937443453">OK</strong>.</span><p><p id="aom_02_0039__p153335520384">After a log collection path is configured, the ICAgent collects log files from the configured path. The collection takes about 1 minute. After log files are collected, choose <strong id="aom_02_0039__b11147490883453">Log Management</strong> > <strong id="aom_02_0039__b12725021383453">Log Files</strong> in the navigation pane and then click the <strong id="aom_02_0039__b11212954863453">Host</strong> tab to view the collected log files.</p>
|
||||
</p></li></ol>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_02_0054.html">Log Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
||||
19
docs/aom/umn/aom_02_0044.html
Normal file
@ -0,0 +1,19 @@
|
||||
<a name="aom_02_0044"></a><a name="aom_02_0044"></a>
|
||||
|
||||
<h1 class="topictitle1">Alarm Management</h1>
|
||||
<div id="body1534837896092"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="aom_02_0004.html">Viewing Alarms</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_02_0045.html">Viewing Events</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="aom_02_1035.html">Creating Threshold Rules</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_06_6001.html">User Guide</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||