forked from docs/doc-exports
Lu, Huayi
24f47208ec
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Lu, Huayi <luhuayi@huawei.com> Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
120 lines
9.8 KiB
HTML
120 lines
9.8 KiB
HTML
<a name="EN-US_TOPIC_0000001231631313"></a><a name="EN-US_TOPIC_0000001231631313"></a>
|
|
|
|
<h1 class="topictitle1">API Overview</h1>
|
|
<div id="body8662426"><p id="EN-US_TOPIC_0000001231631313__af8273345846d4b1c825d6cfd3f18c1bd">You can use the following GaussDB(DWS) functions with the APIs.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231631313__tbc910ba655cb4e0288a2a02dc2e6437b" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001231631313__rdf895e17b0e747fdb354172cb7e35d75"><th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.2.1.4.1.1"><p id="EN-US_TOPIC_0000001231631313__p51621169582">Function</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.220000000000002%" id="mcps1.3.2.1.4.1.2"><p id="EN-US_TOPIC_0000001231631313__a34ff4a6bbc9346df9667604ea7b78321"><strong id="EN-US_TOPIC_0000001231631313__b84235270613478">API</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.2.1.4.1.3"><p id="EN-US_TOPIC_0000001231631313__a03bd9da91d314d9ab3e002f9e202de87"><strong id="EN-US_TOPIC_0000001231631313__b842352706134712">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001231631313__row82265475161"><td class="cellrowborder" rowspan="8" valign="top" width="13.780000000000001%" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p102268471163">Cluster management</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.220000000000002%" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p83318405177"><a href="dws_02_0020.html">Creating a Cluster</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.1.4.1.3 "><p id="EN-US_TOPIC_0000001231631313__p0334940131712">Creates a cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row186713217173"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p14343240131719"><a href="dws_02_0018.html">Querying the Cluster List</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p1034614061711">Queries and displays the cluster list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row14965191617174"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p23491140181715"><a href="dws_02_0019.html">Querying Cluster Details</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p335304091718">Queries cluster details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row104951913141715"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p14355154016176"><a href="dws_02_0022.html">Querying the Supported Node Types</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p835711401176">Queries all node types supported by GaussDB(DWS).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row198281595177"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p12359114051715"><a href="dws_02_0021.html">Deleting a Cluster</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p93621940151710">Deletes a cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row677512531718"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p531915015172"><a href="dws_02_0052.html">Restarting a Cluster</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p19322125051714">Restarts a cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row72301622176"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p6324350111717"><a href="dws_02_0053.html">Scaling Out a Cluster</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p0326175012171">Scales out a cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row1434413588164"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p133305506174"><a href="dws_02_0054.html">Resetting a Password</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p9332350141718">Resets the cluster administrator password.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__r0f5ee444f8bb4ae192fddea2ec070681"><td class="cellrowborder" rowspan="5" valign="top" width="13.780000000000001%" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p1416276115812">Snapshot management</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.220000000000002%" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p1162520492612"><a href="dws_02_0026.html">Creating a Snapshot</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.1.4.1.3 "><p id="EN-US_TOPIC_0000001231631313__p11795717145">Creates snapshots for a specified cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row1062594912611"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p261419395124"><a href="dws_02_0024.html">Querying the Snapshot List</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p166251249865">Queries the snapshot list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row1161483912128"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p20912153551214"><a href="dws_02_0025.html">Querying Snapshot Details</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p1261453911123">Queries the snapshot details using the snapshot ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row10912123512121"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p1494103112124"><a href="dws_02_0027.html">Deleting a Manual Snapshot</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p109138355127">Deletes a snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row442514530275"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p144271353152713"><a href="dws_02_0032.html">Restoring a Cluster</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p154275538272">Restores a cluster using a snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row72571401071"><td class="cellrowborder" rowspan="6" valign="top" width="13.780000000000001%" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p192592001177">Tag management</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.220000000000002%" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p4260170977"><a href="dws_02_0046.html">Adding a Resource Tag</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.2.1.4.1.3 "><p id="EN-US_TOPIC_0000001231631313__p5260506714">Adds tags to resources.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row16501182014572"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p9502102045714"><a href="dws_02_0047.html">Adding or Deleting Resource Tags in Batches</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p9502620115715">Adds or deletes tags for a specified resource in batches.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row833617412078"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p1633794111710"><a href="dws_02_0048.html">Querying Resources by Tag</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p0337141779">Queries resource instances that meet the specified tag filtering criteria.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row136498258573"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p56491825175713"><a href="dws_02_0049.html">Querying Resource Tags</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p1864914257570">Queries the tags of a specified resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row14450185016720"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p44501350776"><a href="dws_02_0050.html">Querying Tags in a Specified Project</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p3653115611349">Queries all tags of a tenant for a specified resource type in a specified project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001231631313__row197761954674"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001231631313__p477665416714"><a href="dws_02_0051.html">Deleting a Resource Tag</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001231631313__p7776354472">Deletes a resource tag.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|