Config API First Version
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
1283
docs/config/api-ref/ALL_META.TXT.json
Normal file
641
docs/config/api-ref/CLASS.TXT.json
Normal file
752
docs/config/api-ref/ErrorCode.html
Normal file
3
docs/config/api-ref/PARAMETERS.txt
Normal file
@ -0,0 +1,3 @@
|
||||
version=""
|
||||
language="en-us"
|
||||
type=""
|
BIN
docs/config/api-ref/en-us_image_0000001466731780.png
Normal file
After Width: | Height: | Size: 32 KiB |
37
docs/config/api-ref/en-us_topic_0000001991150822.html
Normal file
@ -0,0 +1,37 @@
|
||||
<a name="EN-US_TOPIC_0000001991150822"></a><a name="EN-US_TOPIC_0000001991150822"></a>
|
||||
|
||||
<h1 class="topictitle1">Resource Relationships</h1>
|
||||
<div id="body0000001991150822">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001991150822__table0875101134712" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001991150822__row18876111184718"><th align="left" class="cellrowborder" valign="top" width="14.35%" id="mcps1.3.1.1.6.1.1"><p id="EN-US_TOPIC_0000001991150822__p87863593711">Permission</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="37.230000000000004%" id="mcps1.3.1.1.6.1.2"><p id="EN-US_TOPIC_0000001991150822__p143591540411">API</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="17.79%" id="mcps1.3.1.1.6.1.3"><p id="EN-US_TOPIC_0000001991150822__p445499619223">Action</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="16.56%" id="mcps1.3.1.1.6.1.4"><p id="EN-US_TOPIC_0000001991150822__p1820911553480">IAM Project</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="14.069999999999999%" id="mcps1.3.1.1.6.1.5"><p id="EN-US_TOPIC_0000001991150822__p920917552480">Enterprise Project</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="EN-US_TOPIC_0000001991150822__row490858154815"><td class="cellrowborder" valign="top" width="14.35%" headers="mcps1.3.1.1.6.1.1 "><p id="EN-US_TOPIC_0000001991150822__p166943194916">Querying details about resource relationships</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="37.230000000000004%" headers="mcps1.3.1.1.6.1.2 "><p id="EN-US_TOPIC_0000001991150822__p15669143164916">GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}/relations</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17.79%" headers="mcps1.3.1.1.6.1.3 "><p id="EN-US_TOPIC_0000001991150822__p06693312497">rms:resources:getRelation</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="16.56%" headers="mcps1.3.1.1.6.1.4 "><p id="EN-US_TOPIC_0000001991150822__p4669143174918">√</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.069999999999999%" headers="mcps1.3.1.1.6.1.5 "><p id="EN-US_TOPIC_0000001991150822__p18427949173715">x</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_05_0000.html">Permissions Policies and Supported Actions</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
37
docs/config/api-ref/en-us_topic_0000002027710481.html
Normal file
@ -0,0 +1,37 @@
|
||||
<a name="EN-US_TOPIC_0000002027710481"></a><a name="EN-US_TOPIC_0000002027710481"></a>
|
||||
|
||||
<h1 class="topictitle1">Resource Change Records</h1>
|
||||
<div id="body0000002027710481">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002027710481__table0875101134712" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002027710481__row18876111184718"><th align="left" class="cellrowborder" valign="top" width="14.35%" id="mcps1.3.1.1.6.1.1"><p id="EN-US_TOPIC_0000002027710481__p87863593711">Permission</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="37.230000000000004%" id="mcps1.3.1.1.6.1.2"><p id="EN-US_TOPIC_0000002027710481__p143591540411">API</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="17.79%" id="mcps1.3.1.1.6.1.3"><p id="EN-US_TOPIC_0000002027710481__p445499619223">Action</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="16.56%" id="mcps1.3.1.1.6.1.4"><p id="EN-US_TOPIC_0000002027710481__p1820911553480">IAM Project</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="14.069999999999999%" id="mcps1.3.1.1.6.1.5"><p id="EN-US_TOPIC_0000002027710481__p920917552480">Enterprise Project</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="EN-US_TOPIC_0000002027710481__row1087651164712"><td class="cellrowborder" valign="top" width="14.35%" headers="mcps1.3.1.1.6.1.1 "><p id="EN-US_TOPIC_0000002027710481__p1140111243423">Querying change records of a resource</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="37.230000000000004%" headers="mcps1.3.1.1.6.1.2 "><p id="EN-US_TOPIC_0000002027710481__p9401162454220">GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/history</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17.79%" headers="mcps1.3.1.1.6.1.3 "><p id="EN-US_TOPIC_0000002027710481__p1240192464217">rms:resources:getHistory</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="16.56%" headers="mcps1.3.1.1.6.1.4 "><p id="EN-US_TOPIC_0000002027710481__p139701057103617">√</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.069999999999999%" headers="mcps1.3.1.1.6.1.5 "><p id="EN-US_TOPIC_0000002027710481__p741474953720">x</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_05_0000.html">Permissions Policies and Supported Actions</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
37
docs/config/api-ref/en-us_topic_0000002027750033.html
Normal file
@ -0,0 +1,37 @@
|
||||
<a name="EN-US_TOPIC_0000002027750033"></a><a name="EN-US_TOPIC_0000002027750033"></a>
|
||||
|
||||
<h1 class="topictitle1">Region Management</h1>
|
||||
<div id="body0000002027750033">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002027750033__table0875101134712" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002027750033__row18876111184718"><th align="left" class="cellrowborder" valign="top" width="14.35%" id="mcps1.3.1.1.6.1.1"><p id="EN-US_TOPIC_0000002027750033__p87863593711">Permission</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="37.230000000000004%" id="mcps1.3.1.1.6.1.2"><p id="EN-US_TOPIC_0000002027750033__p143591540411">API</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="17.79%" id="mcps1.3.1.1.6.1.3"><p id="EN-US_TOPIC_0000002027750033__p445499619223">Action</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="16.56%" id="mcps1.3.1.1.6.1.4"><p id="EN-US_TOPIC_0000002027750033__p1820911553480">IAM Project</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="14.069999999999999%" id="mcps1.3.1.1.6.1.5"><p id="EN-US_TOPIC_0000002027750033__p920917552480">Enterprise Project</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="EN-US_TOPIC_0000002027750033__row173805781419"><td class="cellrowborder" valign="top" width="14.35%" headers="mcps1.3.1.1.6.1.1 "><p id="EN-US_TOPIC_0000002027750033__p166866331595">Querying regions visible to you</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="37.230000000000004%" headers="mcps1.3.1.1.6.1.2 "><p id="EN-US_TOPIC_0000002027750033__p106214712313">GET /v1/resource-manager/domains/{domain_id}/regions</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17.79%" headers="mcps1.3.1.1.6.1.3 "><p id="EN-US_TOPIC_0000002027750033__p1538112761414">Not required</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="16.56%" headers="mcps1.3.1.1.6.1.4 "><p id="EN-US_TOPIC_0000002027750033__p105211747143918">x</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.069999999999999%" headers="mcps1.3.1.1.6.1.5 "><p id="EN-US_TOPIC_0000002027750033__p12526247123917">x</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_05_0000.html">Permissions Policies and Supported Actions</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
BIN
docs/config/api-ref/public_sys-resources/caution_3.0-en-us.png
Normal file
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/config/api-ref/public_sys-resources/danger_3.0-en-us.png
Normal file
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/config/api-ref/public_sys-resources/delta.gif
Normal file
After Width: | Height: | Size: 836 B |
BIN
docs/config/api-ref/public_sys-resources/deltaend.gif
Normal file
After Width: | Height: | Size: 834 B |
BIN
docs/config/api-ref/public_sys-resources/icon-arrowdn.gif
Normal file
After Width: | Height: | Size: 1.8 KiB |
BIN
docs/config/api-ref/public_sys-resources/icon-arrowrt.gif
Normal file
After Width: | Height: | Size: 1.8 KiB |
BIN
docs/config/api-ref/public_sys-resources/icon-caution.gif
Normal file
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/config/api-ref/public_sys-resources/icon-danger.gif
Normal file
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/config/api-ref/public_sys-resources/icon-huawei.gif
Normal file
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/config/api-ref/public_sys-resources/icon-note.gif
Normal file
After Width: | Height: | Size: 983 B |
BIN
docs/config/api-ref/public_sys-resources/icon-notice.gif
Normal file
After Width: | Height: | Size: 962 B |
BIN
docs/config/api-ref/public_sys-resources/icon-tip.gif
Normal file
After Width: | Height: | Size: 879 B |
BIN
docs/config/api-ref/public_sys-resources/icon-warning.gif
Normal file
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/config/api-ref/public_sys-resources/note_3.0-en-us.png
Normal file
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/config/api-ref/public_sys-resources/notice_3.0-en-us.png
Normal file
After Width: | Height: | Size: 1.6 KiB |
BIN
docs/config/api-ref/public_sys-resources/warning_3.0-en-us.png
Normal file
After Width: | Height: | Size: 3.1 KiB |
17
docs/config/api-ref/rms_01_0000.html
Normal file
@ -0,0 +1,17 @@
|
||||
<a name="rms_01_0000"></a><a name="rms_01_0000"></a>
|
||||
|
||||
<h1 class="topictitle1">Before You Start</h1>
|
||||
<div id="body1604041299442"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_01_0100.html">Introduction</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_01_0200.html">API Calling</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_01_0500.html">Concepts</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_01_0600.html">Querying Data by Page</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
13
docs/config/api-ref/rms_01_0100.html
Normal file
@ -0,0 +1,13 @@
|
||||
<a name="rms_01_0100"></a><a name="rms_01_0100"></a>
|
||||
|
||||
<h1 class="topictitle1">Introduction</h1>
|
||||
<div id="body1604041299446"><p id="rms_01_0100__p7997173681419">With Config, you can search for, record, and continuously evaluate your resource configuration to make sure that your expectations are met.</p>
|
||||
<p id="rms_01_0100__p0593948152511">This document describes the Config APIs. Parameter description and examples are provided. You can use provided APIs to perform operations on Config. For details about all supported operations, see <a href="rms_02_0000.html">API Overview</a>.</p>
|
||||
<p id="rms_01_0100__p1224318753518">If you plan to access Config through an API, ensure that you are familiar with Config concepts. For details, see <em id="rms_01_0100__i63723417377">Config User Guide</em>.</p>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_01_0000.html">Before You Start</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
11
docs/config/api-ref/rms_01_0200.html
Normal file
@ -0,0 +1,11 @@
|
||||
<a name="rms_01_0200"></a><a name="rms_01_0200"></a>
|
||||
|
||||
<h1 class="topictitle1">API Calling</h1>
|
||||
<div id="body1604041299448"><p id="rms_01_0200__p8060118">Config supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="rms_03_0000.html">Calling APIs</a>.</p>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_01_0000.html">Before You Start</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
18
docs/config/api-ref/rms_01_0500.html
Normal file
@ -0,0 +1,18 @@
|
||||
<a name="rms_01_0500"></a><a name="rms_01_0500"></a>
|
||||
|
||||
<h1 class="topictitle1">Concepts</h1>
|
||||
<div id="body8662426"><ul id="rms_01_0500__en-us_topic_0170093947_ul128965163312"><li id="rms_01_0500__en-us_topic_0170093947_li18143243201410">Account<p id="rms_01_0500__en-us_topic_0170093947_p17524174815145"><a name="rms_01_0500__en-us_topic_0170093947_li18143243201410"></a><a name="en-us_topic_0170093947_li18143243201410"></a>An account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.</p>
|
||||
</li><li id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_li15896816113116">User<p id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_p589691603117"><a name="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_li15896816113116"></a><a name="en-us_topic_0170093947_en-us_topic_0169294976_li15896816113116"></a>An IAM user is created by an account through IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
|
||||
<p id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_p9896121653112">The account name, username, and password will be required for API authentication.</p>
|
||||
</li><li id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_li1564913617106">Region<p id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_p10588103711107"><a name="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_li1564913617106"></a><a name="en-us_topic_0170093947_en-us_topic_0169294976_li1564913617106"></a>A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.</p>
|
||||
</li><li id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_li1183783919109">AZ<p id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_p061084051014"><a name="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_li1183783919109"></a><a name="en-us_topic_0170093947_en-us_topic_0169294976_li1183783919109"></a>An AZ comprises of one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Computing, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ high-availability systems.</p>
|
||||
</li><li id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_li3896216123113">Project<p id="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_p10896181643118"><a name="rms_01_0500__en-us_topic_0170093947_en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0170093947_en-us_topic_0169294976_li3896216123113"></a>A project corresponds to a region. Default projects are defined to group and physically isolate resources (including compute, storage, and network resources) across regions. You can grant users permissions by project, so that authorized users can access all resources in the project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.</p>
|
||||
<div class="fignone" id="rms_01_0500__en-us_topic_0170093947_fig10211164021615"><span class="figcap"><b>Figure 1 </b>Project isolation model</span><br><span><img id="rms_01_0500__en-us_topic_0170093947_image42119407164" src="en-us_image_0000001466731780.png"></span></div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_01_0000.html">Before You Start</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
43
docs/config/api-ref/rms_01_0600.html
Normal file
@ -0,0 +1,43 @@
|
||||
<a name="rms_01_0600"></a><a name="rms_01_0600"></a>
|
||||
|
||||
<h1 class="topictitle1">Querying Data by Page</h1>
|
||||
<div id="body1604041306885"><p id="rms_01_0600__p8060118">Some Config APIs support pagination query if you add <strong id="rms_01_0600__b12944155572715">limit</strong> and <strong id="rms_01_0600__b18642559122719">marker</strong> to the request URL. The value of <strong id="rms_01_0600__b0415195919292">marker</strong> must be the same as that returned in the last pagination query.</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_01_0600__table3567165824919" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Config parameter description</caption><thead align="left"><tr id="rms_01_0600__row35671358144911"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.1"><p id="rms_01_0600__p456755814491">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.2"><p id="rms_01_0600__p1567858164918">Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.3"><p id="rms_01_0600__p4567125844913">Mandatory</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.4"><p id="rms_01_0600__p1556725884918">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="rms_01_0600__row8567165810498"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.1 "><p id="rms_01_0600__p10567458194910">limit</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.2 "><p id="rms_01_0600__p6567358134912">Integer</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.3 "><p id="rms_01_0600__p556795810492">No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.4 "><p id="rms_01_0600__p1256735820490">Restricts the number of records displayed on each page. If <strong id="rms_01_0600__b12606316319">limit</strong> is invalid, error code 400 will be returned.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_01_0600__row135671858154914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.1 "><p id="rms_01_0600__p5567145811492">marker</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.2 "><p id="rms_01_0600__p1956725814915">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.3 "><p id="rms_01_0600__p19567458164910">No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.4 "><p id="rms_01_0600__p115677584495">Specifies the <strong id="rms_01_0600__b14653659163616">marker</strong> value returned in the last pagination query. If <strong id="rms_01_0600__b16356104324119">marker</strong> is invalid, error code 400 will be returned.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_01_0000.html">Before You Start</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
50
docs/config/api-ref/rms_02_0000.html
Normal file
@ -0,0 +1,50 @@
|
||||
<a name="rms_02_0000"></a><a name="rms_02_0000"></a>
|
||||
|
||||
<h1 class="topictitle1">API Overview</h1>
|
||||
<div id="body1604041306896">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0000__table5779521666" frame="border" border="1" rules="all"><caption><b>Table 1 </b>API description</caption><thead align="left"><tr id="rms_02_0000__row87799212620"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.1.2.3.1.1"><p id="rms_02_0000__p47796217610">API</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.1.2.3.1.2"><p id="rms_02_0000__p37796211568">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="rms_02_0000__row197799211362"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0000__p8535161514251">Resource Query</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0000__p1077919212617">APIs for querying resources, resource tags, resource quantity and summary, resources recorded by the resource recorder, and listing cloud services.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0000__row14779021669"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0000__p10799203118106">Resource Recorder</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0000__p157795213617">APIs for adding, deleting, modifying, and querying the resource recorder.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0000__row19779162118614"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0000__p777917211260">Resource Relationships</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0000__p1292011914417">APIs for querying resource relationships and details.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0000__row677919219611"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0000__p77791321466">Resource Change Records</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0000__p197792210611">API for querying resource change records.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0000__row107796211663"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0000__p1277914215611">Compliance</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0000__p552445144110">APIs for querying compliance policies; adding, deleting, modifying, querying, and running rules ; and querying and updating resource evaluation results.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0000__row11133159174218"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0000__p6879104184316">Region Management</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0000__p178796411438">API for querying regions visible to a user</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="rms_02_0000__row827410015442"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.1 "><p id="rms_02_0000__p164460574419">Advanced Queries</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.2.3.1.2 "><p id="rms_02_0000__p5447175144410">APIs for running, adding, deleting, modifying, and querying advanced queries</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
329
docs/config/api-ref/rms_02_0019.html
Normal file
9
docs/config/api-ref/rms_03_0000.html
Normal file
@ -0,0 +1,9 @@
|
||||
<a name="rms_03_0000"></a><a name="rms_03_0000"></a>
|
||||
|
||||
<h1 class="topictitle1">Calling APIs</h1>
|
||||
<div id="body8662426"><p id="rms_03_0000__en-us_topic_0170091002_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="rms_03_0000__en-us_topic_0170091002_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="rms_03_0000__b050013114572">uri</strong> indicates the resource path, that is, the API access path.</p>
|
||||
<p id="rms_03_0000__en-us_topic_0170091002_p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with the media type represented by <strong id="rms_03_0000__en-us_topic_0170091002_b3082532510259">Application/json</strong>.</p>
|
||||
<p id="rms_03_0000__en-us_topic_0170091002_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>
|
||||
<div></div>
|
||||
|
23
docs/config/api-ref/rms_04_0000.html
Normal file
@ -0,0 +1,23 @@
|
||||
<a name="rms_04_0000"></a><a name="rms_04_0000"></a>
|
||||
|
||||
<h1 class="topictitle1">APIs</h1>
|
||||
<div id="body1605789123793"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0100.html">Resource Query</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0200.html">Resource Recorder</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0300.html">Resource Relationships</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0400.html">Resource Change Records</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0500.html">Compliance</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0600.html">Region Management</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0700.html">Advanced Queries</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
40
docs/config/api-ref/rms_04_0100.html
Normal file
@ -0,0 +1,40 @@
|
||||
<a name="rms_04_0100"></a><a name="rms_04_0100"></a>
|
||||
|
||||
<h1 class="topictitle1">Resource Query</h1>
|
||||
<div><p> </p>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0101.html">Querying Resources of a Specific Type</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0102.html">Listing Cloud Services</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0103.html">Querying a Resource</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0109.html">Listing Resources Recorded by the Resource Recorder</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0110.html">Querying how many resources are recorded by the resource recorder</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0111.html">Querying resource tags recorded by the resource recorder</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0112.html">Querying resource overview recorded by the resource recorder</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0113.html">Querying a specific resource recorded by the resource recorder</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0104.html">Querying All Resources Under Your Account</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0105.html">Querying a Resource Under Your Account</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0106.html">Querying Resource Tags</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0107.html">Querying the Number of Resources</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0108.html">Querying a Resource Summary</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_04_0000.html">APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
509
docs/config/api-ref/rms_04_0101.html
Normal file
379
docs/config/api-ref/rms_04_0102.html
Normal file
465
docs/config/api-ref/rms_04_0103.html
Normal file
526
docs/config/api-ref/rms_04_0104.html
Normal file
386
docs/config/api-ref/rms_04_0105.html
Normal file
324
docs/config/api-ref/rms_04_0106.html
Normal file
291
docs/config/api-ref/rms_04_0107.html
Normal file
375
docs/config/api-ref/rms_04_0108.html
Normal file
558
docs/config/api-ref/rms_04_0109.html
Normal file
311
docs/config/api-ref/rms_04_0110.html
Normal file
340
docs/config/api-ref/rms_04_0111.html
Normal file
386
docs/config/api-ref/rms_04_0112.html
Normal file
396
docs/config/api-ref/rms_04_0113.html
Normal file
20
docs/config/api-ref/rms_04_0200.html
Normal file
@ -0,0 +1,20 @@
|
||||
<a name="rms_04_0200"></a><a name="rms_04_0200"></a>
|
||||
|
||||
<h1 class="topictitle1">Resource Recorder</h1>
|
||||
<div><p> </p>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0201.html">Querying the Resource Recorder</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0202.html">Deleting the Resource Recorder</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="rms_04_0203.html">Creating or Modifying the Resource Recorder</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_04_0000.html">APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|