forked from docs/doc-exports
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1e587c7a37 | |||
| e02b329e27 | |||
| 9763fd5f91 | |||
| d199d80ba6 | |||
| 1041e46c41 |
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -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>
|
||||
|
||||
@ -1,72 +0,0 @@
|
||||
<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>
|
||||
|
||||
@ -1,51 +0,0 @@
|
||||
<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
@ -1,25 +0,0 @@
|
||||
<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>
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
<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>
|
||||
|
||||
@ -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
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
482
docs/kms/api-ref/ALL_META.TXT.json
Normal file
482
docs/kms/api-ref/ALL_META.TXT.json
Normal file
File diff suppressed because it is too large
Load Diff
434
docs/kms/api-ref/CLASS.TXT.json
Normal file
434
docs/kms/api-ref/CLASS.TXT.json
Normal file
File diff suppressed because it is too large
Load Diff
13
docs/kms/api-ref/dew_02_0307.html
Normal file
13
docs/kms/api-ref/dew_02_0307.html
Normal file
@ -0,0 +1,13 @@
|
||||
<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>
|
||||
|
||||
23
docs/kms/api-ref/dew_02_0308.html
Normal file
23
docs/kms/api-ref/dew_02_0308.html
Normal file
@ -0,0 +1,23 @@
|
||||
<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>
|
||||
|
||||
499
docs/kms/api-ref/dew_02_0309.html
Normal file
499
docs/kms/api-ref/dew_02_0309.html
Normal file
File diff suppressed because it is too large
Load Diff
BIN
docs/kms/api-ref/en-us_image_0218728478.jpg
Normal file
BIN
docs/kms/api-ref/en-us_image_0218728478.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 110 KiB |
8
docs/kms/api-ref/en-us_topic_00384375969.html
Normal file
8
docs/kms/api-ref/en-us_topic_00384375969.html
Normal file
@ -0,0 +1,8 @@
|
||||
<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>
|
||||
|
||||
22
docs/kms/api-ref/kms_02_0009.html
Normal file
22
docs/kms/api-ref/kms_02_0009.html
Normal file
@ -0,0 +1,22 @@
|
||||
<a name="kms_02_0009"></a><a name="kms_02_0009"></a>
|
||||
|
||||
<h1 class="topictitle1">Obtaining a Project ID</h1>
|
||||
<div id="body32001227"><div class="section" id="kms_02_0009__en-us_topic_0171850914_en-us_topic_0101662393_section59621329127"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="kms_02_0009__en-us_topic_0171850914_en-us_topic_0101662393_p8112855194115">A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:</p>
|
||||
<ol id="kms_02_0009__en-us_topic_0171850914_en-us_topic_0101662393_ol8715914194127"><li id="kms_02_0009__en-us_topic_0171850914_en-us_topic_0101662393_li50056756194127">Log in to the management console.</li><li id="kms_02_0009__en-us_topic_0171850914_en-us_topic_0101662393_li2804809915217">Click the username and choose <strong id="kms_02_0009__en-us_topic_0171850914_b8169259132211">My Credential</strong> from the drop-down list.<p id="kms_02_0009__en-us_topic_0171850914_en-us_topic_0101662393_p136772519449">On the <strong id="kms_02_0009__en-us_topic_0171850914_b57411048112216">My Credential</strong> page, view project IDs in the project list.</p>
|
||||
</li></ol>
|
||||
<div class="fignone" id="kms_02_0009__en-us_topic_0171850914_en-us_topic_0101662393_fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="kms_02_0009__en-us_topic_0171850914_en-us_topic_0101662393_image538470016132" src="en-us_image_0218728478.jpg" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0300.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
||||
81
docs/kms/api-ref/kms_02_0010.html
Normal file
81
docs/kms/api-ref/kms_02_0010.html
Normal file
@ -0,0 +1,81 @@
|
||||
<a name="kms_02_0010"></a><a name="kms_02_0010"></a>
|
||||
|
||||
<h1 class="topictitle1">APIs</h1>
|
||||
<div id="body1516240388172"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0012.html">Creating a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0013.html">Enabling a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0014.html">Disabling a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0015.html">Scheduling the Deletion of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0016.html">Canceling the Scheduled Deletion of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0017.html">Querying the List of CMKs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0018.html">Querying the Information About a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0019.html">Creating a Random Number</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0020.html">Creating a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0021.html">Creating a Plaintext-Free DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0022.html">Encrypting a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0023.html">Decrypting a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0024.html">Querying the Number of Instances</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0025.html">Querying the Quota of a User</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0026.html">Changing the Alias of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0027.html">Changing the Description of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0028.html">Creating a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0029.html">Revoking a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0030.html">Retiring a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0031.html">Querying Grants on a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0032.html">Querying Grants That Can Be Retired</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0035.html">Obtaining CMK Import Parameters</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0036.html">Importing CMK Material</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0037.html">Deleting CMK Material</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0038.html">Enabling Rotation for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0039.html">Changing the Rotation Interval for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0040.html">Disabling Rotation for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0041.html">Querying the Rotation Status of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0042.html">Querying CMK Instances</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0043.html">Querying CMK Tags</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0044.html">Querying Project Tags</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0045.html">Adding or Deleting CMK Tags in Batches</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0046.html">Adding a CMK Tag</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0047.html">Deleting a CMK Tag</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0048.html">Querying All API Versions</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0049.html">Querying a Specified API Version</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
190
docs/kms/api-ref/kms_02_0012.html
Normal file
190
docs/kms/api-ref/kms_02_0012.html
Normal file
File diff suppressed because it is too large
Load Diff
174
docs/kms/api-ref/kms_02_0013.html
Normal file
174
docs/kms/api-ref/kms_02_0013.html
Normal file
File diff suppressed because it is too large
Load Diff
173
docs/kms/api-ref/kms_02_0014.html
Normal file
173
docs/kms/api-ref/kms_02_0014.html
Normal file
File diff suppressed because it is too large
Load Diff
156
docs/kms/api-ref/kms_02_0015.html
Normal file
156
docs/kms/api-ref/kms_02_0015.html
Normal file
File diff suppressed because it is too large
Load Diff
149
docs/kms/api-ref/kms_02_0016.html
Normal file
149
docs/kms/api-ref/kms_02_0016.html
Normal file
File diff suppressed because it is too large
Load Diff
227
docs/kms/api-ref/kms_02_0017.html
Normal file
227
docs/kms/api-ref/kms_02_0017.html
Normal file
File diff suppressed because it is too large
Load Diff
275
docs/kms/api-ref/kms_02_0018.html
Normal file
275
docs/kms/api-ref/kms_02_0018.html
Normal file
File diff suppressed because it is too large
Load Diff
134
docs/kms/api-ref/kms_02_0019.html
Normal file
134
docs/kms/api-ref/kms_02_0019.html
Normal file
File diff suppressed because it is too large
Load Diff
177
docs/kms/api-ref/kms_02_0020.html
Normal file
177
docs/kms/api-ref/kms_02_0020.html
Normal file
File diff suppressed because it is too large
Load Diff
168
docs/kms/api-ref/kms_02_0021.html
Normal file
168
docs/kms/api-ref/kms_02_0021.html
Normal file
File diff suppressed because it is too large
Load Diff
207
docs/kms/api-ref/kms_02_0022.html
Normal file
207
docs/kms/api-ref/kms_02_0022.html
Normal file
File diff suppressed because it is too large
Load Diff
190
docs/kms/api-ref/kms_02_0023.html
Normal file
190
docs/kms/api-ref/kms_02_0023.html
Normal file
File diff suppressed because it is too large
Load Diff
101
docs/kms/api-ref/kms_02_0024.html
Normal file
101
docs/kms/api-ref/kms_02_0024.html
Normal file
File diff suppressed because it is too large
Load Diff
181
docs/kms/api-ref/kms_02_0025.html
Normal file
181
docs/kms/api-ref/kms_02_0025.html
Normal file
File diff suppressed because it is too large
Load Diff
182
docs/kms/api-ref/kms_02_0026.html
Normal file
182
docs/kms/api-ref/kms_02_0026.html
Normal file
File diff suppressed because it is too large
Load Diff
182
docs/kms/api-ref/kms_02_0027.html
Normal file
182
docs/kms/api-ref/kms_02_0027.html
Normal file
File diff suppressed because it is too large
Load Diff
185
docs/kms/api-ref/kms_02_0028.html
Normal file
185
docs/kms/api-ref/kms_02_0028.html
Normal file
File diff suppressed because it is too large
Load Diff
125
docs/kms/api-ref/kms_02_0029.html
Normal file
125
docs/kms/api-ref/kms_02_0029.html
Normal file
File diff suppressed because it is too large
Load Diff
127
docs/kms/api-ref/kms_02_0030.html
Normal file
127
docs/kms/api-ref/kms_02_0030.html
Normal file
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user