forked from docs/doc-exports
DWS API 2022101001 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Lu, Huayi <luhuayi@huawei.com> Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
This commit is contained in:
parent
ea05d1a734
commit
b974c4b77e
442
docs/dws/api-ref/ALL_META.TXT.json
Normal file
442
docs/dws/api-ref/ALL_META.TXT.json
Normal file
File diff suppressed because it is too large
Load Diff
398
docs/dws/api-ref/CLASS.TXT.json
Normal file
398
docs/dws/api-ref/CLASS.TXT.json
Normal file
File diff suppressed because it is too large
Load Diff
3
docs/dws/api-ref/PARAMETERS.txt
Normal file
3
docs/dws/api-ref/PARAMETERS.txt
Normal file
@ -0,0 +1,3 @@
|
||||
version=""
|
||||
language="en-us"
|
||||
type=""
|
||||
20
docs/dws/api-ref/dws_02_00068.html
Normal file
20
docs/dws/api-ref/dws_02_00068.html
Normal file
@ -0,0 +1,20 @@
|
||||
<a name="EN-US_TOPIC_0000001134564666"></a><a name="EN-US_TOPIC_0000001134564666"></a>
|
||||
|
||||
<h1 class="topictitle1">Obtaining the Cluster ID</h1>
|
||||
<div id="body0000001152821509"><p id="EN-US_TOPIC_0000001134564666__p8112855194115">A cluster ID (<strong id="EN-US_TOPIC_0000001134564666__b1089073210919">cluster_id</strong>) is required for some URLs when an API is called. To obtain a cluster ID, perform the following operations:</p>
|
||||
<ol id="EN-US_TOPIC_0000001134564666__ol8715914194127"><li id="EN-US_TOPIC_0000001134564666__li50056756194127">Log in to the GaussDB(DWS) console.</li><li id="EN-US_TOPIC_0000001134564666__li8101150195810">In the navigation pane on the left, click <span class="parmname" id="EN-US_TOPIC_0000001134564666__parmname4861141721013"><b>Clusters</b></span>.</li><li id="EN-US_TOPIC_0000001134564666__li4130312894059">In the cluster list, find the target cluster and click the cluster name. The <span class="wintitle" id="EN-US_TOPIC_0000001134564666__wintitle1585114251106"><b>Basic Information</b></span> page is displayed.</li><li id="EN-US_TOPIC_0000001134564666__li18561738165911">View the cluster ID.<div class="fignone" id="EN-US_TOPIC_0000001134564666__fig12772124111110"><span class="figcap"><b>Figure 1 </b>Viewing the cluster ID</span><br><span><img id="EN-US_TOPIC_0000001134564666__image177319411119" src="figure/en-us_image_0000001134404912.png" height="145.0764" width="430.92" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</li></ol>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0066.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
||||
49
docs/dws/api-ref/dws_02_0011.html
Normal file
49
docs/dws/api-ref/dws_02_0011.html
Normal file
@ -0,0 +1,49 @@
|
||||
<a name="EN-US_TOPIC_0000001180324307"></a><a name="EN-US_TOPIC_0000001180324307"></a>
|
||||
|
||||
<h1 class="topictitle1">Obtaining a Project ID</h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001180324307__section1691341861315"><h4 class="sectiontitle">Obtaining a Project ID by Calling the API</h4><p id="EN-US_TOPIC_0000001180324307__p17202369450">You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.</p>
|
||||
<p id="EN-US_TOPIC_0000001180324307__p82371314564">The API used to obtain a project ID is <strong id="EN-US_TOPIC_0000001180324307__b19783014473">GET https://{</strong><em id="EN-US_TOPIC_0000001180324307__i2097811024715">Endpoint</em><strong id="EN-US_TOPIC_0000001180324307__b797913011477">}/v3/projects/</strong>. {<em id="EN-US_TOPIC_0000001180324307__i89797016472">Endpoint</em>} indicates the IAM endpoint and can be obtained from "Regions and Endpoints". For details about API authentication, see <a href="dws_02_0064.html">Authentication</a>.</p>
|
||||
<p id="EN-US_TOPIC_0000001180324307__p1461198134114">The following is an example response. The value of <strong id="EN-US_TOPIC_0000001180324307__b16167660476">id</strong> of <strong id="EN-US_TOPIC_0000001180324307__b51727644714">projects</strong> indicates the project ID.</p>
|
||||
<pre class="screen" id="EN-US_TOPIC_0000001180324307__screen676419149446">{
|
||||
"projects": [
|
||||
{
|
||||
"domain_id": "65382450e8f64ac0870cd180d14e684b",
|
||||
"is_domain": false,
|
||||
"parent_id": "65382450e8f64ac0870cd180d14e684b",
|
||||
"name": "eu-de-01",
|
||||
"description": "",
|
||||
"links": {
|
||||
"next": null,
|
||||
"previous": null,
|
||||
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
|
||||
},
|
||||
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
|
||||
"enabled": true
|
||||
}
|
||||
],
|
||||
"links": {
|
||||
"next": null,
|
||||
"previous": null,
|
||||
"self": "https://www.example.com/v3/projects"
|
||||
}
|
||||
}</pre>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000001180324307__section59621329127"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="EN-US_TOPIC_0000001180324307__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="EN-US_TOPIC_0000001180324307__ol8715914194127"><li id="EN-US_TOPIC_0000001180324307__li50056756194127">Log in to the management console.</li><li id="EN-US_TOPIC_0000001180324307__li2804809915217">Click the username and select <strong id="EN-US_TOPIC_0000001180324307__b1152113276479">My Credential</strong> from the drop-down list.<p id="EN-US_TOPIC_0000001180324307__p136772519449">On the <strong id="EN-US_TOPIC_0000001180324307__b144471432144720">My Credential</strong> page, view the project ID in the project list.</p>
|
||||
</li></ol>
|
||||
<div class="fignone" id="EN-US_TOPIC_0000001180324307__fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="EN-US_TOPIC_0000001180324307__image538470016132" src="figure/en-us_image_0000001180324341.jpg" height="161.19600000000003" width="465.53325" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0066.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
||||
30
docs/dws/api-ref/dws_02_0017.html
Normal file
30
docs/dws/api-ref/dws_02_0017.html
Normal file
@ -0,0 +1,30 @@
|
||||
<a name="EN-US_TOPIC_0000001179325978"></a><a name="EN-US_TOPIC_0000001179325978"></a>
|
||||
|
||||
<h1 class="topictitle1">Cluster Management APIs</h1>
|
||||
<div id="body8662426"><p id="EN-US_TOPIC_0000001179325978__en-us_topic_0000001145696553_en-us_topic_0067607265_p22802807">A data warehouse cluster is the smallest management unit in GaussDB(DWS). A cluster is a data warehouse that runs independently. You can manage the cluster life cycle in GaussDB(DWS).</p>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0020.html">Creating a Cluster</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0018.html">Querying the Cluster List</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0019.html">Querying Cluster Details</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0022.html">Querying the Supported Node Types</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0021.html">Deleting a Cluster</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0052.html">Restarting a Cluster</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0053.html">Scaling Out Clusters</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0054.html">Resetting a Password</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0037.html">API Description</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
497
docs/dws/api-ref/dws_02_0018.html
Normal file
497
docs/dws/api-ref/dws_02_0018.html
Normal file
File diff suppressed because it is too large
Load Diff
677
docs/dws/api-ref/dws_02_0019.html
Normal file
677
docs/dws/api-ref/dws_02_0019.html
Normal file
File diff suppressed because it is too large
Load Diff
342
docs/dws/api-ref/dws_02_0020.html
Normal file
342
docs/dws/api-ref/dws_02_0020.html
Normal file
File diff suppressed because it is too large
Load Diff
123
docs/dws/api-ref/dws_02_0021.html
Normal file
123
docs/dws/api-ref/dws_02_0021.html
Normal file
File diff suppressed because it is too large
Load Diff
217
docs/dws/api-ref/dws_02_0022.html
Normal file
217
docs/dws/api-ref/dws_02_0022.html
Normal file
File diff suppressed because it is too large
Load Diff
24
docs/dws/api-ref/dws_02_0023.html
Normal file
24
docs/dws/api-ref/dws_02_0023.html
Normal file
@ -0,0 +1,24 @@
|
||||
<a name="EN-US_TOPIC_0000001224324259"></a><a name="EN-US_TOPIC_0000001224324259"></a>
|
||||
|
||||
<h1 class="topictitle1">Snapshot Management APIs</h1>
|
||||
<div id="body8662426"><p id="EN-US_TOPIC_0000001224324259__en-us_topic_0000001145816487_en-us_topic_0067607270_p52610097">A GaussDB(DWS) snapshot is a complete backup of a cluster. Snapshots are stored in the storage space of Object Storage Service (OBS). A snapshot can be used to restore a cluster to a newly created one that has the same flavor. Currently, you can only restore a cluster to a new one.</p>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0026.html">Creating a Snapshot</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0024.html">Querying the Snapshot List</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0025.html">Querying Snapshot Details</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0027.html">Deleting a Manual Snapshot</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0032.html">Restoring a Cluster</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0037.html">API Description</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
218
docs/dws/api-ref/dws_02_0024.html
Normal file
218
docs/dws/api-ref/dws_02_0024.html
Normal file
File diff suppressed because it is too large
Load Diff
205
docs/dws/api-ref/dws_02_0025.html
Normal file
205
docs/dws/api-ref/dws_02_0025.html
Normal file
File diff suppressed because it is too large
Load Diff
202
docs/dws/api-ref/dws_02_0026.html
Normal file
202
docs/dws/api-ref/dws_02_0026.html
Normal file
File diff suppressed because it is too large
Load Diff
96
docs/dws/api-ref/dws_02_0027.html
Normal file
96
docs/dws/api-ref/dws_02_0027.html
Normal file
@ -0,0 +1,96 @@
|
||||
<a name="EN-US_TOPIC_0000001224565745"></a><a name="EN-US_TOPIC_0000001224565745"></a>
|
||||
|
||||
<h1 class="topictitle1">Deleting a Manual Snapshot</h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_sfcf2baffe2ad46fa81d55b2dd2bf89bc"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p61948991">This API is used to delete a specified manual snapshot.</p>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_s38a27afad7024ce3852e9847fd94c040"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_ul51812368"><li id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_li63658128">URI format<pre class="screen" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_screen1079321015012">DELETE /v1.0/{project_id}/snapshots/{snapshot_id}</pre>
|
||||
</li><li id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_li56034750">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_table34550710" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row5432205"><th align="left" class="cellrowborder" valign="top" width="21.94%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p37355470"><strong id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_b84235270617228">Parameter</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="9.58%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p5894231"><strong id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_b6167984116271">Mandatory</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="14.549999999999999%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p7670737"><strong id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_b69941525152915">Type</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="53.93%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p17349988"><strong id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_b714132712918">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row63171767"><td class="cellrowborder" valign="top" width="21.94%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p16639474">project_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="9.58%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p5620158">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.549999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p52579650">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="53.93%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_p1590591325620"><span id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_text423318288346">Project ID</span>. For details about how to obtain the ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row11404133"><td class="cellrowborder" valign="top" width="21.94%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p51319614">snapshot_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="9.58%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p63248075">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.549999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p22820469">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="53.93%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p36518691">Snapshot ID</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_s649ab73a82e34ecd9160b0060a337f92"><h4 class="sectiontitle">Request Message</h4><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p47015983">Request example</p>
|
||||
<pre class="screen" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_seb9e3c7b2af74d8c9cad3f803001950c">DELETE /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90</pre>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_sbec897acaf7347c0ac1723e38546a861"><h4 class="sectiontitle">Response Message</h4><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_ae2924842b5904a118308ed261f8b59b6">Example response</p>
|
||||
<pre class="screen" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_sb107adb3038247f78687e1abf257405f">status CODE 202</pre>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_s33606771ebd747ddac1c88ee301f2aea"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_ul20226985"><li id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_li47825138">Normal<p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p27773061"><a name="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_li47825138"></a><a name="en-us_topic_0000001098976614_en-us_topic_0067607271_li47825138"></a>202</p>
|
||||
</li><li id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_li48630964">Exception
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_table35025494" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Returned values</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row59481773"><th align="left" class="cellrowborder" valign="top" width="31.64%" id="mcps1.3.5.2.2.1.2.3.1.1"><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p53294272"><strong id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_b842352706104927">Returned Value</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="68.36%" id="mcps1.3.5.2.2.1.2.3.1.2"><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p21868813"><strong id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_b16565163952917">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row26543418"><td class="cellrowborder" valign="top" width="31.64%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p2533231">400 Bad Request</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="68.36%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p3865173">Request error.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row34786562"><td class="cellrowborder" valign="top" width="31.64%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p66248115">401 Unauthorized</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="68.36%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p64497130">Authorization failed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row43603258"><td class="cellrowborder" valign="top" width="31.64%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p42202994">403 Forbidden</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="68.36%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p62999330">No operation permission.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row30123063"><td class="cellrowborder" valign="top" width="31.64%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p24049039">404 Not Found</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="68.36%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p1815156">No resources found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row16336406"><td class="cellrowborder" valign="top" width="31.64%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p48180537">500 Internal Server Error</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="68.36%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p10309404">Internal service error.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_row25675773"><td class="cellrowborder" valign="top" width="31.64%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p66471715">503 Service Unavailable</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="68.36%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224565745__en-us_topic_0000001098976614_en-us_topic_0067607271_p15499871">The service is unavailable.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0023.html">Snapshot Management APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
1205
docs/dws/api-ref/dws_02_0030.html
Normal file
1205
docs/dws/api-ref/dws_02_0030.html
Normal file
File diff suppressed because it is too large
Load Diff
125
docs/dws/api-ref/dws_02_0031.html
Normal file
125
docs/dws/api-ref/dws_02_0031.html
Normal file
File diff suppressed because it is too large
Load Diff
296
docs/dws/api-ref/dws_02_0032.html
Normal file
296
docs/dws/api-ref/dws_02_0032.html
Normal file
File diff suppressed because it is too large
Load Diff
13
docs/dws/api-ref/dws_02_0033.html
Normal file
13
docs/dws/api-ref/dws_02_0033.html
Normal file
@ -0,0 +1,13 @@
|
||||
<a name="EN-US_TOPIC_0000001134564654"></a><a name="EN-US_TOPIC_0000001134564654"></a>
|
||||
|
||||
<h1 class="topictitle1">Overview</h1>
|
||||
<div id="body1558595678679"><p id="EN-US_TOPIC_0000001134564654__p19736105151614">Welcome to GaussDB(DWS). GaussDB(DWS) is a fully-managed and enterprise-level cloud data warehouse service. It is O&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_0000001134564654__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_0000001134564654__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_0000001134564654__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>
|
||||
|
||||
119
docs/dws/api-ref/dws_02_0034.html
Normal file
119
docs/dws/api-ref/dws_02_0034.html
Normal file
File diff suppressed because it is too large
Load Diff
252
docs/dws/api-ref/dws_02_0036.html
Normal file
252
docs/dws/api-ref/dws_02_0036.html
Normal file
File diff suppressed because it is too large
Load Diff
16
docs/dws/api-ref/dws_02_0037.html
Normal file
16
docs/dws/api-ref/dws_02_0037.html
Normal file
@ -0,0 +1,16 @@
|
||||
<a name="EN-US_TOPIC_0000001180324317"></a><a name="EN-US_TOPIC_0000001180324317"></a>
|
||||
|
||||
<h1 class="topictitle1">API Description</h1>
|
||||
<div id="body1515046619563"><p id="EN-US_TOPIC_0000001180324317__p8060118"></p>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0017.html">Cluster Management APIs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0023.html">Snapshot Management APIs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0045.html">Tag Management APIs</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
322
docs/dws/api-ref/dws_02_0038.html
Normal file
322
docs/dws/api-ref/dws_02_0038.html
Normal file
File diff suppressed because it is too large
Load Diff
17
docs/dws/api-ref/dws_02_0040.html
Normal file
17
docs/dws/api-ref/dws_02_0040.html
Normal file
@ -0,0 +1,17 @@
|
||||
<a name="EN-US_TOPIC_0000001180324337"></a><a name="EN-US_TOPIC_0000001180324337"></a>
|
||||
|
||||
<h1 class="topictitle1">Creating a VPC</h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001180324337__s948f0698a47a40e09094c0cb9df6365b"><h4 class="sectiontitle">Background</h4><p id="EN-US_TOPIC_0000001180324337__aabff60c980794bf999bfa0cdd71ebf01">Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using GaussDB(DWS).</p>
|
||||
<p id="EN-US_TOPIC_0000001180324337__a834be97f349749e3b52f3a76ccd2a1ee">If you have already created a VPC, you do not need to create it again.</p>
|
||||
<div class="note" id="EN-US_TOPIC_0000001180324337__n15cdb88d42674570a6706cc728e39f24"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001180324337__p1345165175612">For details about how to create a VPC, see <strong id="EN-US_TOPIC_0000001180324337__b138841254383">Creating a VPC</strong> in the <i><cite id="EN-US_TOPIC_0000001180324337__cited1a29e6ebc4549bbabf53c20a9ab196e111043">Virtual Private Cloud User Guide</cite></i>.</p>
|
||||
</div></div>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000001180324337__s46f28ae5845c454daad876db98c0fa95"><h4 class="sectiontitle">Procedure</h4><ol id="EN-US_TOPIC_0000001180324337__o62d71e36f4b542ab8dd2bf2435662e07"><li id="EN-US_TOPIC_0000001180324337__l056285aa52c049c989e91d47dcf5dd1a"><span>Log in to the management console.</span></li><li id="EN-US_TOPIC_0000001180324337__lb27affb5ad3c4f35b70481e9d21d6baf"><span>Under <strong id="EN-US_TOPIC_0000001180324337__b842352706161257">Network</strong>, click <strong id="EN-US_TOPIC_0000001180324337__b842352706161254">Virtual Private Cloud</strong>.</span></li><li id="EN-US_TOPIC_0000001180324337__l6f63f6a57b4d41d9999483b7c4793e6d"><span>On the <span class="wintitle" id="EN-US_TOPIC_0000001180324337__wintitle64893697102152"><b>Virtual Private Cloud</b></span> page, click <span class="uicontrol" id="EN-US_TOPIC_0000001180324337__uicontrol23094277710227"><b>Create VPC</b></span> to create a VPC. </span></li><li id="EN-US_TOPIC_0000001180324337__en-us_topic_0091558258_li10487137378"><span>Obtain the VPC and subnet ID for subsequent use in <a href="dws_02_0020.html">Creating a Cluster</a>.</span></li><li id="EN-US_TOPIC_0000001180324337__li658113542071"><span>On the <span class="wintitle" id="EN-US_TOPIC_0000001180324337__wintitle20650655191213"><b>Virtual Private Cloud</b></span> page, choose <span class="uicontrol" id="EN-US_TOPIC_0000001180324337__uicontrol1985625661318"><b>Access Control</b></span> > <strong id="EN-US_TOPIC_0000001180324337__b186061053141">Security Groups</strong> in the navigation tree on the left, and click <span class="uicontrol" id="EN-US_TOPIC_0000001180324337__uicontrol13325132811144"><b>Create Security Group</b></span> to create a security group.</span></li><li id="EN-US_TOPIC_0000001180324337__li607486152071"><span>Obtain the security group ID for subsequent use in <a href="dws_02_0020.html">Creating a Cluster</a>.</span></li></ol>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0066.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
28
docs/dws/api-ref/dws_02_0045.html
Normal file
28
docs/dws/api-ref/dws_02_0045.html
Normal file
@ -0,0 +1,28 @@
|
||||
<a name="EN-US_TOPIC_0000001134564668"></a><a name="EN-US_TOPIC_0000001134564668"></a>
|
||||
|
||||
<h1 class="topictitle1">Tag Management APIs</h1>
|
||||
<div id="body1524298666228"><p id="EN-US_TOPIC_0000001134564668__p8060118"></p>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0055.html">Tagging</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0046.html">Adding a Resource Tag</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0047.html">Adding or Deleting Resource Tags in Batches</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0048.html">Querying Resources by Tag</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0049.html">Querying Resource Tags</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0050.html">Querying Tags in a Specified Project</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0051.html">Deleting a Resource Tag</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0037.html">API Description</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
168
docs/dws/api-ref/dws_02_0046.html
Normal file
168
docs/dws/api-ref/dws_02_0046.html
Normal file
File diff suppressed because it is too large
Load Diff
185
docs/dws/api-ref/dws_02_0047.html
Normal file
185
docs/dws/api-ref/dws_02_0047.html
Normal file
File diff suppressed because it is too large
Load Diff
491
docs/dws/api-ref/dws_02_0048.html
Normal file
491
docs/dws/api-ref/dws_02_0048.html
Normal file
File diff suppressed because it is too large
Load Diff
158
docs/dws/api-ref/dws_02_0049.html
Normal file
158
docs/dws/api-ref/dws_02_0049.html
Normal file
File diff suppressed because it is too large
Load Diff
157
docs/dws/api-ref/dws_02_0050.html
Normal file
157
docs/dws/api-ref/dws_02_0050.html
Normal file
File diff suppressed because it is too large
Load Diff
102
docs/dws/api-ref/dws_02_0051.html
Normal file
102
docs/dws/api-ref/dws_02_0051.html
Normal file
File diff suppressed because it is too large
Load Diff
123
docs/dws/api-ref/dws_02_0052.html
Normal file
123
docs/dws/api-ref/dws_02_0052.html
Normal file
File diff suppressed because it is too large
Load Diff
149
docs/dws/api-ref/dws_02_0053.html
Normal file
149
docs/dws/api-ref/dws_02_0053.html
Normal file
File diff suppressed because it is too large
Load Diff
127
docs/dws/api-ref/dws_02_0054.html
Normal file
127
docs/dws/api-ref/dws_02_0054.html
Normal file
File diff suppressed because it is too large
Load Diff
14
docs/dws/api-ref/dws_02_0055.html
Normal file
14
docs/dws/api-ref/dws_02_0055.html
Normal file
@ -0,0 +1,14 @@
|
||||
<a name="EN-US_TOPIC_0000001180444233"></a><a name="EN-US_TOPIC_0000001180444233"></a>
|
||||
|
||||
<h1 class="topictitle1">Tagging</h1>
|
||||
<div id="body1542853434265"><p id="EN-US_TOPIC_0000001180444233__p985684415815">A tag is a key-value pair customized by users and used to classify and search for cloud resources.</p>
|
||||
<p id="EN-US_TOPIC_0000001180444233__p9313135654918">A tag consists of a tag key and a tag value.</p>
|
||||
<ul id="EN-US_TOPIC_0000001180444233__ul81873195011"><li id="EN-US_TOPIC_0000001180444233__li1172355019">A tag key can contain multiple tag values.</li><li id="EN-US_TOPIC_0000001180444233__li31716319509">A cloud resource cannot have duplicate tag keys.</li></ul>
|
||||
<p id="EN-US_TOPIC_0000001180444233__p1479617361845">On GaussDB(DWS), only cluster resources support the tag function.</p>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0045.html">Tag Management APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
284
docs/dws/api-ref/dws_02_0056.html
Normal file
284
docs/dws/api-ref/dws_02_0056.html
Normal file
File diff suppressed because it is too large
Load Diff
17
docs/dws/api-ref/dws_02_0057.html
Normal file
17
docs/dws/api-ref/dws_02_0057.html
Normal file
@ -0,0 +1,17 @@
|
||||
<a name="EN-US_TOPIC_0000001134404876"></a><a name="EN-US_TOPIC_0000001134404876"></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>
|
||||
|
||||
11
docs/dws/api-ref/dws_02_0058.html
Normal file
11
docs/dws/api-ref/dws_02_0058.html
Normal file
@ -0,0 +1,11 @@
|
||||
<a name="EN-US_TOPIC_0000001134404870"></a><a name="EN-US_TOPIC_0000001134404870"></a>
|
||||
|
||||
<h1 class="topictitle1">API Calling</h1>
|
||||
<div id="body1558595678679"><p id="EN-US_TOPIC_0000001134404870__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
Normal file
11
docs/dws/api-ref/dws_02_0059.html
Normal file
@ -0,0 +1,11 @@
|
||||
<a name="EN-US_TOPIC_0000001134564650"></a><a name="EN-US_TOPIC_0000001134564650"></a>
|
||||
|
||||
<h1 class="topictitle1">Endpoints</h1>
|
||||
<div id="body8662426"><p id="EN-US_TOPIC_0000001134564650__p2012412713342">An endpoint is the <strong id="EN-US_TOPIC_0000001134564650__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_0000001134564650__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
Normal file
26
docs/dws/api-ref/dws_02_0061.html
Normal file
@ -0,0 +1,26 @@
|
||||
<a name="EN-US_TOPIC_0000001180444263"></a><a name="EN-US_TOPIC_0000001180444263"></a>
|
||||
|
||||
<h1 class="topictitle1">Basic Concepts</h1>
|
||||
<div id="body8662426"><ul id="EN-US_TOPIC_0000001180444263__uad440ee9aedc458c9e5803cdcaf583f3"><li id="EN-US_TOPIC_0000001180444263__l53265badde5b43c3a22e01066a8c0895">Account<p id="EN-US_TOPIC_0000001180444263__a848efff567cd45e3a0ef2ba8583a3b30"><a name="EN-US_TOPIC_0000001180444263__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_0000001180444263__l543c20abbea64c6aa90c93a218b0649f">Users<p id="EN-US_TOPIC_0000001180444263__af28cde395a474665a7bee2209ec76348"><a name="EN-US_TOPIC_0000001180444263__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_0000001180444263__a06eea39f09294213ad2238a3afa823b4">The account name, username, and password are required for API authentication.</p>
|
||||
</li><li id="EN-US_TOPIC_0000001180444263__l1df7515fe146487087a6c56e04cce7d2">Region<p id="EN-US_TOPIC_0000001180444263__a1ce56948b7974e819b1c77db09ee7cb7"><a name="EN-US_TOPIC_0000001180444263__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_0000001180444263__l0f82f0ff77dd424b99eecb8dcfbb9034">AZ<p id="EN-US_TOPIC_0000001180444263__acddbf6d1a8cc47f3981dcde005f38564"><a name="EN-US_TOPIC_0000001180444263__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_0000001180444263__l4e8b34eb5dad457b941ea6acff92b4ce">Item<p id="EN-US_TOPIC_0000001180444263__ab7f9f66fe89340a4b258cfd634fb12d3"><a name="EN-US_TOPIC_0000001180444263__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_0000001180444263__fa00898fa7f3c46acb8c9cb021ff58a17"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="EN-US_TOPIC_0000001180444263__i7ac3726ed3ca4e4f9f5181684380e728" src="figure/en-us_image_0000001180444281.png" width="492.1" height="192.64770700000003" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</li><li id="EN-US_TOPIC_0000001180444263__li206271015325">Enterprise project<p id="EN-US_TOPIC_0000001180444263__p3627315224"><a name="EN-US_TOPIC_0000001180444263__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>
|
||||
15
docs/dws/api-ref/dws_02_0062.html
Normal file
15
docs/dws/api-ref/dws_02_0062.html
Normal file
@ -0,0 +1,15 @@
|
||||
<a name="EN-US_TOPIC_0000001134404904"></a><a name="EN-US_TOPIC_0000001134404904"></a>
|
||||
|
||||
<h1 class="topictitle1">Calling APIs</h1>
|
||||
<div id="body8662426"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0063.html">Making an API Request</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0064.html">Authentication</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0065.html">Response</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
216
docs/dws/api-ref/dws_02_0063.html
Normal file
216
docs/dws/api-ref/dws_02_0063.html
Normal file
File diff suppressed because it is too large
Load Diff
40
docs/dws/api-ref/dws_02_0064.html
Normal file
40
docs/dws/api-ref/dws_02_0064.html
Normal file
@ -0,0 +1,40 @@
|
||||
<a name="EN-US_TOPIC_0000001134564658"></a><a name="EN-US_TOPIC_0000001134564658"></a>
|
||||
|
||||
<h1 class="topictitle1">Authentication</h1>
|
||||
<div id="body8662426"><p id="EN-US_TOPIC_0000001134564658__p132415792316">Calling an API can be authenticated using tokens.</p>
|
||||
<div class="section" id="EN-US_TOPIC_0000001134564658__se42eaf07b9464e7b8becd7c3cb824afb"><h4 class="sectiontitle">Token-based Authentication</h4><p id="EN-US_TOPIC_0000001134564658__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_0000001134564658__note185371034218"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001134564658__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_0000001134564658__p1160363317231">When calling the API to obtain a user token, you must set <strong id="EN-US_TOPIC_0000001134564658__b357314505014">auth.scope</strong> in the request body to <strong id="EN-US_TOPIC_0000001134564658__b12450131312504">project</strong>.</p>
|
||||
<pre class="screen" id="EN-US_TOPIC_0000001134564658__screen1954692813282">{
|
||||
"auth": {
|
||||
"identity": {
|
||||
"methods": [
|
||||
"password"
|
||||
],
|
||||
"password": {
|
||||
"user": {
|
||||
"name": "<strong id="EN-US_TOPIC_0000001134564658__b10546152892811"><em id="EN-US_TOPIC_0000001134564658__i14546152872814">user_name</em></strong>",
|
||||
"password": "<strong id="EN-US_TOPIC_0000001134564658__b55461828152819"><em id="EN-US_TOPIC_0000001134564658__i1954618287289">********</em></strong>",
|
||||
"domain": {
|
||||
"name": "<strong id="EN-US_TOPIC_0000001134564658__b85460281281"><em id="EN-US_TOPIC_0000001134564658__i17546162818286">domainname</em></strong>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
<strong id="EN-US_TOPIC_0000001134564658__b1419285411450"> </strong>"<strong id="EN-US_TOPIC_0000001134564658__b1473555710454">scope</strong>"<strong id="EN-US_TOPIC_0000001134564658__b17361957194516">: {</strong>
|
||||
<strong id="EN-US_TOPIC_0000001134564658__b733812464"> </strong>"<strong id="EN-US_TOPIC_0000001134564658__b581717418463">project</strong>"<strong id="EN-US_TOPIC_0000001134564658__b78181842467">: {</strong>
|
||||
<strong id="EN-US_TOPIC_0000001134564658__b912988164615"> </strong>"<strong id="EN-US_TOPIC_0000001134564658__b14581551151410">id</strong>"<strong id="EN-US_TOPIC_0000001134564658__b1262051515469">: </strong>"<strong id="EN-US_TOPIC_0000001134564658__b135491918462"><em id="EN-US_TOPIC_0000001134564658__i45421910461">xxxxxxxx</em></strong>"
|
||||
<strong id="EN-US_TOPIC_0000001134564658__b254662819280"> }</strong>
|
||||
<strong id="EN-US_TOPIC_0000001134564658__b6546162815283"> }</strong>
|
||||
}
|
||||
}</pre>
|
||||
<p id="EN-US_TOPIC_0000001134564658__a212a74e9785342f9a44bb4d6d62c25f1">After a token is obtained, the <strong id="EN-US_TOPIC_0000001134564658__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_0000001134564658__parmvalue27267718616"><b>ABCDEFJ....</b></span>, <span class="parmvalue" id="EN-US_TOPIC_0000001134564658__parmvalue4100115163"><b>X-Auth-Token: ABCDEFJ....</b></span> can be added to a request.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0062.html">Calling APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
46
docs/dws/api-ref/dws_02_0065.html
Normal file
46
docs/dws/api-ref/dws_02_0065.html
Normal file
@ -0,0 +1,46 @@
|
||||
<a name="EN-US_TOPIC_0000001180444243"></a><a name="EN-US_TOPIC_0000001180444243"></a>
|
||||
|
||||
<h1 class="topictitle1">Response</h1>
|
||||
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001180444243__sdf2869b4471243248a50cb5938552d6c"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001180444243__afd00b517b9244cbf94e851851e433700">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
|
||||
<p id="EN-US_TOPIC_0000001180444243__a1c8b49a1290d4bbc863d8eb8167f2bdf">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="dws_02_0038.html">Status Code</a>.</p>
|
||||
<p id="EN-US_TOPIC_0000001180444243__a5c07a6b44bf349f3bb7a52a4efd5045b">For example, if status code <span class="parmvalue" id="EN-US_TOPIC_0000001180444243__parmvalue19312146167"><b>201</b></span> is returned for calling the API used to obtain a user token, the request is successful.</p>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000001180444243__sf5a3f3d7d80f474d9b0637bb8ce37caa"><h4 class="sectiontitle">Response Header</h4><p id="EN-US_TOPIC_0000001180444243__a4536ab3bf21a415fb1051df97c5535c3">Similar to a request, a response also has a header, for example, <strong id="EN-US_TOPIC_0000001180444243__b195181956105317">content-type</strong>.</p>
|
||||
<p id="EN-US_TOPIC_0000001180444243__af745a7ca05c64314980abf44d691b888"><a href="#EN-US_TOPIC_0000001180444243__f84b86cb0c7364361a19a908603852b51">Figure 1</a> shows the response header fields for the API used to obtain a user token. The <strong id="EN-US_TOPIC_0000001180444243__b1768202235419">x-subject-token</strong> header field is the desired user token. You can use this token to authenticate the calling of other APIs.</p>
|
||||
<div class="fignone" id="EN-US_TOPIC_0000001180444243__f84b86cb0c7364361a19a908603852b51"><a name="EN-US_TOPIC_0000001180444243__f84b86cb0c7364361a19a908603852b51"></a><a name="f84b86cb0c7364361a19a908603852b51"></a><span class="figcap"><b>Figure 1 </b>Header fields of the response to the request for obtaining a user token</span><br><span><img id="EN-US_TOPIC_0000001180444243__id2082b75f0e74ea6b4bc24a5df96c04f" src="figure/en-us_image_0000001180324339.png" height="311.22" width="523.6875" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</div>
|
||||
<div class="section" id="EN-US_TOPIC_0000001180444243__s0a329452d9bf4528a1e68ff0db07e594"><h4 class="sectiontitle">Response Body</h4><p id="EN-US_TOPIC_0000001180444243__ab9181347db5141a0862d49ff1b532307">The body of a response is often returned in structured format (for example, JSON or XML) as specified in the <strong id="EN-US_TOPIC_0000001180444243__b185691717192111">Content-type</strong> header field. The response body transfers content except the response header.</p>
|
||||
</div>
|
||||
<p id="EN-US_TOPIC_0000001180444243__a54fb4947f79143db9e1ea9f1be240c0f">The following is part of the response body for the API used to obtain a user token. </p>
|
||||
<pre class="screen" id="EN-US_TOPIC_0000001180444243__s75067ec50d6249baa601eaab72d53e27">{
|
||||
"token": {
|
||||
"expires_at": "2019-02-13T06:52:13.855000Z",
|
||||
"methods": [
|
||||
"password"
|
||||
],
|
||||
"catalog": [
|
||||
{
|
||||
"endpoints": [
|
||||
{
|
||||
"region_id": "eu-de",
|
||||
......</pre>
|
||||
<p id="EN-US_TOPIC_0000001180444243__a25a736dbbf8f4cdcad04908d4a46e227">If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.</p>
|
||||
<pre class="screen" id="EN-US_TOPIC_0000001180444243__screen102091730125513">{
|
||||
"error_msg": "The format of message is error",
|
||||
"error_code": "AS.0001"
|
||||
}</pre>
|
||||
<p id="EN-US_TOPIC_0000001180444243__p1589911464018">In the response body, <strong id="EN-US_TOPIC_0000001180444243__b12791315192214">error_code</strong> is an error code, and <strong id="EN-US_TOPIC_0000001180444243__b187491618152217">error_msg</strong> provides information about the error.</p>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0062.html">Calling APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
||||
22
docs/dws/api-ref/dws_02_0066.html
Normal file
22
docs/dws/api-ref/dws_02_0066.html
Normal file
@ -0,0 +1,22 @@
|
||||
<a name="EN-US_TOPIC_0000001180444269"></a><a name="EN-US_TOPIC_0000001180444269"></a>
|
||||
|
||||
<h1 class="topictitle1">Appendix</h1>
|
||||
<div id="body1558595678679"><p id="EN-US_TOPIC_0000001180444269__p8060118"></p>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0038.html">Status Code</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0030.html">Error Code</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_0040.html">Creating a VPC</a></strong><br>
|
||||
</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>
|
||||
<li class="ulchildlink"><strong><a href="dws_02_00068.html">Obtaining the Cluster ID</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
13
docs/dws/api-ref/dws_02_0067.html
Normal file
13
docs/dws/api-ref/dws_02_0067.html
Normal file
@ -0,0 +1,13 @@
|
||||
<a name="EN-US_TOPIC_0000001134404900"></a><a name="EN-US_TOPIC_0000001134404900"></a>
|
||||
|
||||
<h1 class="topictitle1">Obtaining an Account ID</h1>
|
||||
<div id="body8662426"><p id="EN-US_TOPIC_0000001134404900__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_0000001134404900__oe9c190f940244d3eac2560d625b2d433"><li id="EN-US_TOPIC_0000001134404900__l9f6fc4c033c443679e30407beddb0a49">Log in to the management console.</li><li id="EN-US_TOPIC_0000001134404900__l53b1f18b1c6e46f9aff8c9aaef26a025">Click the username and select <span class="uicontrol" id="EN-US_TOPIC_0000001134404900__uicontrol17963114114206"><b>My Credential</b></span> from the drop-down list.<p id="EN-US_TOPIC_0000001134404900__en-us_topic_0170949686_p136772519449">On the <strong id="EN-US_TOPIC_0000001134404900__en-us_topic_0170949686_b151241857155215">My Credential</strong> page, view the <strong id="EN-US_TOPIC_0000001134404900__b1433342102">Account ID</strong>.</p>
|
||||
</li></ol>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0066.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
BIN
docs/dws/api-ref/figure/en-us_image_0000001134404912.png
Normal file
BIN
docs/dws/api-ref/figure/en-us_image_0000001134404912.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
BIN
docs/dws/api-ref/figure/en-us_image_0000001180324339.png
Normal file
BIN
docs/dws/api-ref/figure/en-us_image_0000001180324339.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user