Compare commits

..

1 Commits

Author SHA1 Message Date
b07fa1c9f7 AOM API 0929 2022-09-29 18:58:13 +08:00
119 changed files with 5166 additions and 10092 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View 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>

View 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>

View 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>

File diff suppressed because it is too large Load Diff

View 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>

View 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>

View 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>

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

@ -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>

View 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>

View File

Before

Width:  |  Height:  |  Size: 2.7 KiB

After

Width:  |  Height:  |  Size: 2.7 KiB

View File

Before

Width:  |  Height:  |  Size: 2.7 KiB

After

Width:  |  Height:  |  Size: 2.7 KiB

View File

Before

Width:  |  Height:  |  Size: 836 B

After

Width:  |  Height:  |  Size: 836 B

View File

Before

Width:  |  Height:  |  Size: 834 B

After

Width:  |  Height:  |  Size: 834 B

View File

Before

Width:  |  Height:  |  Size: 68 B

After

Width:  |  Height:  |  Size: 68 B

View File

Before

Width:  |  Height:  |  Size: 70 B

After

Width:  |  Height:  |  Size: 70 B

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

Before

Width:  |  Height:  |  Size: 2.7 KiB

After

Width:  |  Height:  |  Size: 2.7 KiB

View File

Before

Width:  |  Height:  |  Size: 983 B

After

Width:  |  Height:  |  Size: 983 B

View File

Before

Width:  |  Height:  |  Size: 962 B

After

Width:  |  Height:  |  Size: 962 B

View File

Before

Width:  |  Height:  |  Size: 879 B

After

Width:  |  Height:  |  Size: 879 B

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

Before

Width:  |  Height:  |  Size: 1.6 KiB

After

Width:  |  Height:  |  Size: 1.6 KiB

View File

Before

Width:  |  Height:  |  Size: 3.1 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,13 +0,0 @@
<a name="dew_02_0307"></a><a name="dew_02_0307"></a>
<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dew_02_0308.html">Introduction</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dew_02_0309.html">Encryption Key Management</a></strong><br>
</li>
</ul>
</div>

View File

@ -1,23 +0,0 @@
<a name="dew_02_0308"></a><a name="dew_02_0308"></a>
<h1 class="topictitle1">Introduction</h1>
<div id="body8662426"><p id="dew_02_0308__en-us_topic_0172275164_p122841827152813">This chapter describes fine-grained permissions management for your KMS. If your account does not need individual IAM users, then you may skip over this chapter.</p>
<p id="dew_02_0308__en-us_topic_0172275164_p1386992104912">By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
<p id="dew_02_0308__en-us_topic_0172275164_p7869112110495">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="dew_02_0308__en-us_topic_0172275164_note2789122144911"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dew_02_0308__en-us_topic_0172275164_p716514134549">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="dew_02_0308__en-us_topic_0172275164_p1487018213499">An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. </p>
<div class="section" id="dew_02_0308__en-us_topic_0172275164_section677212217497"><h4 class="sectiontitle">Supported Actions</h4><p id="dew_02_0308__en-us_topic_0172275164_p187062194916">You can use system-defined policies provided in IAM, or create custom policies to supplement the system-defined policies, implementing refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<ul id="dew_02_0308__en-us_topic_0172275164_ul1487018213498"><li id="dew_02_0308__en-us_topic_0172275164_li8870122134910">Permission: A statement in a policy that allows or denies certain operations.</li><li id="dew_02_0308__en-us_topic_0172275164_li3635501787">APIs: REST APIs that can be called in a custom policy.</li><li id="dew_02_0308__en-us_topic_0172275164_li118703217498">Actions: Added to a custom policy to control permissions for specific operations.</li><li id="dew_02_0308__en-us_topic_0172275164_li27972588819">Dependent actions: When assigning an action to users, you also need to assign dependent permissions for that action to take effect.</li><li id="dew_02_0308__en-us_topic_0172275164_li1987022154912">IAM projects or enterprise project: Scope of users a permission is granted to. 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 in IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Project. <div class="note" id="dew_02_0308__en-us_topic_0172275164_note1187734192"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dew_02_0308__en-us_topic_0172275164_p140015411092">√: supported; x: not supported</p>
</div></div>
</li></ul>
<p id="dew_02_0308__en-us_topic_0172275164_p18681734368">KMS supports the following actions that can be defined in custom policies:</p>
<p id="dew_02_0308__en-us_topic_0172275164_p0276549103610"><a href="dew_02_0309.html#dew_02_0309">Manage keys</a>, such as creating keys and querying keys.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dew_02_0307.html">Permissions Policies and Supported Actions</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

Binary file not shown.

Before

Width:  |  Height:  |  Size: 110 KiB

View File

@ -1,8 +0,0 @@
<a name="en-us_topic_00384375969"></a><a name="en-us_topic_00384375969"></a>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body1530174454877"><p id="en-us_topic_00384375969__en-us_topic_0119070335_p1645204610259">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: <em id="en-us_topic_00384375969__en-us_topic_0119070335_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="en-us_topic_00384375969__en-us_topic_0119070335_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="en-us_topic_00384375969__en-us_topic_0119070335_p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="en-us_topic_00384375969__en-us_topic_0119070335_b3082532510259">Application/json</strong>.</p>
<p id="en-us_topic_00384375969__en-us_topic_0119070335_p188289482118">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?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
</div>

Some files were not shown because too many files have changed in this diff Show More