1
0
forked from docs/doc-exports

AOM API 20230612 version

Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
This commit is contained in:
Liu, Siying 2024-03-25 12:19:25 +00:00 committed by zuul
parent b55201d729
commit a5523910b0
50 changed files with 11870 additions and 3881 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,8 +0,0 @@
<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>

View File

@ -0,0 +1,16 @@
<a name="aom_04_0010"></a><a name="aom_04_0010"></a>
<h1 class="topictitle1">API</h1>
<div id="body0000001224067457"><p id="aom_04_0010__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="aom_04_0045.html">Monitoring</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="aom_04_0047.html">Log</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="aom_04_0079.html">Alarm</a></strong><br>
</li>
</ul>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -1,7 +1,7 @@
<a name="aom_04_0018"></a><a name="aom_04_0018"></a>
<h1 class="topictitle1">Status Codes</h1>
<div id="body1530238060027"><p id="aom_04_0018__p16241847101017"><a href="#aom_04_0018__table1722512133292">Table 1</a> describes the status codes.</p>
<div id="body1530238060027"><p id="aom_04_0018__p16241847101017"><a href="#aom_04_0018__table1722512133292">Table 1</a> describes status codes.</p>
<div class="tablenoborder"><a name="aom_04_0018__table1722512133292"></a><a name="table1722512133292"></a><table cellpadding="4" cellspacing="0" summary="" id="aom_04_0018__table1722512133292" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Status codes</caption><thead align="left"><tr id="aom_04_0018__row722616136295"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.4.1.1"><p id="aom_04_0018__p104791012203212">Status Code</p>
</th>

View File

@ -2,13 +2,19 @@
<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>
<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 align="left" class="cellrowborder" valign="top" width="80%" id="mcps1.3.1.2.3.1.2"><p id="aom_04_0020__p1574014400350">Change History</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>
<tbody><tr id="aom_04_0020__row144901132165118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.3.1.1 "><p id="aom_04_0020__p2049163255116">2024-02-29</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.1.2.3.1.2 "><ul id="aom_04_0020__ul20314143515523"><li id="aom_04_0020__li82587171201">Added the following sections:<ul id="aom_04_0020__ul54572192208"><li id="aom_04_0020__li3105194119449"><a href="aom_04_0061.html">Permissions Policies and Supported Actions</a></li><li id="aom_04_0020__li1445781912203"><a href="ListEvents.html">Querying Events and Alarms</a></li><li id="aom_04_0020__li124572195204"><a href="CountEvents.html">Counting Events and Alarms</a></li><li id="aom_04_0020__li164571219122012"><a href="PushEvents.html">Reporting Events and Alarms</a></li></ul>
</li><li id="aom_04_0020__li8931203614523">Optimized the API description in sections <a href="aom_04_0045.html">Monitoring</a> and <a href="aom_04_0079.html">Alarm</a>.</li><li id="aom_04_0020__li1631403555216">Optimized the description of <a href="ErrorCode.html">error codes</a>.</li></ul>
</td>
</tr>
<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>

View File

@ -0,0 +1,21 @@
<a name="aom_04_0022"></a><a name="aom_04_0022"></a>
<h1 class="topictitle1">Introduction</h1>
<div id="body1559812915761"><p id="aom_04_0022__p938352352619">This section describes fine-grained permissions management for AOM. If your cloud account does not need individual IAM users, then you may skip over this section.</p>
<p id="aom_04_0022__p17427911182613">By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign permissions policies or roles to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on AOM.</p>
<p id="aom_04_0022__p229613233120">You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="aom_04_0022__note1496253611213"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="aom_04_0022__p48314468494">Policy-based authorization is recommended if you want to allow or deny the access to an API.</p>
</div></div>
<p id="aom_04_0022__p1638432332613">Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions can call the API successfully. For example, if an IAM user queries metrics using an API, the user must have been granted permissions that allow the <strong id="aom_04_0022__b42169197507">aom:metric:get</strong> action.</p>
<div class="section" id="aom_04_0022__section92561023162611"><h4 class="sectiontitle">Supported Actions</h4><p id="aom_04_0022__p472194771317">There are two kinds of policies: system-defined policies and custom policies. If the permissions preset in the system do not meet your requirements, you can create custom policies and apply these policies to user groups for refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<ul id="aom_04_0022__ul203844233261"><li id="aom_04_0022__li1238510235266">Permissions: Defined by actions in a custom policy.</li><li id="aom_04_0022__li93859235269">APIs: REST APIs that can be called in a custom policy.</li><li id="aom_04_0022__li23851123162612">Actions: Added to a custom policy to control permissions for specific operations.</li><li id="aom_04_0022__li1938519234267">IAM projects and enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. </li></ul>
<p id="aom_04_0022__p1938502372612">AOM supports the following actions that can be defined in custom policies:</p>
<ul id="aom_04_0022__ul1738511230262"><li id="aom_04_0022__li3722165913415"><a href="aom_04_0062.html">Monitoring Actions</a>: includes the actions supported by monitoring APIs, such as the APIs for querying metrics and monitoring data.</li><li id="aom_04_0022__li11207134118336"><a href="aom_04_0064.html">Log Actions</a>: includes the actions supported by log APIs, such as the API for querying logs.</li><li id="aom_04_0022__li15341440155414"><a href="aom_04_0065.html">Alarm Actions</a>: includes the actions supported by alarm APIs, such as the API for querying events and alarms.</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0061.html">Permissions Policies and Supported Actions</a></div>
</div>
</div>

View File

@ -0,0 +1,42 @@
<a name="aom_04_0045"></a><a name="aom_04_0045"></a>
<h1 class="topictitle1">Monitoring</h1>
<div><p> </p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ListSeries.html">Querying Time Series Objects</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ListSample.html">Querying Time Series Data</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ListMetricItems.html">Querying Metrics</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ShowMetricsData.html">Querying Monitoring Data</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="aom_04_0013.html">Adding Monitoring Data</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="AddOrUpdateServiceDiscoveryRules.html">Adding or Modifying One or More Service Discovery Rules</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="DeleteserviceDiscoveryRules.html">Deleting a Service Discovery Rule</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ListServiceDiscoveryRules.html">Querying Existing Service Discovery Rules</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="AddAlarmRule.html">Adding a Threshold Rule</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ListAlarmRule.html">Querying the Threshold Rule List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="UpdateAlarmRule.html">Modifying a Threshold Rule</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="DeleteAlarmRule.html">Deleting a Threshold Rule</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ShowAlarmRule.html">Querying a Threshold Rule</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="DeleteAlarmRules.html">Deleting Threshold Rules in Batches</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0010.html">API</a></div>
</div>
</div>

View File

@ -0,0 +1,16 @@
<a name="aom_04_0047"></a><a name="aom_04_0047"></a>
<h1 class="topictitle1">Log</h1>
<div><p> </p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ListLogItems.html">Querying Logs</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0010.html">API</a></div>
</div>
</div>

View File

@ -0,0 +1,17 @@
<a name="aom_04_0061"></a><a name="aom_04_0061"></a>
<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
<div id="body1559812915756"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="aom_04_0022.html">Introduction</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="aom_04_0062.html">Monitoring Actions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="aom_04_0064.html">Log Actions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="aom_04_0065.html">Alarm Actions</a></strong><br>
</li>
</ul>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,39 @@
<a name="aom_04_0064"></a><a name="aom_04_0064"></a>
<h1 class="topictitle1">Log Actions</h1>
<div id="body1559812915767"><div class="note" id="aom_04_0064__note138591718164412"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="aom_04_0064__p121883209448">√: supported; x: not supported</p>
</div></div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_0064__table21011495256" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Log actions</caption><thead align="left"><tr id="aom_04_0064__row6821749102512"><th align="left" class="cellrowborder" valign="top" width="9.919008099190082%" id="mcps1.3.2.2.6.1.1"><p id="aom_04_0064__p1082749172511">Permissions</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.126087391260874%" id="mcps1.3.2.2.6.1.2"><p id="aom_04_0064__p117281246164711">API</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.21857814218578%" id="mcps1.3.2.2.6.1.3"><p id="aom_04_0064__p88294916253">Action</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.928607139286072%" id="mcps1.3.2.2.6.1.4"><p id="aom_04_0064__p382349102520">IAM Project</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.807719228077193%" id="mcps1.3.2.2.6.1.5"><p id="aom_04_0064__p18821749152512">Enterprise Project</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_0064__row133035364273"><td class="cellrowborder" valign="top" width="9.919008099190082%" headers="mcps1.3.2.2.6.1.1 "><p id="aom_04_0064__p1875717113015">Querying logs</p>
</td>
<td class="cellrowborder" valign="top" width="39.126087391260874%" headers="mcps1.3.2.2.6.1.2 "><p id="aom_04_0064__p152851717194814">POST /v1/{project_id}/als/action</p>
</td>
<td class="cellrowborder" valign="top" width="14.21857814218578%" headers="mcps1.3.2.2.6.1.3 "><p id="aom_04_0064__p10735171134510">aom:log:list</p>
</td>
<td class="cellrowborder" valign="top" width="13.928607139286072%" headers="mcps1.3.2.2.6.1.4 "><p id="aom_04_0064__p684017278455"></p>
</td>
<td class="cellrowborder" valign="top" width="22.807719228077193%" headers="mcps1.3.2.2.6.1.5 "><p id="aom_04_0064__p98401278452">×</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0061.html">Permissions Policies and Supported Actions</a></div>
</div>
</div>

View File

@ -0,0 +1,61 @@
<a name="aom_04_0065"></a><a name="aom_04_0065"></a>
<h1 class="topictitle1">Alarm Actions</h1>
<div id="body0000001474783036"><div class="note" id="aom_04_0065__note138591718164412"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="aom_04_0065__p121883209448">√: supported; x: not supported</p>
</div></div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="aom_04_0065__table21011495256" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Alarm actions</caption><thead align="left"><tr id="aom_04_0065__row6821749102512"><th align="left" class="cellrowborder" valign="top" width="14.5985401459854%" id="mcps1.3.2.2.6.1.1"><p id="aom_04_0065__p1082749172511">Permissions</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.716328367163285%" id="mcps1.3.2.2.6.1.2"><p id="aom_04_0065__p4982103684413">API</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.21827817218278%" id="mcps1.3.2.2.6.1.3"><p id="aom_04_0065__p88294916253">Action</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.408559144085592%" id="mcps1.3.2.2.6.1.4"><p id="aom_04_0065__p382349102520">IAM Project</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.05829417058294%" id="mcps1.3.2.2.6.1.5"><p id="aom_04_0065__p18821749152512">Enterprise Project</p>
</th>
</tr>
</thead>
<tbody><tr id="aom_04_0065__row149073516254"><td class="cellrowborder" valign="top" width="14.5985401459854%" headers="mcps1.3.2.2.6.1.1 "><p id="aom_04_0065__p1029419817258">Querying events and alarms</p>
</td>
<td class="cellrowborder" valign="top" width="36.716328367163285%" headers="mcps1.3.2.2.6.1.2 "><p id="aom_04_0065__p1940217263010">POST /v2/{project_id}/events</p>
</td>
<td class="cellrowborder" valign="top" width="17.21827817218278%" headers="mcps1.3.2.2.6.1.3 "><p id="aom_04_0065__p19908105172519">aom:alarm:list</p>
</td>
<td class="cellrowborder" valign="top" width="14.408559144085592%" headers="mcps1.3.2.2.6.1.4 "><p id="aom_04_0065__p665233525914"></p>
</td>
<td class="cellrowborder" valign="top" width="17.05829417058294%" headers="mcps1.3.2.2.6.1.5 "><p id="aom_04_0065__p13652123585915">×</p>
</td>
</tr>
<tr id="aom_04_0065__row29088552516"><td class="cellrowborder" valign="top" width="14.5985401459854%" headers="mcps1.3.2.2.6.1.1 "><p id="aom_04_0065__p18294682259">Counting events and alarms</p>
</td>
<td class="cellrowborder" valign="top" width="36.716328367163285%" headers="mcps1.3.2.2.6.1.2 "><p id="aom_04_0065__p878843718017">POST /v2/{project_id}/events/statistic</p>
</td>
<td class="cellrowborder" valign="top" width="17.21827817218278%" headers="mcps1.3.2.2.6.1.3 "><p id="aom_04_0065__p149081592517">aom:alarm:list</p>
</td>
<td class="cellrowborder" valign="top" width="14.408559144085592%" headers="mcps1.3.2.2.6.1.4 "><p id="aom_04_0065__p1065283510595"></p>
</td>
<td class="cellrowborder" valign="top" width="17.05829417058294%" headers="mcps1.3.2.2.6.1.5 "><p id="aom_04_0065__p6653193516592">×</p>
</td>
</tr>
<tr id="aom_04_0065__row11908165132511"><td class="cellrowborder" valign="top" width="14.5985401459854%" headers="mcps1.3.2.2.6.1.1 "><p id="aom_04_0065__p18294685251">Reporting events and alarms</p>
</td>
<td class="cellrowborder" valign="top" width="36.716328367163285%" headers="mcps1.3.2.2.6.1.2 "><p id="aom_04_0065__p7106194619010">PUT /v2/{project_id}/push/events</p>
</td>
<td class="cellrowborder" valign="top" width="17.21827817218278%" headers="mcps1.3.2.2.6.1.3 "><p id="aom_04_0065__p1590815112513">aom:alarm:put</p>
</td>
<td class="cellrowborder" valign="top" width="14.408559144085592%" headers="mcps1.3.2.2.6.1.4 "><p id="aom_04_0065__p8653163512594"></p>
</td>
<td class="cellrowborder" valign="top" width="17.05829417058294%" headers="mcps1.3.2.2.6.1.5 "><p id="aom_04_0065__p46531535135912">×</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0061.html">Permissions Policies and Supported Actions</a></div>
</div>
</div>

View File

@ -6,6 +6,10 @@
<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="ErrorCode.html">Error Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0000001409328750.html">Obtaining an Account ID and Project ID</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>

View File

@ -0,0 +1,20 @@
<a name="aom_04_0079"></a><a name="aom_04_0079"></a>
<h1 class="topictitle1">Alarm</h1>
<div><p> </p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ListEvents.html">Querying Events and Alarms</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="CountEvents.html">Counting Events and Alarms</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="PushEvents.html">Reporting Events and Alarms</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0010.html">API</a></div>
</div>
</div>

View File

@ -1,13 +0,0 @@
<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>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,29 +0,0 @@
<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>

View File

@ -1,15 +0,0 @@
<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>

View File

@ -0,0 +1,12 @@
<a name="EN-US_TOPIC_0000001409328750"></a><a name="EN-US_TOPIC_0000001409328750"></a>
<h1 class="topictitle1">Obtaining an Account ID and Project ID</h1>
<div id="body0000001409328750"><p id="EN-US_TOPIC_0000001409328750__a3a747ce979b949e79b5dfc9a706d9a0f">When making API calls, you may need to enter the username, user ID, project name, and project ID in some URIs. You can obtain them on the <strong id="EN-US_TOPIC_0000001409328750__b122174711219">My Credentials</strong> page.</p>
<ol id="EN-US_TOPIC_0000001409328750__o6dfd6c848ec24b99ad6acef8a73b4899"><li id="EN-US_TOPIC_0000001409328750__li5887649711229"><span>Log in to the management console.</span></li><li id="EN-US_TOPIC_0000001409328750__lcecec0753a3047ee88b36e8aefd92739"><span>Hover the cursor over your username in the upper right corner of the page, and choose <strong id="EN-US_TOPIC_0000001409328750__b1799119225434">My Credentials</strong> from the drop-down list.</span></li><li id="EN-US_TOPIC_0000001409328750__l4f694f360e29418c8b5573aa2df0a9d9"><span>On the <strong id="EN-US_TOPIC_0000001409328750__b32791113114515">My Credentials</strong> page, view the username, user ID, project name, and project ID.</span></li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="aom_04_0066.html">Appendix</a></div>
</div>
</div>

View File

@ -0,0 +1,9 @@
<a name="EN-US_TOPIC_0000001409488734"></a><a name="EN-US_TOPIC_0000001409488734"></a>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body0000001409488734"><p id="EN-US_TOPIC_0000001409488734__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="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_i193313381196">Endpoint/uri</em>. In the URL, <em id="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_i193311389910">uri</em> indicates the resource path, that is, the API access path.</p>
<p id="EN-US_TOPIC_0000001409488734__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="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_b49339387910">Application/json</strong>.</p>
<p id="EN-US_TOPIC_0000001409488734__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>
<p id="EN-US_TOPIC_0000001409488734__p1885314354417">For details about <span style="color:#212121;">metric description</span>, see <strong style="color:#212121;" id="EN-US_TOPIC_0000001409488734__b16238122018164">Metric Overview</strong><span style="color:#212121;"> in the </span><em style="color:#212121;" id="EN-US_TOPIC_0000001409488734__i96512314437">AOM User Guide</em><span style="color:#212121;">.</span></p>
</div>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 B

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 B

After

Width:  |  Height:  |  Size: 1.8 KiB