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

openGauss API 20221109 version

Browse Source 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
This commit is contained in:
Wang , Deng Ke 2022-11-14 16:40:26 +00:00 committed by zuul
parent 1a4b9e91b7
commit a96a12ecf1
57 changed files with 5341 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/opengauss/api-ref/.placeholder
View File

302
docs/opengauss/api-ref/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

272
docs/opengauss/api-ref/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/opengauss/api-ref/PARAMETERS.txt Normal file
View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

BIN
docs/opengauss/api-ref/en-us_image_0000001072599100.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 136 KiB

BIN
docs/opengauss/api-ref/en-us_image_0000001072791022.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 51 KiB

19
docs/opengauss/api-ref/opengauss_api_0001.html Normal file
View File

@ -0,0 +1,19 @@
<a name="opengauss_api_0001"></a><a name="opengauss_api_0001"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body1592884181557"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="opengauss_api_0002.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0003.html">API Calling</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0004.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0005.html">Constraints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0006.html">Concepts</a></strong><br>
</li>
</ul>
</div>

12
docs/opengauss/api-ref/opengauss_api_0002.html Normal file
View File

@ -0,0 +1,12 @@
<a name="opengauss_api_0002"></a><a name="opengauss_api_0002"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body1592884181559"><p id="opengauss_api_0002__p7387046273">Welcome to <em id="opengauss_api_0002__i10797614411"><span id="opengauss_api_0002__text6695183316195">GaussDB(openGauss)</span> API Reference</em>. <span id="opengauss_api_0002__text1071939215">GaussDB(openGauss)</span> is a next-generation, enterprise-class distributed database. It is designed based on the shared-nothing architecture and supports both x86 and Kunpeng CPU architectures. It features the following: high-throughput, strong-consistency transaction processing capabilities, financial-grade HA with 3DC geo-redundant DR, high scalability with a distributed architecture, and high-performance big data query capabilities. <span id="opengauss_api_0002__text17961101702811">GaussDB(openGauss)</span> is suitable for core systems used in a wide range of sectors, such as finance, telecom, and government.</p>
<p id="opengauss_api_0002__p14359124953115">This document describes how to use application programming interfaces (APIs) to perform operations on DB instances, such as DB instance creation, deletion, query, parameter modifications, and scaling. For details about all supported operations, see <a href="opengauss_api_0007.html">API Overview</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/opengauss/api-ref/opengauss_api_0003.html Normal file
View File

@ -0,0 +1,11 @@
<a name="opengauss_api_0003"></a><a name="opengauss_api_0003"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body1592884181561"><p id="opengauss_api_0003__p1520294823317"><span id="opengauss_api_0003__text19359195818259">GaussDB(openGauss)</span> supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="opengauss_api_0007.html">API Overview</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/opengauss/api-ref/opengauss_api_0004.html Normal file
View File

@ -0,0 +1,11 @@
<a name="opengauss_api_0004"></a><a name="opengauss_api_0004"></a>
<h1 class="topictitle1">Endpoints</h1>
<div id="body1592884181563"><p id="opengauss_api_0004__p19425105421612">An endpoint is the <strong id="opengauss_api_0004__b69901845329">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/opengauss/api-ref/opengauss_api_0005.html Normal file
View File

@ -0,0 +1,11 @@
<a name="opengauss_api_0005"></a><a name="opengauss_api_0005"></a>
<h1 class="topictitle1">Constraints</h1>
<div id="body1592884181564"><ul id="opengauss_api_0005__ul16164549183915"><li id="opengauss_api_0005__li111641049203910">For more constraints, see API description.</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0001.html">Before You Start</a></div>
</div>
</div>

19
docs/opengauss/api-ref/opengauss_api_0006.html Normal file
View File

@ -0,0 +1,19 @@
<a name="opengauss_api_0006"></a><a name="opengauss_api_0006"></a>
<h1 class="topictitle1">Concepts</h1>
<div id="body1592884183080"><ul id="opengauss_api_0006__ul0188175114595"><li id="opengauss_api_0006__en-us_topic_0169294976_li11478152103">Domain<p id="opengauss_api_0006__en-us_topic_0169294976_p947810531016"><a name="opengauss_api_0006__en-us_topic_0169294976_li11478152103"></a><a name="en-us_topic_0169294976_li11478152103"></a>A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The domain is a payment entity and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.</p>
</li></ul>
<ul id="opengauss_api_0006__ul128965163312"><li id="opengauss_api_0006__l04c4fc4d1f794534b0039934b5cec349">IAM User<p id="opengauss_api_0006__en-us_topic_0169294976_p589691603117"><a name="opengauss_api_0006__l04c4fc4d1f794534b0039934b5cec349"></a><a name="l04c4fc4d1f794534b0039934b5cec349"></a>An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
<p id="opengauss_api_0006__a8aa3fafa223a436ea7af065a91ec0908">The domain name, username, and password will be required for API authentication.</p>
</li><li id="opengauss_api_0006__ld8220287f9b648f8a0a18a5fa03ea544">Region<p id="opengauss_api_0006__a84a8c990dd51413392eb2ff706920bea"><a name="opengauss_api_0006__ld8220287f9b648f8a0a18a5fa03ea544"></a><a name="ld8220287f9b648f8a0a18a5fa03ea544"></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="opengauss_api_0006__l1364693ae489456c92107e94ffaeed01">AZ<p id="opengauss_api_0006__en-us_topic_0169294976_p061084051014"><a name="opengauss_api_0006__l1364693ae489456c92107e94ffaeed01"></a><a name="l1364693ae489456c92107e94ffaeed01"></a>An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. 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="opengauss_api_0006__l96e2e2f311ae482897cb10487c30b060">Project<p id="opengauss_api_0006__adc5408874e4d4d189313375b0b70d45a"><a name="opengauss_api_0006__l96e2e2f311ae482897cb10487c30b060"></a><a name="l96e2e2f311ae482897cb10487c30b060"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each 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 purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.</p>
<div class="fignone" id="opengauss_api_0006__fb12ba3db7a59499d81ed3b568968f61e"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="opengauss_api_0006__iba391cf6300d4257986c2e34a37f5642" src="en-us_image_0000001072791022.gif"></span></div>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0001.html">Before You Start</a></div>
</div>
</div>

35
docs/opengauss/api-ref/opengauss_api_0007.html Normal file
View File

@ -0,0 +1,35 @@
<a name="opengauss_api_0007"></a><a name="opengauss_api_0007"></a>
<h1 class="topictitle1">API Overview</h1>
<div id="body1592884183101"><p id="opengauss_api_0007__p8060118"><span id="opengauss_api_0007__text14378162520310">GaussDB(openGauss)</span> APIs enable you to use all <span id="opengauss_api_0007__text1367862616598">GaussDB(openGauss)</span> functions, including creating/deleting DB instances and scaling up instance storage space.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0007__table1577981717153" frame="border" border="1" rules="all"><thead align="left"><tr id="opengauss_api_0007__row16810121712155"><th align="left" class="cellrowborder" valign="top" width="18.63%" id="mcps1.3.2.1.4.1.1"><p id="opengauss_api_0007__p924014513320"><strong id="opengauss_api_0007__b93714401318">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.52%" id="mcps1.3.2.1.4.1.2"><p id="opengauss_api_0007__p13834717131516"><strong id="opengauss_api_0007__b1974120114110">Subtype</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.85000000000001%" id="mcps1.3.2.1.4.1.3"><p id="opengauss_api_0007__p3883151714159"><strong id="opengauss_api_0007__b4996154018">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0007__row1980621151411"><td class="cellrowborder" rowspan="3" valign="top" width="18.63%" headers="mcps1.3.2.1.4.1.1 "><p id="opengauss_api_0007__p182401945173314"><span id="opengauss_api_0007__text147161037143014">GaussDB(openGauss)</span> APIs</p>
</td>
<td class="cellrowborder" valign="top" width="19.52%" headers="mcps1.3.2.1.4.1.2 "><p id="opengauss_api_0007__p78251715184011">DB Instance Management</p>
</td>
<td class="cellrowborder" valign="top" width="61.85000000000001%" headers="mcps1.3.2.1.4.1.3 "><p id="opengauss_api_0007__p178077117141">Manage DB instances, including creating a DB instance, scaling up instance storage space, delete a DB instance, obtaining a DB instance list, obtaining a specified DB instance, adding Coordinator Nodes (CNs), adding shards, resetting a database password, and change a DB instance name.</p>
</td>
</tr>
<tr id="opengauss_api_0007__row17941818161515"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="opengauss_api_0007__p6465162615408">Parameter Configuration</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="opengauss_api_0007__p171171718191511">Modify parameters of a specified DB instance.</p>
</td>
</tr>
<tr id="opengauss_api_0007__row1480783431516"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="opengauss_api_0007__p1880893414151">Backup Management</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="opengauss_api_0007__p11808203419157">Set an automated backup policy.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

9
docs/opengauss/api-ref/opengauss_api_0012.html Normal file
View File

@ -0,0 +1,9 @@
<a name="opengauss_api_0012"></a><a name="opengauss_api_0012"></a>
<h1 class="topictitle1">Using APIs</h1>
<div id="body1600411288656"><p id="opengauss_api_0012__p1645204610259">Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="opengauss_api_0012__i204914796115410">https://Endpoint/uri</em>. In the URL, <em id="opengauss_api_0012__i842352697154116">uri</em> indicates the resource path, that is, the API access path.</p>
<p id="opengauss_api_0012__p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="opengauss_api_0012__b1025950229154127">Application/json</strong>.</p>
<p id="opengauss_api_0012__p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
</div>
<div></div>

15
docs/opengauss/api-ref/opengauss_api_0013.html Normal file
View File

@ -0,0 +1,15 @@
<a name="opengauss_api_0013"></a><a name="opengauss_api_0013"></a>
<h1 class="topictitle1">API</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="opengauss_api_0014.html">DB Instance Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0023.html">Parameter Configuration</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0025.html">Backup Management</a></strong><br>
</li>
</ul>
</div>

29
docs/opengauss/api-ref/opengauss_api_0014.html Normal file
View File

@ -0,0 +1,29 @@
<a name="opengauss_api_0014"></a><a name="opengauss_api_0014"></a>
<h1 class="topictitle1">DB Instance Management</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="opengauss_api_0015.html">Creating a DB Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0016.html">Scaling Up Storage Space of a DB Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0017.html">Deleting a DB Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0018.html">Querying Details About DB Instances</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0019.html">Adding CNs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0020.html">Adding Shards</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0021.html">Resetting a Database Password</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0022.html">Modifying a DB Instance Name</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">API</a></div>
</div>
</div>

774
docs/opengauss/api-ref/opengauss_api_0015.html Normal file
View File

File diff suppressed because it is too large Load Diff

131
docs/opengauss/api-ref/opengauss_api_0016.html Normal file
View File

File diff suppressed because it is too large Load Diff

75
docs/opengauss/api-ref/opengauss_api_0017.html Normal file
View File

@ -0,0 +1,75 @@
<a name="opengauss_api_0017"></a><a name="opengauss_api_0017"></a>
<h1 class="topictitle1">Deleting a DB Instance</h1>
<div id="body8662426"><div class="section" id="opengauss_api_0017__s427459083be941969f004d90fd301bbd"><h4 class="sectiontitle">Function</h4><p id="opengauss_api_0017__a3753db980fb24879bd0f598a53402896">This API is used to delete a DB instance. </p>
<ul id="opengauss_api_0017__u21cfd97bde1b4942bbc1b44c318aeef9"><li id="opengauss_api_0017__en-us_topic_0256709922_li41227910453">Before calling an API, you need to understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="opengauss_api_0017__lb5b27d5b1c7e4fb6aa975d2581fcbcf8">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="opengauss_api_0017__s8cdbd7bad1d84a0185b11d6feae45f7f"><h4 class="sectiontitle">URI</h4><ul id="opengauss_api_0017__en-us_topic_0128427214_ul13194498"><li id="opengauss_api_0017__en-us_topic_0128427214_li51641620">URI format<p id="opengauss_api_0017__en-us_topic_0128427214_p819462816594"><a name="opengauss_api_0017__en-us_topic_0128427214_li51641620"></a><a name="en-us_topic_0128427214_li51641620"></a>DELETE https://{<em id="opengauss_api_0017__a1e43346df0ec495a8184551b098f4628">Endpoint</em>}/opengauss/v3/{project_id}/instances/{instance_id}</p>
</li><li id="opengauss_api_0017__l68043f5f5fb441b3adc220ebc73595ef">Example<p id="opengauss_api_0017__a9c52766ff78d42dba8f11f8a3235bf7d"><a name="opengauss_api_0017__l68043f5f5fb441b3adc220ebc73595ef"></a><a name="l68043f5f5fb441b3adc220ebc73595ef"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01</p>
</li><li id="opengauss_api_0017__en-us_topic_0128427214_li22221662">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0017__en-us_topic_0128427214_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0017__en-us_topic_0128427214_row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="opengauss_api_0017__en-us_topic_0128427214_p10809459"><strong id="opengauss_api_0017__a3beeb6f3940e4a5abbb40686cf59b7e7">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.2"><p id="opengauss_api_0017__en-us_topic_0128427214_p3150961"><strong id="opengauss_api_0017__a332090b45f024844bb06d9647e155bac">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.3"><p id="opengauss_api_0017__en-us_topic_0128427214_p53901255"><strong id="opengauss_api_0017__aa9c2afc598f54bc4b93b270ba97f68b6">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0017__en-us_topic_0128427214_row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="opengauss_api_0017__en-us_topic_0128427214_p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="opengauss_api_0017__en-us_topic_0128427214_p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="opengauss_api_0017__en-us_topic_0128427214_p43776822">Specifies the project ID of a tenant in a region.</p>
<p id="opengauss_api_0017__p8544202712219">For details about how to obtain the project ID, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0017__rbbbcb3b9c8124cd0ac00d7b1289e6ef0"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="opengauss_api_0017__abe634873bf7340eeb9dde5363fb0ac9e">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="opengauss_api_0017__en-us_topic_0128427214_p246284104619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="opengauss_api_0017__aa6b0567e50a74aae908a757fb27db946">Specifies the DB instance ID compliant with the UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="opengauss_api_0017__s5a4a5866b994426280e96be0920ad68f"><h4 class="sectiontitle">Request</h4><p id="opengauss_api_0017__ababdffb384a24889b0527006e37bb68b">None</p>
</div>
<div class="section" id="opengauss_api_0017__s5125736d95d84cdea4dc6e30c38fb271"><h4 class="sectiontitle">Response</h4><ul id="opengauss_api_0017__en-us_topic_0128427214_ul48268995"><li id="opengauss_api_0017__en-us_topic_0128427214_li31767774">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0017__en-us_topic_0128427214_table17474517" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0017__en-us_topic_0128427214_row16146366"><th align="left" class="cellrowborder" valign="top" width="26.38%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="opengauss_api_0017__en-us_topic_0128427214_p32787233"><strong id="opengauss_api_0017__abe63fbcd3ae94c5d805613f28b13454f">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.29%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="opengauss_api_0017__en-us_topic_0128427214_p38520254"><strong id="opengauss_api_0017__en-us_topic_0128427214_b231334618324">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="opengauss_api_0017__en-us_topic_0128427214_p33132859"><strong id="opengauss_api_0017__a28ab7badd9904b98856dfa08b65dda3a">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0017__r8dfd765c2f30460698d01de6b59086b6"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="opengauss_api_0017__a8acc9ba29f3b4b3eb1c096b445e4e48e">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="40.29%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="opengauss_api_0017__a89ccc08444a444b883dd1dc9e208b752">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="opengauss_api_0017__a234aa3df3f2a406eac573678e65174f6">Indicates the ID of the DB instance deletion task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="opengauss_api_0017__l8bdfe9ace3f54739ad29dd72e270d3c0">Example normal response<pre class="codeblock" id="opengauss_api_0017__caf816eb9c0b04225a0726430c29e1554">{
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}</pre>
</li><li id="opengauss_api_0017__en-us_topic_0128427214_li18559781316">Abnormal response<p id="opengauss_api_0017__en-us_topic_0128427214_p172314336131"><a name="opengauss_api_0017__en-us_topic_0128427214_li18559781316"></a><a name="en-us_topic_0128427214_li18559781316"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="opengauss_api_0017__s3284251ebd4541779bde9ebcb7c73759"><h4 class="sectiontitle">Status Codes</h4><p id="opengauss_api_0017__ad6824e04527a4a76a14f3ecaae2eb642">For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</div>
<div class="section" id="opengauss_api_0017__s54bd14d25ce64947987555c84bb3a69a"><h4 class="sectiontitle">Error Codes</h4><p id="opengauss_api_0017__a478f17fa76dc42f792612496f9e1fdba">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0014.html">DB Instance Management</a></div>
</div>
</div>

1309
docs/opengauss/api-ref/opengauss_api_0018.html Normal file
View File

File diff suppressed because it is too large Load Diff

172
docs/opengauss/api-ref/opengauss_api_0019.html Normal file
View File

File diff suppressed because it is too large Load Diff

130
docs/opengauss/api-ref/opengauss_api_0020.html Normal file
View File

File diff suppressed because it is too large Load Diff

85
docs/opengauss/api-ref/opengauss_api_0021.html Normal file
View File

@ -0,0 +1,85 @@
<a name="opengauss_api_0021"></a><a name="opengauss_api_0021"></a>
<h1 class="topictitle1">Resetting a Database Password</h1>
<div id="body1601295215223"><div class="section" id="opengauss_api_0021__sd612792150ae4b208a688aaf2ea8373a"><h4 class="sectiontitle">Function</h4><p id="opengauss_api_0021__a2cdf56d7b7d34086ae869e51663009e1">This API is used to reset a database password.</p>
<ul id="opengauss_api_0021__u7bce3f5bbe93412f846d251a70fcf7c0"><li id="opengauss_api_0021__en-us_topic_0256709922_li41227910453">Before calling an API, you need to understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="opengauss_api_0021__lb5b27d5b1c7e4fb6aa975d2581fcbcf8">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="opengauss_api_0021__s57208d65eff64f4b9f470411f0f50f52"><h4 class="sectiontitle">URI</h4><ul id="opengauss_api_0021__uef1f19e4b9f14b85a3f328139ea8aa70"><li id="opengauss_api_0021__l096c3afe8cf74f1486544604422ea030">URI format<p id="opengauss_api_0021__aa15754bfe17c4b2984693497a7f3aeea"><a name="opengauss_api_0021__l096c3afe8cf74f1486544604422ea030"></a><a name="l096c3afe8cf74f1486544604422ea030"></a>POST https://{<em id="opengauss_api_0021__a1e43346df0ec495a8184551b098f4628">Endpoint</em>}/opengauss/v3/{<em id="opengauss_api_0021__a2fd015359cac444ea0026c3d20ffd724">project_id</em>}/instances/{<em id="opengauss_api_0021__en-us_topic_0248254028_i575217298119">instance_id</em>}/password</p>
</li><li id="opengauss_api_0021__l84fb22ebad954a54bf08e6046394c43e">Example<p id="opengauss_api_0021__a4c6544bdeb964ef093db66e55e14c237"><a name="opengauss_api_0021__l84fb22ebad954a54bf08e6046394c43e"></a><a name="l84fb22ebad954a54bf08e6046394c43e"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/password</p>
<ul id="opengauss_api_0021__u39da8dea28a742b6b8d554eecd99bc75"><li id="opengauss_api_0021__l471ae50f867640f9822e271930628a8a">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0021__tc2d8e97cd5444a20a6efb33c9e1fb44e" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0021__r3a1c61c293b84172b5588ac6b5017979"><th align="left" class="cellrowborder" valign="top" width="22.79%" id="mcps1.3.2.2.2.2.1.1.2.4.1.1"><p id="opengauss_api_0021__en-us_topic_0248254028_p178635485145">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.880000000000003%" id="mcps1.3.2.2.2.2.1.1.2.4.1.2"><p id="opengauss_api_0021__en-us_topic_0248254028_p586384819144">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.330000000000005%" id="mcps1.3.2.2.2.2.1.1.2.4.1.3"><p id="opengauss_api_0021__a1b9905b948ee49b3b33c1092030cc2ac">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0021__row10566131981211"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.2.2.1.1.2.4.1.1 "><p id="opengauss_api_0021__en-us_topic_0128427214_p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.2.2.2.2.1.1.2.4.1.2 "><p id="opengauss_api_0021__en-us_topic_0128427214_p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.330000000000005%" headers="mcps1.3.2.2.2.2.1.1.2.4.1.3 "><p id="opengauss_api_0021__p137165394126">Specifies the project ID of a tenant in a region.</p>
<p id="opengauss_api_0021__p671623981213">For details about how to obtain the project ID, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0021__row1565619141219"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.2.2.1.1.2.4.1.1 "><p id="opengauss_api_0021__abe634873bf7340eeb9dde5363fb0ac9e">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.2.2.2.2.1.1.2.4.1.2 "><p id="opengauss_api_0021__en-us_topic_0128427214_p246284104619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.330000000000005%" headers="mcps1.3.2.2.2.2.1.1.2.4.1.3 "><p id="opengauss_api_0021__p1881394218125">Specifies the DB instance ID, which is compliant with the UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</li></ul>
</div>
<div class="section" id="opengauss_api_0021__s625a3eaa41884791aa8e5cd0fc4e3eaf"><h4 class="sectiontitle">Request</h4><ul id="opengauss_api_0021__u0969f7afa0f842f5b55521f926a419e1"><li id="opengauss_api_0021__l2513b8d78fa34005ae91425c7a160a89">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0021__tb5b832857b0e4b3bb4b0f8601734bfaa" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0021__r18b7413528d74c7fab0b5a469e746e81"><th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="opengauss_api_0021__a96f959b310dd437780e1a91e2a840b80">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="opengauss_api_0021__en-us_topic_0151958051_p287512375212">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.75%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="opengauss_api_0021__ae1f9236ee14d45dc8dc6606d77f08ad3">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.76%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="opengauss_api_0021__en-us_topic_0151958051_p198753239523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0021__rca8aff89e9dc4c42a3a9547bc749ba0f"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="opengauss_api_0021__a20c26b7441c949b2a71e27cd828b4f43">password</p>
</td>
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="opengauss_api_0021__a51c26efa248d4d3a9fc2e2c6ccccdad2">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="opengauss_api_0021__af932a46aaba3432ebb596eef47bbc28b">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.76%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="opengauss_api_0021__p23411412333">Specifies the password for user <strong id="opengauss_api_0021__b127511041717">root</strong>.</p>
<ul id="opengauss_api_0021__ul23831659193214"><li id="opengauss_api_0021__li8383159193216">It consists of 8 to 32 characters and contains at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters (~! @#$%^*-_=+?,).</li><li id="opengauss_api_0021__li14383195973213">It supports weak password verification.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="opengauss_api_0021__ul10190321"><li id="opengauss_api_0021__li24604028">Example request<pre class="codeblock" id="opengauss_api_0021__codeblock12554125810506">{
"password": "Test_345612"
}</pre>
</li></ul>
<div class="section" id="opengauss_api_0021__s67fed9781e924497857c485097160728"><h4 class="sectiontitle">Response </h4><ul id="opengauss_api_0021__ul31923327101549"><li id="opengauss_api_0021__li18874490101549">Normal responses<p id="opengauss_api_0021__p7836161173816"><a name="opengauss_api_0021__li18874490101549"></a><a name="li18874490101549"></a>None</p>
</li><li id="opengauss_api_0021__li27619632">Example normal response<p id="opengauss_api_0021__p910118291344"><a name="opengauss_api_0021__li27619632"></a><a name="li27619632"></a>{}</p>
</li></ul>
</div>
<ul id="opengauss_api_0021__u9b17118ea46c4441bf032c0b300a6afb"><li id="opengauss_api_0021__l25fe8471f81d48b189d63d284e126372">Abnormal response<p id="opengauss_api_0021__a72740c637ef6476e9c3c6e424dbe5aa7"><a name="opengauss_api_0021__l25fe8471f81d48b189d63d284e126372"></a><a name="l25fe8471f81d48b189d63d284e126372"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
<div class="section" id="opengauss_api_0021__sc7e09a4eab74431784d4cdf1918d05c1"><h4 class="sectiontitle">Status Codes</h4><p id="opengauss_api_0021__ad6824e04527a4a76a14f3ecaae2eb642">For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</div>
<div class="section" id="opengauss_api_0021__sc1d8131c0dbe4ced837139a22ed27c8b"><h4 class="sectiontitle">Error Codes</h4><p id="opengauss_api_0021__a478f17fa76dc42f792612496f9e1fdba">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0014.html">DB Instance Management</a></div>
</div>
</div>

105
docs/opengauss/api-ref/opengauss_api_0022.html Normal file
View File

File diff suppressed because it is too large Load Diff

15
docs/opengauss/api-ref/opengauss_api_0023.html Normal file
View File

@ -0,0 +1,15 @@
<a name="opengauss_api_0023"></a><a name="opengauss_api_0023"></a>
<h1 class="topictitle1">Parameter Configuration</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="opengauss_api_0024.html">Modifying Parameters of a Specified DB Instance</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">API</a></div>
</div>
</div>

140
docs/opengauss/api-ref/opengauss_api_0024.html Normal file
View File

File diff suppressed because it is too large Load Diff

19
docs/opengauss/api-ref/opengauss_api_0025.html Normal file
View File

@ -0,0 +1,19 @@
<a name="opengauss_api_0025"></a><a name="opengauss_api_0025"></a>
<h1 class="topictitle1">Backup Management</h1>
<div id="body1601302784481"><p id="opengauss_api_0025__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="opengauss_api_0026.html">Setting an Automated Backup Policy</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">API</a></div>
</div>
</div>

148
docs/opengauss/api-ref/opengauss_api_0026.html Normal file
View File

File diff suppressed because it is too large Load Diff

21
docs/opengauss/api-ref/opengauss_api_0030.html Normal file
View File

@ -0,0 +1,21 @@
<a name="opengauss_api_0030"></a><a name="opengauss_api_0030"></a>
<h1 class="topictitle1">Appendix</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="opengauss_api_0031.html">Abnormal Request Results</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0032.html">Status Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0033.html">Error Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0034.html">Obtaining a Project ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0036.html">Replication Mode Table</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="opengauss_api_0037.html">DB Instance Class</a></strong><br>
</li>
</ul>
</div>

42
docs/opengauss/api-ref/opengauss_api_0031.html Normal file
View File

@ -0,0 +1,42 @@
<a name="opengauss_api_0031"></a><a name="opengauss_api_0031"></a>
<h1 class="topictitle1">Abnormal Request Results</h1>
<div id="body8662426"><div class="p" id="opengauss_api_0031__en-us_topic_0110967108_p896217443168"><strong id="opengauss_api_0031__en-us_topic_0110967108_b118365510203">Abnormal response description</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0031__td47185627f68438bbf2a0bb1c8cd0f0e" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Abnormal response description</caption><thead align="left"><tr id="opengauss_api_0031__r3aeb6d2156494adbb9a191ef1f0ceeb7"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.1.2.2.4.1.1"><p id="opengauss_api_0031__en-us_topic_0110967108_p38113217464"><strong id="opengauss_api_0031__a2831fa5bd37042db9f8d2650555ccbc0">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.1.2.2.4.1.2"><p id="opengauss_api_0031__en-us_topic_0110967108_p581192104614"><strong id="opengauss_api_0031__abc9d4e27063542f1bd82f5cf12f15fca">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.1.2.2.4.1.3"><p id="opengauss_api_0031__en-us_topic_0110967108_p883152154610"><strong>Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0031__r68185b5ae7e0429d9240662b9763d0ff"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.1.2.2.4.1.1 "><p id="opengauss_api_0031__en-us_topic_0110967108_p12851213469">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.1.2.2.4.1.2 "><p id="opengauss_api_0031__en-us_topic_0110967108_p487192112463">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.1.2.2.4.1.3 "><p id="opengauss_api_0031__en-us_topic_0110967108_p088221154617">Specifies the error returned when a task submission exception occurs.</p>
</td>
</tr>
<tr id="opengauss_api_0031__rf41b751759ac4dd1ab1ddbe36bf8a387"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.1.2.2.4.1.1 "><p id="opengauss_api_0031__en-us_topic_0110967108_p29082164616">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.1.2.2.4.1.2 "><p id="opengauss_api_0031__ae35be6fcd9b4474e9a3b5136c3abf54d">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.1.2.2.4.1.3 "><p id="opengauss_api_0031__a414009f2560841398ac084fce978df9c">Specifies the description of the error returned when a task submission exception occurs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="p" id="opengauss_api_0031__abb55028e618b4644bf81d0da9b77b489"><strong id="opengauss_api_0031__a08ea1ad5c86d4d67a912c3bc7449c821">Response example</strong><pre class="codeblock" id="opengauss_api_0031__c04e6dddbe3c84b81927ae666073a3a41">{
"error_code": "DBS.200022",
"error_msg": "The DB instance name already exists."
}</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0030.html">Appendix</a></div>
</div>
</div>

328
docs/opengauss/api-ref/opengauss_api_0032.html Normal file
View File

File diff suppressed because it is too large Load Diff

968
docs/opengauss/api-ref/opengauss_api_0033.html Normal file
View File

File diff suppressed because it is too large Load Diff

16
docs/opengauss/api-ref/opengauss_api_0034.html Normal file
View File

@ -0,0 +1,16 @@
<a name="opengauss_api_0034"></a><a name="opengauss_api_0034"></a>
<h1 class="topictitle1">Obtaining a Project ID</h1>
<div id="body1592979868268"><div class="section" id="opengauss_api_0034__section236911484369"><h4 class="sectiontitle">Scenarios</h4><p id="opengauss_api_0034__p8112855194115">When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first.</p>
</div>
<div class="section" id="opengauss_api_0034__section1559411367244"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><ol id="opengauss_api_0034__ol3196144819145"><li id="opengauss_api_0034__li1019624861412"><span>Register yourself on the management console and log in to it.</span></li><li id="opengauss_api_0034__li119612486145"><span>Move your pointer over the username and select <strong id="opengauss_api_0034__b14268629163616"></strong><strong id="opengauss_api_0034__b63626328364">My Credential</strong> in the displayed drop-down list.</span><p><p id="opengauss_api_0034__p136772519449">On the <strong id="opengauss_api_0034__b1027210111371">My Credential</strong> page, view project IDs in the project list.</p>
<div class="fignone" id="opengauss_api_0034__fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="opengauss_api_0034__image538470016132" src="en-us_image_0000001072599100.jpg"></span></div>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0030.html">Appendix</a></div>
</div>
</div>

30
docs/opengauss/api-ref/opengauss_api_0036.html Normal file
View File

@ -0,0 +1,30 @@
<a name="opengauss_api_0036"></a><a name="opengauss_api_0036"></a>
<h1 class="topictitle1">Replication Mode Table</h1>
<div id="body8662426"><p id="opengauss_api_0036__a241205acb0db4058b54dab74a506071f">Replication mode table</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0036__t8beac9f8e65f445d8fe73f044ae66127" frame="border" border="1" rules="all"><thead align="left"><tr id="opengauss_api_0036__rc9a8c2d0d47545ccb7ed59aff919dcb5"><th align="left" class="cellrowborder" valign="top" width="41.02%" id="mcps1.3.2.1.4.1.1"><p id="opengauss_api_0036__a9beab83a587c470ea38ddfa98789d08c"><strong id="opengauss_api_0036__a5fe3b2165f7f49b4afa779e009b58fbe">Replication Mode</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.03%" id="mcps1.3.2.1.4.1.2"><p id="opengauss_api_0036__acc527209f48841b5a69e43e8d77b7d69"><strong id="opengauss_api_0036__ac6df1f4489964661927a1ac27740e0cf">Description</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.95%" id="mcps1.3.2.1.4.1.3"><p id="opengauss_api_0036__a0afaa261c0c04a858666b311119ff265"><strong id="opengauss_api_0036__a96e6a8ae0bb34d3fa5f60757d2a26892">Remarks</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0036__r49b11132f2094d41aff17a0c232bedf9"><td class="cellrowborder" valign="top" width="41.02%" headers="mcps1.3.2.1.4.1.1 "><p id="opengauss_api_0036__en-us_topic_0110967205_p95405789935">sync</p>
</td>
<td class="cellrowborder" valign="top" width="34.03%" headers="mcps1.3.2.1.4.1.2 "><p id="opengauss_api_0036__en-us_topic_0110967205_p345893409935">Synchronous</p>
</td>
<td class="cellrowborder" valign="top" width="24.95%" headers="mcps1.3.2.1.4.1.3 "><p id="opengauss_api_0036__en-us_topic_0110967205_p502731759935">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0030.html">Appendix</a></div>
</div>
</div>

59
docs/opengauss/api-ref/opengauss_api_0037.html Normal file
View File

@ -0,0 +1,59 @@
<a name="opengauss_api_0037"></a><a name="opengauss_api_0037"></a>
<h1 class="topictitle1">DB Instance Class</h1>
<div id="body8662426"><p id="opengauss_api_0037__p8060118">This section describes the GaussDB(openGauss) DB instance class.</p>
<div class="tablenoborder"><a name="opengauss_api_0037__ted9b9d433c8a4c52884e199e17f94479"></a><a name="ted9b9d433c8a4c52884e199e17f94479"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0037__ted9b9d433c8a4c52884e199e17f94479" frame="border" border="1" rules="all"><caption><b>Table 1 </b>DB instance class</caption><thead align="left"><tr id="opengauss_api_0037__r495c7487f7d545cfad43ba7ca29a4b5d"><th align="left" class="cellrowborder" valign="top" width="11.12%" id="mcps1.3.2.2.6.1.1"><p id="opengauss_api_0037__af7477395c96c4da580be96a7483d0da3"><strong id="opengauss_api_0037__b10297635172813">Instance Class</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.2.2.6.1.2"><p id="opengauss_api_0037__p183721423195015"><strong id="opengauss_api_0037__a6edb199665b64fbd9f8a545fa85172b0">DB Engine</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.11%" id="mcps1.3.2.2.6.1.3"><p id="opengauss_api_0037__p113108391561"><strong id="opengauss_api_0037__a8ee4befe630248d687b3524b701e11f2">Spec Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.869999999999997%" id="mcps1.3.2.2.6.1.4"><p id="opengauss_api_0037__en-us_topic_0086557098_p488424159258"><strong id="opengauss_api_0037__en-us_topic_0219607730_b47998572126">vCPUs</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.97%" id="mcps1.3.2.2.6.1.5"><p id="opengauss_api_0037__en-us_topic_0086557098_p639215769258"><strong id="opengauss_api_0037__b16913205614139">Memory (GB)</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0037__row17760848341"><td class="cellrowborder" rowspan="4" valign="top" width="11.12%" headers="mcps1.3.2.2.6.1.1 "><p id="opengauss_api_0037__p1729191910114">General-enhanced II</p>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="19.93%" headers="mcps1.3.2.2.6.1.2 "><p id="opengauss_api_0037__p63505304920">GaussDB(openGauss)</p>
</td>
<td class="cellrowborder" valign="top" width="33.11%" headers="mcps1.3.2.2.6.1.3 "><p id="opengauss_api_0037__p62381549181018">gaussdb.opengauss.ee.dn.m6.2xlarge.8.in</p>
</td>
<td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.2.2.6.1.4 "><p id="opengauss_api_0037__p132091431115">8</p>
</td>
<td class="cellrowborder" valign="top" width="15.97%" headers="mcps1.3.2.2.6.1.5 "><p id="opengauss_api_0037__p182094411115">64</p>
</td>
</tr>
<tr id="opengauss_api_0037__row1533613501147"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.1 "><p id="opengauss_api_0037__p162381849151010">gaussdb.opengauss.ee.dn.m6.4xlarge.8.in</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.2 "><p id="opengauss_api_0037__p620914201113">16</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.3 "><p id="opengauss_api_0037__p3209114151118">128</p>
</td>
</tr>
<tr id="opengauss_api_0037__row2025143017555"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.1 "><p id="opengauss_api_0037__p132623015558">gaussdb.opengauss.ee.dn.m6.8xlarge.8.in</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.2 "><p id="opengauss_api_0037__p026730135512">32</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.3 "><p id="opengauss_api_0037__p62611304556">256</p>
</td>
</tr>
<tr id="opengauss_api_0037__row598473195515"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.1 "><p id="opengauss_api_0037__p3984123185513">gaussdb.opengauss.ee.dn.m6.16xlarge.8.in</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.2 "><p id="opengauss_api_0037__p1998417314553">64</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.3 "><p id="opengauss_api_0037__p1598423145511">521</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0030.html">Appendix</a></div>
</div>
</div>

20
docs/opengauss/api-ref/opengauss_api_0038.html Normal file
View File

@ -0,0 +1,20 @@
<a name="opengauss_api_0038"></a><a name="opengauss_api_0038"></a>
<h1 class="topictitle1">Change History</h1>
<div id="body8662426">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0038__table7502045123619" frame="border" border="1" rules="all"><thead align="left"><tr id="opengauss_api_0038__row6504458364"><th align="left" class="cellrowborder" valign="top" width="18.48%" id="mcps1.3.1.1.3.1.1"><p id="opengauss_api_0038__p750645123610">Released Date</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="81.52000000000001%" id="mcps1.3.1.1.3.1.2"><p id="opengauss_api_0038__p11508455365">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0038__row1150745193620"><td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.1.1.3.1.1 "><p id="opengauss_api_0038__p1450845193610">2020-11-30</p>
</td>
<td class="cellrowborder" valign="top" width="81.52000000000001%" headers="mcps1.3.1.1.3.1.2 "><p id="opengauss_api_0038__p135044519369">This issue is the first official release.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

1
docs/opengauss/api-ref/public_sys-resources/ExpandCollapse.js Normal file
View File

@ -0,0 +1 @@
var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d<f.length;d++){var e=f[d];if(e.className.indexOf(expandClassName)!=-1||e.className.indexOf(collapseClassName)!=-1||e.className.indexOf(collapseTableClassName)!=-1){if(a=="collapse"){if(e.tagName.toLowerCase()=="table"){e.className=collapseTableClassName}else{e.className=collapseClassName}}else{e.className=expandClassName}}}}function ExpandForHref(f){if(null==f||"#"==f||"###"==f){return}var a=null;try{a=document.getElementById(f)}catch(d){}if(null==a||a.length==0){return}try{var b=a.parentNode;while(b!=null&&b.tagName!="body"){if(b.className==collapseClassName){b.className=expandClassName}b=b.parentNode}}catch(c){}}window.onload=function(){var b=document.getElementsByTagName("div");for(var c=0;c<b.length;c++){var j=b[c];if(j.className.indexOf(expandClassName)!=-1){j.className=collapseClassName}}var d=document.getElementsByTagName("a");try{for(var c=0;c<d.length;c++){var f=d[c];var h=f.getAttribute("href");if(h!=""&&h!=null){f.addEventListener("click",showHasConref,false)}}}catch(g){}};function showHasConref(b){var a=b.currentTarget.getAttribute("href");try{if(a!=null&&a!="#"&&a.lastIndexOf("#")>-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}};

BIN
docs/opengauss/api-ref/public_sys-resources/caution_3.0-en-us.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.7 KiB

1
docs/opengauss/api-ref/public_sys-resources/commonltr.css Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/opengauss/api-ref/public_sys-resources/commonltr_print.css Normal file
View File

File diff suppressed because one or more lines are too long

2
docs/opengauss/api-ref/public_sys-resources/commonrtl.css Normal file
View File

@ -0,0 +1,2 @@
/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with <div>. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式
*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}

BIN
docs/opengauss/api-ref/public_sys-resources/danger_3.0-en-us.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.7 KiB

BIN
docs/opengauss/api-ref/public_sys-resources/delta.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 836 B

BIN
docs/opengauss/api-ref/public_sys-resources/deltaend.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 834 B

BIN
docs/opengauss/api-ref/public_sys-resources/icon-arrowdn.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 68 B

BIN
docs/opengauss/api-ref/public_sys-resources/icon-arrowrt.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 70 B

BIN
docs/opengauss/api-ref/public_sys-resources/icon-caution.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
docs/opengauss/api-ref/public_sys-resources/icon-danger.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
docs/opengauss/api-ref/public_sys-resources/icon-huawei.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.7 KiB

BIN
docs/opengauss/api-ref/public_sys-resources/icon-note.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 983 B

Some files were not shown because too many files have changed in this diff Show More