yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

DWS API 850.100 version

Browse Source 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>
This commit is contained in:
Lu, Huayi
2025-04-23 13:48:36 +00:00
committed by zuul
parent 12be926dd0
commit 7d82735858
17 changed files with 169 additions and 322 deletions
Download Patch File Download Diff File Expand all files Collapse all files

170
docs/dws/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

184
docs/dws/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

8
docs/dws/api-ref/dws_02_0030.html
View File

@ -120,7 +120,7 @@
</td>
<td class="cellrowborder" valign="top" width="21.92%" headers="mcps1.3.2.2.6.1.3 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0067711912_p24250547">Invalid password of database <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_en-us_topic_0067711912_b84235270616262">root</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p7792135191117">Invalid password of database <strong id="EN-US_TOPIC_0000001326816266__b350624923">root</strong>.</p>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p7792135191117">Invalid password of database <strong id="EN-US_TOPIC_0000001326816266__b1727966551">root</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="34.97%" headers="mcps1.3.2.2.6.1.5 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p0284735122">Enter a valid password according to the password description.</p>
</td>
@ -791,7 +791,7 @@
</td>
<td class="cellrowborder" valign="top" width="21.92%" headers="mcps1.3.2.2.6.1.3 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p12781010183114">The ECS group parameter is missing.</p>
</td>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p1178111093112">The ECS group parameters is missing.</p>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p1178111093112">The ECS group parameters are missing.</p>
</td>
<td class="cellrowborder" valign="top" width="34.97%" headers="mcps1.3.2.2.6.1.5 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p378111017316">Enter a valid parameter and try again.</p>
</td>
@ -868,7 +868,7 @@
</td>
<td class="cellrowborder" valign="top" width="21.92%" headers="mcps1.3.2.2.6.1.3 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p881912518332">Invalid <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_b1578913326147">fill_missing_fields</strong> parameter in the data file. The supported values are <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_b813262141">true/on</strong> and <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_b111365299144">false/off</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p56001842182018">Invalid <strong id="EN-US_TOPIC_0000001326816266__b2068244356">fill_missing_fields</strong> parameter in the data file. The supported values are <strong id="EN-US_TOPIC_0000001326816266__b1811642260">true/on</strong> and <strong id="EN-US_TOPIC_0000001326816266__b432604932">false/off</strong>.</p>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p56001842182018">Invalid <strong id="EN-US_TOPIC_0000001326816266__b1271484957">fill_missing_fields</strong> parameter in the data file. The supported values are <strong id="EN-US_TOPIC_0000001326816266__b644141330">true/on</strong> and <strong id="EN-US_TOPIC_0000001326816266__b462672009">false/off</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="34.97%" headers="mcps1.3.2.2.6.1.5 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p581995163311">Enter the correct <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_b1591810414144">fill_missing_fields</strong> parameter and try again later.</p>
</td>
@ -879,7 +879,7 @@
</td>
<td class="cellrowborder" valign="top" width="21.92%" headers="mcps1.3.2.2.6.1.3 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p43121832123319">Invalid <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_b1428720535142">ignore_extra_data</strong> parameter in the data file. The supported values are <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_b96689594144">true/on</strong> and <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_b2176184121514">false/off</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p11600144213203">Invalid <strong id="EN-US_TOPIC_0000001326816266__b1256914337">ignore_extra_data</strong> parameter in the data file. The supported values are <strong id="EN-US_TOPIC_0000001326816266__b1912214801">true/on</strong> and <strong id="EN-US_TOPIC_0000001326816266__b373521267">false/off</strong>.</p>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p11600144213203">Invalid <strong id="EN-US_TOPIC_0000001326816266__b1844319300">ignore_extra_data</strong> parameter in the data file. The supported values are <strong id="EN-US_TOPIC_0000001326816266__b69198589">true/on</strong> and <strong id="EN-US_TOPIC_0000001326816266__b579966380">false/off</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="34.97%" headers="mcps1.3.2.2.6.1.5 "><p id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_p7312432123312">Enter the correct <strong id="EN-US_TOPIC_0000001326816266__en-us_topic_0000001134564656_en-us_topic_0000001081890905_b8620513111510">ignore_extra_data</strong> parameter and try again later.</p>
</td>

9
docs/dws/api-ref/dws_02_0031.html
View File

@ -8,9 +8,14 @@
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185673176__row10631910499"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001185673176__p363261013913">2024-09-30</p>
<tbody><tr id="EN-US_TOPIC_0000001185673176__row1513081911417"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001185673176__p9130101916417">2025-04-03</p>
</td>
<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001185673176__p1763312109919">This issue is the eighteenth official release for the 8.2.1.220 cluster.</p>
<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001185673176__p12960631649">This issue is the nineteenth official release for cluster version 9.1.0.211.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185673176__row571216682"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001185673176__p117131161784">2024-09-30</p>
</td>
<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001185673176__p1371312612810">This issue is the eighteenth official release for the 8.2.1.220 cluster.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185673176__row14619134212409"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001185673176__p19891853184020">2024-03-29</p>

13
docs/dws/api-ref/dws_02_0033.html
View File

@ -1,13 +0,0 @@
<a name="EN-US_TOPIC_0000001185673168"></a><a name="EN-US_TOPIC_0000001185673168"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body1558595678679"><p id="EN-US_TOPIC_0000001185673168__p19736105151614">Welcome to GaussDB(DWS). GaussDB(DWS) is a fully-managed and enterprise-level cloud data warehouse service. It is O&amp;M-free, compatible with the PostgreSQL ecosystem, and supports online cluster scale-out and efficient loading of multiple data sources. GaussDB(DWS) helps enterprises efficiently analyze and monetize massive data online.</p>
<p id="EN-US_TOPIC_0000001185673168__p1114017589475">This document describes how to use application programming interfaces (APIs) to create, query, and delete GaussDB(DWS) clusters, tags, and snapshots. For details about all supported operations, see <a href="dws_02_0034.html">API Overview</a>.</p>
<p id="EN-US_TOPIC_0000001185673168__p1453514534137">Before calling an API, get familiar with related concepts of GaussDB(DWS). For details, see "Service Overview" in the <em id="EN-US_TOPIC_0000001185673168__i1340473463118">Data Warehouse Service User Guide</em>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0057.html">Before You Start</a></div>
</div>
</div>

1
docs/dws/api-ref/dws_02_0034.html
View File

@ -116,4 +116,5 @@
</table>
</div>
</div>
<div></div>

4
docs/dws/api-ref/dws_02_0056.html
View File

@ -6,8 +6,8 @@
<p id="EN-US_TOPIC_0000001185673170__p45185296531">You can grant users permissions by using roles and policies. Roles are provided by IAM to define service-based permissions depending on users' job 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="EN-US_TOPIC_0000001185673170__note134381729185315"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001185673170__p6654112423110">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="EN-US_TOPIC_0000001185673170__p279171816357">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. For example, if an IAM user wants to query the GaussDB(DWS) cluster list using an API, the user must have been granted permissions that allow the <strong id="EN-US_TOPIC_0000001185673170__b1447294791413">dws:openAPICluster:list</strong> action.</p>
<div class="section" id="EN-US_TOPIC_0000001185673170__section66645189352"><h4 class="sectiontitle">Supported Actions</h4><p id="EN-US_TOPIC_0000001185673170__p284917302096">DWS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<p id="EN-US_TOPIC_0000001185673170__p279171816357">An account has full permissions to access all APIs, but each IAM user needs to be granted the necessary permissions before they can begin using the APIs. 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. For example, if an IAM user wants to query the GaussDB(DWS) cluster list using an API, the user must have been granted permissions that allow the <strong id="EN-US_TOPIC_0000001185673170__b1447294791413">dws:openAPICluster:list</strong> action.</p>
<div class="section" id="EN-US_TOPIC_0000001185673170__section66645189352"><h4 class="sectiontitle">Supported Actions</h4><p id="EN-US_TOPIC_0000001185673170__p284917302096">GaussDB(DWS) provides system-defined policies that can be directly used in IAM. Database administrators can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<ul id="EN-US_TOPIC_0000001185673170__ul6791818113512"><li id="EN-US_TOPIC_0000001185673170__li479191814351"><strong id="EN-US_TOPIC_0000001185673170__b9309172111227">Permissions</strong>: Allow or deny operations on specified resources under specific conditions.</li><li id="EN-US_TOPIC_0000001185673170__li13468347313"><strong id="EN-US_TOPIC_0000001185673170__b166193141210">APIs</strong>: RESTful APIs that can be called in a custom policy.</li><li id="EN-US_TOPIC_0000001185673170__li87911018113515"><strong id="EN-US_TOPIC_0000001185673170__b5671173217227">Actions</strong>: Added to a custom policy to control permissions for specific operations.</li><li id="EN-US_TOPIC_0000001185673170__li47911918153513"><strong id="EN-US_TOPIC_0000001185673170__b1875325320129">IAM or enterprise projects</strong>: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. <div class="note" id="EN-US_TOPIC_0000001185673170__note396918413431"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001185673170__p1440311715430">The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.</p>
</div></div>
</li></ul>

36
docs/dws/api-ref/dws_02_0057.html
View File

@ -1,17 +1,29 @@
<a name="EN-US_TOPIC_0000001231391265"></a><a name="EN-US_TOPIC_0000001231391265"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dws_02_0033.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dws_02_0058.html">API Calling</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dws_02_0059.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dws_02_0061.html">Basic Concepts</a></strong><br>
</li>
</ul>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001231391265__section13064913205"><h4 class="sectiontitle">Overview</h4><p id="EN-US_TOPIC_0000001231391265__p19736105151614">Welcome to GaussDB(DWS). GaussDB(DWS) is a fully-managed and enterprise-level cloud data warehouse service. It is O&amp;M-free, compatible with the PostgreSQL ecosystem, and supports online cluster scale-out and efficient loading of multiple data sources. It helps enterprises efficiently analyze and monetize massive amounts of data online.</p>
<p id="EN-US_TOPIC_0000001231391265__p1114017589475">This guide explains how to use APIs to manage GaussDB(DWS) clusters, including creating, querying, and deleting tags and snapshots. For details about all supported operations, see <a href="dws_02_0034.html">API Overview</a>.</p>
<p id="EN-US_TOPIC_0000001231391265__p1453514534137">Before calling an API, get familiar with related concepts of GaussDB(DWS). For details, see "Service Overview" in the <em id="EN-US_TOPIC_0000001231391265__i6126135912314">Data Warehouse Service User Guide</em>.</p>
<p id="EN-US_TOPIC_0000001231391265__p015144811238">GaussDB(DWS) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="dws_02_0062.html">Calling APIs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001231391265__section102945256216"><h4 class="sectiontitle">Endpoints</h4><p id="EN-US_TOPIC_0000001231391265__p2012412713342">An endpoint is the <strong id="EN-US_TOPIC_0000001231391265__b1047015531339">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see "Regions and Endpoints".</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001231391265__section129413815217"><h4 class="sectiontitle">Basic Concepts</h4><ul id="EN-US_TOPIC_0000001231391265__uad440ee9aedc458c9e5803cdcaf583f3"><li id="EN-US_TOPIC_0000001231391265__l53265badde5b43c3a22e01066a8c0895">Account<p id="EN-US_TOPIC_0000001231391265__a848efff567cd45e3a0ef2ba8583a3b30"><a name="EN-US_TOPIC_0000001231391265__l53265badde5b43c3a22e01066a8c0895"></a><a name="l53265badde5b43c3a22e01066a8c0895"></a>An account has full access permissions for all the resources and cloud services under it. It can reset user passwords and grant users permissions. For security purposes, create IAM users and assign them permissions for routine management.</p>
</li><li id="EN-US_TOPIC_0000001231391265__l543c20abbea64c6aa90c93a218b0649f">User<p id="EN-US_TOPIC_0000001231391265__af28cde395a474665a7bee2209ec76348"><a name="EN-US_TOPIC_0000001231391265__l543c20abbea64c6aa90c93a218b0649f"></a><a name="l543c20abbea64c6aa90c93a218b0649f"></a>An IAM user is created by an account to use cloud services. Each IAM user has its own identity credentials (password or access keys).</p>
<p id="EN-US_TOPIC_0000001231391265__a06eea39f09294213ad2238a3afa823b4">The account name, username, and password will be required for API authentication.</p>
</li><li id="EN-US_TOPIC_0000001231391265__l1df7515fe146487087a6c56e04cce7d2">Region<p id="EN-US_TOPIC_0000001231391265__a1ce56948b7974e819b1c77db09ee7cb7"><a name="EN-US_TOPIC_0000001231391265__l1df7515fe146487087a6c56e04cce7d2"></a><a name="l1df7515fe146487087a6c56e04cce7d2"></a>A region is a geographic area where 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. By creating cloud resources in different regions, you can better meet customer requirements and comply with local laws and regulations.</p>
</li><li id="EN-US_TOPIC_0000001231391265__l0f82f0ff77dd424b99eecb8dcfbb9034">AZ<p id="EN-US_TOPIC_0000001231391265__acddbf6d1a8cc47f3981dcde005f38564"><a name="EN-US_TOPIC_0000001231391265__l0f82f0ff77dd424b99eecb8dcfbb9034"></a><a name="l0f82f0ff77dd424b99eecb8dcfbb9034"></a>An AZ contains one or more physical data centers. Each AZ has independent power and network devices. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.</p>
</li><li id="EN-US_TOPIC_0000001231391265__l4e8b34eb5dad457b941ea6acff92b4ce">Project<p id="EN-US_TOPIC_0000001231391265__ab7f9f66fe89340a4b258cfd634fb12d3"><a name="EN-US_TOPIC_0000001231391265__l4e8b34eb5dad457b941ea6acff92b4ce"></a><a name="l4e8b34eb5dad457b941ea6acff92b4ce"></a>A project corresponds to a region. Default projects are defined to group and physically isolate resources (including compute, storage, and network resources) between different regions. Users can be granted permissions in a default project to access all resources under their accounts in the region associated with the project. For more refined access control, create subprojects under a project and apply for resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.</p>
<div class="fignone" id="EN-US_TOPIC_0000001231391265__fa00898fa7f3c46acb8c9cb021ff58a17"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="EN-US_TOPIC_0000001231391265__i7ac3726ed3ca4e4f9f5181684380e728" src="figure/en-us_image_0000002138022226.png" width="492.1" height="192.64770700000003" title="Click to enlarge" class="imgResize"></span></div>
</li><li id="EN-US_TOPIC_0000001231391265__li206271015325">Enterprise project<p id="EN-US_TOPIC_0000001231391265__p3627315224"><a name="EN-US_TOPIC_0000001231391265__li206271015325"></a><a name="li206271015325"></a>Enterprise projects group and logically isolate resources. An enterprise project can contain resources from different regions, and resources can be transferred between enterprise projects.</p>
</li></ul>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

11
docs/dws/api-ref/dws_02_0058.html
View File

@ -1,11 +0,0 @@
<a name="EN-US_TOPIC_0000001231391261"></a><a name="EN-US_TOPIC_0000001231391261"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body1558595678679"><p id="EN-US_TOPIC_0000001231391261__p14901414121920">GaussDB(DWS) supports representational state transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see <a href="dws_02_0062.html">Calling APIs</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0057.html">Before You Start</a></div>
</div>
</div>

11
docs/dws/api-ref/dws_02_0059.html
View File

@ -1,11 +0,0 @@
<a name="EN-US_TOPIC_0000001186151622"></a><a name="EN-US_TOPIC_0000001186151622"></a>
<h1 class="topictitle1">Endpoints</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001186151622__p2012412713342">An endpoint is the <strong id="EN-US_TOPIC_0000001186151622__b282913474311">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see the <strong id="EN-US_TOPIC_0000001186151622__b149545272229">Regions and Endpoints</strong> section.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0057.html">Before You Start</a></div>
</div>
</div>

26
docs/dws/api-ref/dws_02_0061.html
View File

@ -1,26 +0,0 @@
<a name="EN-US_TOPIC_0000001231472769"></a><a name="EN-US_TOPIC_0000001231472769"></a>
<h1 class="topictitle1">Basic Concepts</h1>
<div id="body8662426"><ul id="EN-US_TOPIC_0000001231472769__uad440ee9aedc458c9e5803cdcaf583f3"><li id="EN-US_TOPIC_0000001231472769__l53265badde5b43c3a22e01066a8c0895">Account<p id="EN-US_TOPIC_0000001231472769__a848efff567cd45e3a0ef2ba8583a3b30"><a name="EN-US_TOPIC_0000001231472769__l53265badde5b43c3a22e01066a8c0895"></a><a name="l53265badde5b43c3a22e01066a8c0895"></a>This account has full access to all cloud services and resources associated with it. It can be used to reset user passwords and grant user permissions. The domain should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.</p>
</li><li id="EN-US_TOPIC_0000001231472769__l543c20abbea64c6aa90c93a218b0649f">Users<p id="EN-US_TOPIC_0000001231472769__af28cde395a474665a7bee2209ec76348"><a name="EN-US_TOPIC_0000001231472769__l543c20abbea64c6aa90c93a218b0649f"></a><a name="l543c20abbea64c6aa90c93a218b0649f"></a>An IAM user is created using an account for cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
<p id="EN-US_TOPIC_0000001231472769__a06eea39f09294213ad2238a3afa823b4">The account name, username, and password are required for API authentication.</p>
</li><li id="EN-US_TOPIC_0000001231472769__l1df7515fe146487087a6c56e04cce7d2">Region<p id="EN-US_TOPIC_0000001231472769__a1ce56948b7974e819b1c77db09ee7cb7"><a name="EN-US_TOPIC_0000001231472769__l1df7515fe146487087a6c56e04cce7d2"></a><a name="l1df7515fe146487087a6c56e04cce7d2"></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="EN-US_TOPIC_0000001231472769__l0f82f0ff77dd424b99eecb8dcfbb9034">AZ<p id="EN-US_TOPIC_0000001231472769__acddbf6d1a8cc47f3981dcde005f38564"><a name="EN-US_TOPIC_0000001231472769__l0f82f0ff77dd424b99eecb8dcfbb9034"></a><a name="l0f82f0ff77dd424b99eecb8dcfbb9034"></a>An AZ contains one or more physical data centers. Each AZ has independent power and network devices. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.</p>
</li><li id="EN-US_TOPIC_0000001231472769__l4e8b34eb5dad457b941ea6acff92b4ce">Item<p id="EN-US_TOPIC_0000001231472769__ab7f9f66fe89340a4b258cfd634fb12d3"><a name="EN-US_TOPIC_0000001231472769__l4e8b34eb5dad457b941ea6acff92b4ce"></a><a name="l4e8b34eb5dad457b941ea6acff92b4ce"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each service region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and apply for resources in the subprojects. IAM users can then be assigned permissions to access only specific resources in the subprojects.</p>
<div class="fignone" id="EN-US_TOPIC_0000001231472769__fa00898fa7f3c46acb8c9cb021ff58a17"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="EN-US_TOPIC_0000001231472769__i7ac3726ed3ca4e4f9f5181684380e728" src="figure/en-us_image_0000001231391281.png" width="492.1" height="192.64770700000003" title="Click to enlarge" class="imgResize"></span></div>
</li><li id="EN-US_TOPIC_0000001231472769__li206271015325">Enterprise project<p id="EN-US_TOPIC_0000001231472769__p3627315224"><a name="EN-US_TOPIC_0000001231472769__li206271015325"></a><a name="li206271015325"></a>Enterprise projects group and manage resources across regions. Resources in enterprise projects are logically isolated from each other. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.</p>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0057.html">Before You Start</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

6
docs/dws/api-ref/dws_02_0063.html
View File

@ -19,7 +19,7 @@
</tr>
<tr id="EN-US_TOPIC_0000001185673174__r8b17dfd690b64ff09a322e290bc49929"><td class="cellrowborder" valign="top" width="24.23%" headers="mcps1.3.2.5.2.3.1.1 "><p id="EN-US_TOPIC_0000001185673174__a192d0d49499b42dea9fcb9823bdcd208">Endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="75.77000000000001%" headers="mcps1.3.2.5.2.3.1.2 "><p id="EN-US_TOPIC_0000001185673174__p14221174382419">Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from the "Regions and Endpoints" section.</p>
<td class="cellrowborder" valign="top" width="75.77000000000001%" headers="mcps1.3.2.5.2.3.1.2 "><p id="EN-US_TOPIC_0000001185673174__p14221174382419">Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies between services in different regions. It can be obtained from the "Regions and Endpoints" section.</p>
<p id="EN-US_TOPIC_0000001185673174__p15129619134716">For example, the endpoint of IAM in the <span class="parmname" id="EN-US_TOPIC_0000001185673174__parmname51291019104710"><b>eu-de</b></span> region is <span class="parmname" id="EN-US_TOPIC_0000001185673174__parmname144291017134818"><b>iam.eu-de.otc.t-systems.com</b></span>.</p>
</td>
</tr>
@ -170,13 +170,13 @@
</table>
</div>
</div>
<p id="EN-US_TOPIC_0000001185673174__a7ce99c8135d542989f3542afb96dd667">The API used to obtain a user token does not require authentication. Therefore, only the <strong id="EN-US_TOPIC_0000001185673174__b82371683910">Content-type</strong> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
<p id="EN-US_TOPIC_0000001185673174__a7ce99c8135d542989f3542afb96dd667">The API used to obtain a user token does not require authentication. Therefore, only the <strong id="EN-US_TOPIC_0000001185673174__b5131103910610">Content-type</strong> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
</div>
<pre class="screen" id="EN-US_TOPIC_0000001185673174__screen1661199175017">POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens
Content-type: application/json</pre>
<div class="section" id="EN-US_TOPIC_0000001185673174__s21ef4bef3df240f894aa42ca2d98b09d"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001185673174__a3bf1f51bf4824445bf1c20e429a46bf9">The body of a request is often sent in a structured format (JSON or XML) as specified in the <strong id="EN-US_TOPIC_0000001185673174__b632016401402">Content-type</strong> header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be coded in UTF-8.</p>
<p id="EN-US_TOPIC_0000001185673174__a50662a6ce4c846e7953ee4878b1ba180">The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.</p>
<p id="EN-US_TOPIC_0000001185673174__a07dd23d016a54619aaf564145a0d5359">In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="EN-US_TOPIC_0000001185673174__i197652019142215"><strong id="EN-US_TOPIC_0000001185673174__b07651719182216">user_name</strong></em>, <em id="EN-US_TOPIC_0000001185673174__i8766131962213"><strong id="EN-US_TOPIC_0000001185673174__b1276631915221">domainname</strong></em> (account name), <strong id="EN-US_TOPIC_0000001185673174__b67671319112220"><em id="EN-US_TOPIC_0000001185673174__i207661819192216">********</em></strong> (login password), and <strong id="EN-US_TOPIC_0000001185673174__b9768101918228"><em id="EN-US_TOPIC_0000001185673174__i176719198222">xxxxxxxxxxxxxxxxxx</em></strong> (project ID) with actual ones. Obtain the project ID from the database administrator.</p>
<p id="EN-US_TOPIC_0000001185673174__a07dd23d016a54619aaf564145a0d5359">In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="EN-US_TOPIC_0000001185673174__i162061515576"><strong id="EN-US_TOPIC_0000001185673174__b3206615777">user_name</strong></em>, <em id="EN-US_TOPIC_0000001185673174__i020661513718"><strong id="EN-US_TOPIC_0000001185673174__b220618150717">domainname</strong></em> (account name), <strong id="EN-US_TOPIC_0000001185673174__b22064151372"><em id="EN-US_TOPIC_0000001185673174__i1820613152715">********</em></strong> (login password), and <strong id="EN-US_TOPIC_0000001185673174__b1620616151717"><em id="EN-US_TOPIC_0000001185673174__i17206415572">xxxxxxxxxxxxxxxxxx</em></strong> (project ID) with actual ones. Obtain the project ID from the database administrator.</p>
<div class="note" id="EN-US_TOPIC_0000001185673174__n63aedb76c20e4323affd745b04933f46"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001185673174__a8dac7f39ed004dada7547fcfb9a40b22">The <strong id="EN-US_TOPIC_0000001185673174__b55015220182">scope</strong> parameter specifies where a token takes effect. In the example, the token takes effect only on the resources specified by the project. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.</p>
</div></div>
<pre class="screen" id="EN-US_TOPIC_0000001185673174__se0d2d43430e24faea81ddd913e36a0e5">POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens

4
docs/dws/api-ref/dws_02_0064.html
View File

@ -5,7 +5,7 @@
<div class="section" id="EN-US_TOPIC_0000001231391263__se42eaf07b9464e7b8becd7c3cb824afb"><h4 class="sectiontitle">Token-based Authentication</h4><p id="EN-US_TOPIC_0000001231391263__a5e74a303f7e7490e973e81e4d0a3e6fb">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to request headers to get permissions for calling the API.</p>
<div class="note" id="EN-US_TOPIC_0000001231391263__note185371034218"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001231391263__p1753714319217">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</p>
</div></div>
<p id="EN-US_TOPIC_0000001231391263__p1160363317231">When calling the API to obtain a user token, you must set <strong id="EN-US_TOPIC_0000001231391263__b357314505014">auth.scope</strong> in the request body to <strong id="EN-US_TOPIC_0000001231391263__b12450131312504">project</strong>.</p>
<p id="EN-US_TOPIC_0000001231391263__p1160363317231">When calling the API to obtain a user token, you must set <strong id="EN-US_TOPIC_0000001231391263__b4383338475">auth.scope</strong> in the request body to <strong id="EN-US_TOPIC_0000001231391263__b123831038179">project</strong>.</p>
<pre class="screen" id="EN-US_TOPIC_0000001231391263__screen1954692813282">{
"auth": {
"identity": {
@ -29,7 +29,7 @@
<strong id="EN-US_TOPIC_0000001231391263__b6546162815283"> }</strong>
}
}</pre>
<p id="EN-US_TOPIC_0000001231391263__a212a74e9785342f9a44bb4d6d62c25f1">After a token is obtained, the <strong id="EN-US_TOPIC_0000001231391263__b15928143912512">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <span class="parmvalue" id="EN-US_TOPIC_0000001231391263__parmvalue27267718616"><b>ABCDEFJ....</b></span>, <span class="parmvalue" id="EN-US_TOPIC_0000001231391263__parmvalue4100115163"><b>X-Auth-Token: ABCDEFJ....</b></span> can be added to a request.</p>
<p id="EN-US_TOPIC_0000001231391263__a212a74e9785342f9a44bb4d6d62c25f1">After a token is obtained, the <strong id="EN-US_TOPIC_0000001231391263__b15928143912512">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. If the token is <span class="parmvalue" id="EN-US_TOPIC_0000001231391263__parmvalue34114919715"><b>ABCDEFG....</b></span>, add <span class="parmvalue" id="EN-US_TOPIC_0000001231391263__parmvalue154114491876"><b>X-Auth-Token: ABCDEFG....</b></span> to a request.</p>
</div>
</div>
<div>

2
docs/dws/api-ref/dws_02_0066.html
View File

@ -13,7 +13,7 @@
</li>
<li class="ulchildlink"><strong><a href="dws_02_0011.html">Obtaining a Project ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dws_02_0067.html">Obtaining an Account ID</a></strong><br>
<li class="ulchildlink"><strong><a href="dws_02_0067.html">Obtaining an Account</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dws_02_00068.html">Obtaining the Cluster ID</a></strong><br>
</li>

6
docs/dws/api-ref/dws_02_0067.html
View File

@ -1,8 +1,8 @@
<a name="EN-US_TOPIC_0000001231631315"></a><a name="EN-US_TOPIC_0000001231631315"></a>
<h1 class="topictitle1">Obtaining an Account ID</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001231631315__a2bf578b6ede2475991f4a636cc4c559d">An account ID is required for some URLs when an API is called. To obtain the account ID, perform the following steps:</p>
<ol id="EN-US_TOPIC_0000001231631315__oe9c190f940244d3eac2560d625b2d433"><li id="EN-US_TOPIC_0000001231631315__l9f6fc4c033c443679e30407beddb0a49">Log in to the management console.</li><li id="EN-US_TOPIC_0000001231631315__l53b1f18b1c6e46f9aff8c9aaef26a025">Click the username and select <span class="uicontrol" id="EN-US_TOPIC_0000001231631315__uicontrol17963114114206"><b>My Credential</b></span> from the drop-down list.<p id="EN-US_TOPIC_0000001231631315__en-us_topic_0170949686_p136772519449">On the <strong id="EN-US_TOPIC_0000001231631315__en-us_topic_0170949686_b151241857155215">My Credential</strong> page, view the <strong id="EN-US_TOPIC_0000001231631315__b1433342102">Account ID</strong>.</p>
<h1 class="topictitle1">Obtaining an Account</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001231631315__a2bf578b6ede2475991f4a636cc4c559d">An account ID (<strong id="EN-US_TOPIC_0000001231631315__b061710161318">domain-id</strong>) is required for some URLs when an API is called. To obtain the account ID, do as follows:</p>
<ol id="EN-US_TOPIC_0000001231631315__oe9c190f940244d3eac2560d625b2d433"><li id="EN-US_TOPIC_0000001231631315__l9f6fc4c033c443679e30407beddb0a49">Log in to the management console.</li><li id="EN-US_TOPIC_0000001231631315__l53b1f18b1c6e46f9aff8c9aaef26a025">Click the username and select <span class="uicontrol" id="EN-US_TOPIC_0000001231631315__uicontrol17963114114206"><b>My Credential</b></span> from the drop-down list.<p id="EN-US_TOPIC_0000001231631315__en-us_topic_0170949686_p136772519449">On the <strong id="EN-US_TOPIC_0000001231631315__b013711020149">My Credential</strong> page, view the <strong id="EN-US_TOPIC_0000001231631315__b71374012146">Account ID</strong>.</p>
</li></ol>
</div>
<div>

BIN
docs/dws/api-ref/figure/en-us_image_0000001231391281.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 57 KiB

BIN
docs/dws/api-ref/figure/en-us_image_0000002138022226.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 68 KiB