forked from docs/doc-exports
opengauss_api
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
This commit is contained in:
parent
7e6f07b803
commit
d97aea4dd2
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 136 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 51 KiB |
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001791269145.jpg
Normal file
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001791269145.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 136 KiB |
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001791349361.png
Normal file
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001791349361.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001917130848.png
Normal file
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001917130848.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 110 KiB |
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001917290796.png
Normal file
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001917290796.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001917290800.jpg
Normal file
BIN
docs/opengauss/api-ref/figure/en-us_image_0000001917290800.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 136 KiB |
@ -1,4 +1,4 @@
|
|||||||
<a name="opengauss_api_0001"></a><a name="opengauss_api_0001"></a>
|
<a name="EN-US_TOPIC_0000001917130792"></a><a name="EN-US_TOPIC_0000001917130792"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Before You Start</h1>
|
<h1 class="topictitle1">Before You Start</h1>
|
||||||
<div id="body1592884181557"></div>
|
<div id="body1592884181557"></div>
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
<a name="opengauss_api_0002"></a><a name="opengauss_api_0002"></a>
|
<a name="EN-US_TOPIC_0000001947569661"></a><a name="EN-US_TOPIC_0000001947569661"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Overview</h1>
|
<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>
|
<div id="body1592884181559"><p id="EN-US_TOPIC_0000001947569661__p030610528365"><span id="EN-US_TOPIC_0000001947569661__text203231147015">GaussDB</span> is a distributed relational database. <span id="EN-US_TOPIC_0000001947569661__text6738014143919">GaussDB</span> supports distributed transactions and intra-city deployment across AZs for zero data loss, storage for petabytes of data, and scale-out to more than 1,000 nodes. It is highly available, secure, and scalable and provides services including quick deployment, backup, restoration, monitoring, and alarm reporting for enterprises.</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>
|
<p id="EN-US_TOPIC_0000001947569661__p14359124953115">This document describes how to use application programming interfaces (APIs) to perform operations on instances, such as creating, deleting, querying and scaling out instances. For operation details, see <a href="opengauss_api_0007.html">API Overview</a>.</p>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<div class="familylinks">
|
<div class="familylinks">
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
<a name="opengauss_api_0003"></a><a name="opengauss_api_0003"></a>
|
<a name="EN-US_TOPIC_0000001917290664"></a><a name="EN-US_TOPIC_0000001917290664"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">API Calling</h1>
|
<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 id="body1592884181561"><p id="EN-US_TOPIC_0000001917290664__p1520294823317"><span id="EN-US_TOPIC_0000001917290664__text339078545">GaussDB</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>
|
<div>
|
||||||
<div class="familylinks">
|
<div class="familylinks">
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
<a name="opengauss_api_0004"></a><a name="opengauss_api_0004"></a>
|
<a name="EN-US_TOPIC_0000001917130620"></a><a name="EN-US_TOPIC_0000001917130620"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Endpoints</h1>
|
<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 id="body1592884181563"><p id="EN-US_TOPIC_0000001917130620__p19425105421612">An endpoint is the <strong id="EN-US_TOPIC_0000001917130620__b48330335610">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/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<div class="familylinks">
|
<div class="familylinks">
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
<a name="opengauss_api_0005"></a><a name="opengauss_api_0005"></a>
|
<a name="EN-US_TOPIC_0000001917130448"></a><a name="EN-US_TOPIC_0000001917130448"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Constraints</h1>
|
<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 id="body1592884181564"><p id="EN-US_TOPIC_0000001917130448__p1723945519539">For more constraints, see API description.</p>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<div class="familylinks">
|
<div class="familylinks">
|
||||||
|
|||||||
@ -1,14 +1,14 @@
|
|||||||
<a name="opengauss_api_0006"></a><a name="opengauss_api_0006"></a>
|
<a name="EN-US_TOPIC_0000001947569525"></a><a name="EN-US_TOPIC_0000001947569525"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Concepts</h1>
|
<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>
|
<div id="body1592884183080"><ul id="EN-US_TOPIC_0000001947569525__ul0188175114595"><li id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li11478152103">Domain<p id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_p947810531016"><a name="EN-US_TOPIC_0000001947569525__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. To ensure account security, do not use the domain for routine management.</p>
|
||||||
</li></ul>
|
</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>
|
<ul id="EN-US_TOPIC_0000001947569525__ul128965163312"><li id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li15896816113116">User<p id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_p589691603117"><a name="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li15896816113116"></a><a name="en-us_topic_0169294976_li15896816113116"></a>A user is created using an account to use cloud services. Each 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>
|
<p id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_p9896121653112">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="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li1564913617106">Region<p id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_p10588103711107"><a name="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li1564913617106"></a><a name="en-us_topic_0169294976_li1564913617106"></a>A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.</p>
|
||||||
</li><li id="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="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li1183783919109">AZ<p id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_p061084051014"><a name="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li1183783919109"></a><a name="en-us_topic_0169294976_li1183783919109"></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>
|
</li><li id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li3896216123113"><a name="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0169294976_li3896216123113"></a>Project<p id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_p10896181643118"><a name="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0169294976_li3896216123113"></a>Projects group and isolate 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>
|
<div class="fignone" id="EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_fig1189614168311"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="EN-US_TOPIC_0000001947569525__image136082037113011" src="figure/en-us_image_0000001917130848.png"></span></div>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
|
|||||||
@ -1,31 +1,51 @@
|
|||||||
<a name="opengauss_api_0007"></a><a name="opengauss_api_0007"></a>
|
<a name="EN-US_TOPIC_0000001917290636"></a><a name="EN-US_TOPIC_0000001917290636"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">API Overview</h1>
|
<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 id="body1592884183101"><p id="EN-US_TOPIC_0000001917290636__p8060118">You can use APIs to create and delete DB instances, query DB instances, obtain and modify parameters of a specified DB instance, and set and query automated backup policies. For details, see the following table.</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>
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290636__table1577981717153" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001917290636__row16810121712155"><th align="left" class="cellrowborder" valign="top" width="18.63%" id="mcps1.3.2.1.4.1.1"><p id="EN-US_TOPIC_0000001917290636__p924014513320"><strong id="EN-US_TOPIC_0000001917290636__b1547518688">Type</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="19.52%" id="mcps1.3.2.1.4.1.2"><p id="EN-US_TOPIC_0000001917290636__p13834717131516"><strong id="EN-US_TOPIC_0000001917290636__b1691804316">Subtype</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="61.85000000000001%" id="mcps1.3.2.1.4.1.3"><p id="EN-US_TOPIC_0000001917290636__p3883151714159"><strong id="EN-US_TOPIC_0000001917290636__b633003045">Description</strong></p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</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>
|
<tbody><tr id="EN-US_TOPIC_0000001917290636__row1980621151411"><td class="cellrowborder" rowspan="7" valign="top" width="18.63%" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001917290636__p182401945173314"><span id="EN-US_TOPIC_0000001917290636__text19940318142617">GaussDB</span> APIs</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="19.52%" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001917290636__p78251715184011">Instance Management</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="61.85000000000001%" headers="mcps1.3.2.1.4.1.3 "><p id="EN-US_TOPIC_0000001917290636__p178077117141">Manage instances, including creating an instance, scaling up storage, deleting an instance, obtaining instances, obtaining a specified instance, adding CNs, adding shards, resetting a database password, and changing an instance name.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr id="EN-US_TOPIC_0000001917290636__row17941818161515"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001917290636__p6465162615408">Parameter Configuration</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001917290636__p171171718191511">Obtain and modify parameters of a specified DB instance and obtain the parameter templates.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr id="EN-US_TOPIC_0000001917290636__row1480783431516"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001917290636__p1880893414151">Backup Management</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001917290636__p11808203419157">Configure and query automated backup policies, query backups, and create and delete manual backups.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290636__row832212572381"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001917290636__p16585301300">DB Engine Versions and Specifications</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001917290636__p1365893013015">Query DB engine versions and query database specifications.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290636__row79920174398"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001917290636__p13582415018">Disk Type Queries</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001917290636__p258194117010">Query database disk type.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290636__row63472811396"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001917290636__p6748481608">Task Management</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001917290636__p167481982017">Obtain task information, query tasks, and delete a task record.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290636__row1421812443918"><td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001917290636__p18841358105">Recycle Bin</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001917290636__p108847581501">Set a recycling policy.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|||||||
15
docs/opengauss/api-ref/opengauss_api_0008.html
Normal file
15
docs/opengauss/api-ref/opengauss_api_0008.html
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
<a name="EN-US_TOPIC_0000001917130428"></a><a name="EN-US_TOPIC_0000001917130428"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Calling APIs</h1>
|
||||||
|
<div id="body1592884183102"></div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_0009.html">Making an API Request</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_0010.html">Authentication</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_0011.html">Response</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
198
docs/opengauss/api-ref/opengauss_api_0009.html
Normal file
198
docs/opengauss/api-ref/opengauss_api_0009.html
Normal file
File diff suppressed because it is too large
Load Diff
49
docs/opengauss/api-ref/opengauss_api_0010.html
Normal file
49
docs/opengauss/api-ref/opengauss_api_0010.html
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
<a name="EN-US_TOPIC_0000001917130680"></a><a name="EN-US_TOPIC_0000001917130680"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Authentication</h1>
|
||||||
|
<div id="body1592884185078"><p id="EN-US_TOPIC_0000001917130680__p27556670">Token authentication must be performed to call APIs.</p>
|
||||||
|
<p id="EN-US_TOPIC_0000001917130680__p4531593915538">Token-based authentication: Requests are authenticated using a token.</p>
|
||||||
|
<div class="section" id="EN-US_TOPIC_0000001917130680__section12338193016620"><h4 class="sectiontitle">Token Authentication</h4><div class="note" id="EN-US_TOPIC_0000001917130680__note1664421016716"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001917130680__p464431018713">The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.</p>
|
||||||
|
</div></div>
|
||||||
|
<p id="EN-US_TOPIC_0000001917130680__p364417101710">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.</p>
|
||||||
|
<pre class="screen" id="EN-US_TOPIC_0000001917130680__screen1523316215617">{
|
||||||
|
"auth": {
|
||||||
|
"identity": {
|
||||||
|
"methods": [
|
||||||
|
"password"
|
||||||
|
],
|
||||||
|
"password": {
|
||||||
|
"user": {
|
||||||
|
"name": "<strong id="EN-US_TOPIC_0000001917130680__b523211213611"><em id="EN-US_TOPIC_0000001917130680__i152321121768">username</em></strong>",
|
||||||
|
"password": "<strong id="EN-US_TOPIC_0000001917130680__b1423242864"><em id="EN-US_TOPIC_0000001917130680__i102321723618">********</em></strong>",
|
||||||
|
"domain": {
|
||||||
|
"name": "<strong id="EN-US_TOPIC_0000001917130680__b1232182160"><em id="EN-US_TOPIC_0000001917130680__i142321521463">domainname</em></strong>"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
<strong id="EN-US_TOPIC_0000001917130680__b172326214617"> "scope": {</strong><strong id="EN-US_TOPIC_0000001917130680__b122324215616"> </strong>
|
||||||
|
<strong id="EN-US_TOPIC_0000001917130680__b32321024619"> </strong><strong id="EN-US_TOPIC_0000001917130680__b62336216618"> "project": {</strong><strong id="EN-US_TOPIC_0000001917130680__b1623362867"> </strong>
|
||||||
|
<strong id="EN-US_TOPIC_0000001917130680__b1423332562"> </strong><strong id="EN-US_TOPIC_0000001917130680__b8233162061"> "name": "<em id="EN-US_TOPIC_0000001917130680__i6233321063">xxxxxxxx</em>"</strong><strong id="EN-US_TOPIC_0000001917130680__b123313217620"> </strong>
|
||||||
|
<strong id="EN-US_TOPIC_0000001917130680__b1423332869"> </strong><strong id="EN-US_TOPIC_0000001917130680__b52331822611"> }</strong><strong id="EN-US_TOPIC_0000001917130680__b1223313212617"> </strong>
|
||||||
|
<strong id="EN-US_TOPIC_0000001917130680__b182333215616"> </strong><strong id="EN-US_TOPIC_0000001917130680__b17233172167"> }</strong><strong id="EN-US_TOPIC_0000001917130680__b122332212612"> </strong>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
</div>
|
||||||
|
<p id="EN-US_TOPIC_0000001917130680__p116169153412">In <a href="opengauss_api_0009.html">Making an API Request</a>, the process of calling the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> is described.</p>
|
||||||
|
<p id="EN-US_TOPIC_0000001917130680__p9691122114266">After a token is obtained, add the <strong id="EN-US_TOPIC_0000001917130680__b1144244172713">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_0000001917130680__parmvalue1038232518315"><b>ABCDEFJ....</b></span>, <span class="parmvalue" id="EN-US_TOPIC_0000001917130680__parmvalue10383725113110"><b>X-Auth-Token: ABCDEFJ....</b></span> can be added to a request as follows:</p>
|
||||||
|
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000001917130680__screen11189101154015"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||||||
|
<span class="normal">2</span>
|
||||||
|
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{{Endpoint}}/v3/auth/projects</span>
|
||||||
|
<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span><span class="w"> </span><span class="n">application</span><span class="o">/</span><span class="n">json</span>
|
||||||
|
<span class="n">X</span><span class="o">-</span><span class="n">Auth</span><span class="o">-</span><span class="n">Token</span><span class="p">:</span><span class="w"> </span><span class="n">ABCDEFJ</span><span class="p">....</span>
|
||||||
|
</pre></div></td></tr></table></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0008.html">Calling APIs</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
40
docs/opengauss/api-ref/opengauss_api_0011.html
Normal file
40
docs/opengauss/api-ref/opengauss_api_0011.html
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
<a name="EN-US_TOPIC_0000001947569801"></a><a name="EN-US_TOPIC_0000001947569801"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Response</h1>
|
||||||
|
<div id="body1592884185818"><div class="section" id="EN-US_TOPIC_0000001947569801__section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001947569801__p4624111624411">After sending a request, you will receive a response, including the status code, response header, and response body.</p>
|
||||||
|
<p id="EN-US_TOPIC_0000001947569801__p124381044137">A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
||||||
|
<p id="EN-US_TOPIC_0000001947569801__p2861496519">For example, if status code <strong id="EN-US_TOPIC_0000001947569801__b033215334346">201</strong> is returned for calling the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request is successful.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="EN-US_TOPIC_0000001947569801__en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Header</h4><p id="EN-US_TOPIC_0000001947569801__p384320471837">Similar to a request, a response also has a header, for example, <span class="parmvalue" id="EN-US_TOPIC_0000001947569801__en-us_topic_0170210614_en-us_topic_0170195383_parmvalue1720109175113"><b>Content-Type</b></span>.</p>
|
||||||
|
<p id="EN-US_TOPIC_0000001947569801__p4430113619484"><a href="#EN-US_TOPIC_0000001947569801__fig4865141011511">Figure 1</a> shows the response header for the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>. The <span class="parmname" id="EN-US_TOPIC_0000001947569801__parmname73711320153512"><b>x-subject-token</b></span> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
|
||||||
|
<div class="fignone" id="EN-US_TOPIC_0000001947569801__fig4865141011511"><a name="EN-US_TOPIC_0000001947569801__fig4865141011511"></a><a name="fig4865141011511"></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_0000001947569801__image48651610135113" src="figure/en-us_image_0000001917290796.png"></span></div>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="EN-US_TOPIC_0000001947569801__en-us_topic_0113746487_section2045571671419"><h4 class="sectiontitle">(Optional) Response Body</h4><p id="EN-US_TOPIC_0000001947569801__en-us_topic_0113746487_p64711881416">This part is optional. 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_0000001947569801__b531219178360">Content-Type</strong> header field. The response body transfers content except the response header.</p>
|
||||||
|
<div class="p" id="EN-US_TOPIC_0000001947569801__p157041652367">The following is part of the response body for the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.<pre class="screen" id="EN-US_TOPIC_0000001947569801__screen01152675713">{
|
||||||
|
"token": {
|
||||||
|
"expires_at": "2019-02-13T06:52:13.855000Z",
|
||||||
|
"methods": [
|
||||||
|
"password"
|
||||||
|
],
|
||||||
|
"catalog": [
|
||||||
|
{
|
||||||
|
"endpoints": [
|
||||||
|
{
|
||||||
|
"region_id": "az-01",
|
||||||
|
......</pre>
|
||||||
|
</div>
|
||||||
|
<div class="p" id="EN-US_TOPIC_0000001947569801__p127537375412">If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.<pre class="screen" id="EN-US_TOPIC_0000001947569801__screen198081822715">{
|
||||||
|
"error_code": "AS.0001",
|
||||||
|
"error_msg": "The format of message is error"
|
||||||
|
}
|
||||||
|
</pre>
|
||||||
|
</div>
|
||||||
|
<p id="EN-US_TOPIC_0000001947569801__p1589911464018">In the response body, <strong id="EN-US_TOPIC_0000001947569801__en-us_topic_0170210614_en-us_topic_0170195383_b5649173911322">error_code</strong> is an error code, and <strong id="EN-US_TOPIC_0000001947569801__en-us_topic_0170210614_en-us_topic_0170195383_b9768124353218">error_msg</strong> provides information about the error.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0008.html">Calling APIs</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
@ -1,9 +1,8 @@
|
|||||||
<a name="opengauss_api_0012"></a><a name="opengauss_api_0012"></a>
|
<a name="EN-US_TOPIC_0000001917130760"></a><a name="EN-US_TOPIC_0000001917130760"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Using APIs</h1>
|
<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>
|
<div id="body1600411288656"><p id="EN-US_TOPIC_0000001917130760__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="EN-US_TOPIC_0000001917130760__i204914796115410">https://Endpoint/uri</em>. In the URL, <em id="EN-US_TOPIC_0000001917130760__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="EN-US_TOPIC_0000001917130760__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="EN-US_TOPIC_0000001917130760__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>
|
<p id="EN-US_TOPIC_0000001917130760__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></div>
|
|
||||||
|
|
||||||
|
|||||||
@ -1,15 +1,23 @@
|
|||||||
<a name="opengauss_api_0013"></a><a name="opengauss_api_0013"></a>
|
<a name="EN-US_TOPIC_0000001917290496"></a><a name="EN-US_TOPIC_0000001917290496"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">API</h1>
|
<h1 class="topictitle1">APIs (Recommended)</h1>
|
||||||
<div id="body8662426"></div>
|
<div id="body0000001207049279"></div>
|
||||||
<div>
|
<div>
|
||||||
<ul class="ullinks">
|
<ul class="ullinks">
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0014.html">DB Instance Management</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0014.html">Instance Management</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0023.html">Parameter Configuration</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0023.html">Parameter Configuration</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0025.html">Backup Management</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0025.html">Backup Management</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0005.html">DB Engine Versions and Specifications</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0028.html">Querying Database Disk Type</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0034.html">Task Management</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0036.html">Recycle Bin</a></strong><br>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|||||||
@ -1,29 +1,35 @@
|
|||||||
<a name="opengauss_api_0014"></a><a name="opengauss_api_0014"></a>
|
<a name="EN-US_TOPIC_0000001917290356"></a><a name="EN-US_TOPIC_0000001917290356"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">DB Instance Management</h1>
|
<h1 class="topictitle1">Instance Management</h1>
|
||||||
<div id="body8662426"></div>
|
<div id="body0000001206727827"></div>
|
||||||
<div>
|
<div>
|
||||||
<ul class="ullinks">
|
<ul class="ullinks">
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0015.html">Creating a DB Instance</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0015.html">Creating a DB Instance</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0016.html">Scaling Up Storage Space of a DB Instance</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0016.html">Adding CNs, Adding Shards, or Scaling Up Storage</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0017.html">Deleting a DB Instance</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0017.html">Deleting a DB Instance</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0018.html">Querying Details About DB Instances</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0018.html">Querying 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>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0021.html">Resetting a Database Password</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0021.html">Resetting a Database Password</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0022.html">Modifying a DB Instance Name</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0022.html">Changing a DB Instance Name</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0001.html">Rebooting a DB Instance</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0029.html">Switching Roles of the Primary and Standby DNs in Shards</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0030.html">Querying the Components of a DB Instance</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0031.html">Changing vCPUs and Memory of a DB Instance</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_1037.html">Changing the Port Number of a Specified DB Instance</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<div class="familylinks">
|
<div class="familylinks">
|
||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">API</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">APIs (Recommended)</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,15 +1,19 @@
|
|||||||
<a name="opengauss_api_0023"></a><a name="opengauss_api_0023"></a>
|
<a name="EN-US_TOPIC_0000001917290584"></a><a name="EN-US_TOPIC_0000001917290584"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Parameter Configuration</h1>
|
<h1 class="topictitle1">Parameter Configuration</h1>
|
||||||
<div id="body8662426"></div>
|
<div id="body0000001161329324"></div>
|
||||||
<div>
|
<div>
|
||||||
<ul class="ullinks">
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0003.html">Obtaining Parameter Templates</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0004.html">Obtaining the Parameters of a Specified DB Instance</a></strong><br>
|
||||||
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0024.html">Modifying Parameters of a Specified DB Instance</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0024.html">Modifying Parameters of a Specified DB Instance</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<div class="familylinks">
|
<div class="familylinks">
|
||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">API</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">APIs (Recommended)</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -1,19 +1,28 @@
|
|||||||
<a name="opengauss_api_0025"></a><a name="opengauss_api_0025"></a>
|
<a name="EN-US_TOPIC_0000001947569457"></a><a name="EN-US_TOPIC_0000001947569457"></a>
|
||||||
|
|
||||||
|
|
||||||
<h1 class="topictitle1">Backup Management</h1>
|
<h1 class="topictitle1">Backup Management</h1>
|
||||||
|
<div id="body0000001161489318"><p id="EN-US_TOPIC_0000001947569457__p8060118"></p>
|
||||||
<div id="body1601302784481"><p id="opengauss_api_0025__p8060118"></p>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<ul class="ullinks">
|
<ul class="ullinks">
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0026.html">Setting an Automated Backup Policy</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0026.html">Configuring an Automated Backup Policy</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0022.html">Querying an Automated Backup Policy</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0023.html">Querying Backups</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0024.html">Creating a Manual Backup</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0025.html">Deleting a Manual Backup</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0026.html">Querying the Restoration Time Range</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_newapi_0027.html">Restoring Data to a New DB Instance</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<div class="familylinks">
|
<div class="familylinks">
|
||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">API</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">APIs (Recommended)</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -1,4 +1,4 @@
|
|||||||
<a name="opengauss_api_0030"></a><a name="opengauss_api_0030"></a>
|
<a name="EN-US_TOPIC_0000001947569769"></a><a name="EN-US_TOPIC_0000001947569769"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Appendix</h1>
|
<h1 class="topictitle1">Appendix</h1>
|
||||||
<div id="body8662426"></div>
|
<div id="body8662426"></div>
|
||||||
@ -14,7 +14,7 @@
|
|||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0036.html">Replication Mode Table</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0036.html">Replication Mode Table</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="opengauss_api_0037.html">DB Instance Class</a></strong><br>
|
<li class="ulchildlink"><strong><a href="opengauss_api_0037.html">DB Instance Specifications</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@ -1,34 +1,34 @@
|
|||||||
<a name="opengauss_api_0031"></a><a name="opengauss_api_0031"></a>
|
<a name="EN-US_TOPIC_0000001917290524"></a><a name="EN-US_TOPIC_0000001917290524"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Abnormal Request Results</h1>
|
<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 id="body8662426"><div class="p" id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p896217443168"><strong id="EN-US_TOPIC_0000001917290524__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>
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_table7745218464" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Abnormal response description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_row879102194619"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p38113217464"><strong id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_b84235270691445">Name</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p581192104614"><strong id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_b842352706164541">Type</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p883152154610"><strong>Description</strong></p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</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>
|
<tbody><tr id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_row1485152113462"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p12851213469">error_code</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p487192112463">String</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p088221154617">Specifies the error returned when a task submission exception occurs.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_row788132114618"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p29082164616">error_msg</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p1290102116462">String</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p1592121204615">Specifies the description of the error returned when a task submission exception occurs.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
</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">{
|
<div class="p" id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_p16537184741610"><strong id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_b842352706123757">Response example</strong><pre class="codeblock" id="EN-US_TOPIC_0000001917290524__en-us_topic_0110967108_codeblock5961021204615">{
|
||||||
"error_code": "DBS.200022",
|
"error_code": "DBS.200022",
|
||||||
"error_msg": "The DB instance name already exists."
|
"error_msg": "The DB instance name already exists."
|
||||||
}</pre>
|
}</pre>
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,10 +1,36 @@
|
|||||||
<a name="opengauss_api_0034"></a><a name="opengauss_api_0034"></a>
|
<a name="EN-US_TOPIC_0000001917130752"></a><a name="EN-US_TOPIC_0000001917130752"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Obtaining a Project ID</h1>
|
<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 id="body1592979868268"><div class="section" id="EN-US_TOPIC_0000001917130752__section666918252248"><h4 class="sectiontitle">Scenarios</h4><p id="EN-US_TOPIC_0000001917130752__p322932182217">When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID using either of the following methods:</p>
|
||||||
|
<ul id="EN-US_TOPIC_0000001917130752__ul1938973714396"><li id="EN-US_TOPIC_0000001917130752__li183897377391"><a href="#EN-US_TOPIC_0000001917130752__section85791974381">Obtaining the Project ID by Calling an API</a></li><li id="EN-US_TOPIC_0000001917130752__li11307945123915"><a href="#EN-US_TOPIC_0000001917130752__section1952915126435">Obtaining a Project ID from the Console</a></li></ul>
|
||||||
</div>
|
</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="section" id="EN-US_TOPIC_0000001917130752__section85791974381"><a name="EN-US_TOPIC_0000001917130752__section85791974381"></a><a name="section85791974381"></a><h4 class="sectiontitle">Obtaining the Project ID by Calling an API</h4><p id="EN-US_TOPIC_0000001917130752__p857314915139">The API used to obtain a project ID is <strong id="EN-US_TOPIC_0000001917130752__b11784132725918">GET https://</strong><em id="EN-US_TOPIC_0000001917130752__i15785112712591">{Endpoint}</em><strong id="EN-US_TOPIC_0000001917130752__b127864277594">/v3/projects</strong>. <em id="EN-US_TOPIC_0000001917130752__i0786727145916">{Endpoint}</em> is the IAM endpoint and can be obtained from <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. For details about API authentication, see <a href="opengauss_api_0010.html">Authentication</a>.</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 id="EN-US_TOPIC_0000001917130752__p3770181514218">The following is an example response. <strong id="EN-US_TOPIC_0000001917130752__b67341522114917">id</strong> indicates the project ID.</p>
|
||||||
|
<pre class="screen" id="EN-US_TOPIC_0000001917130752__screen676419149446">{
|
||||||
|
"projects": [
|
||||||
|
{
|
||||||
|
"domain_id": "65382450e8f64ac0870cd180d14e684b",
|
||||||
|
"is_domain": false,
|
||||||
|
"parent_id": "65382450e8f64ac0870cd180d14e684b",
|
||||||
|
"name": "project_name",
|
||||||
|
"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_0000001917130752__section1952915126435"><a name="EN-US_TOPIC_0000001917130752__section1952915126435"></a><a name="section1952915126435"></a><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><ol id="EN-US_TOPIC_0000001917130752__ol145281212134316"><li id="EN-US_TOPIC_0000001917130752__li14527171210436"><span>Register yourself on the management console and log in to it.</span></li><li id="EN-US_TOPIC_0000001917130752__li12528131284314"><span id="EN-US_TOPIC_0000001917130752__p852701219438">On the <strong id="EN-US_TOPIC_0000001917130752__b13341325165217">My Credential</strong> page, view project IDs in the project list.</span><p><div class="fignone" id="EN-US_TOPIC_0000001917130752__fig1552811219438"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="EN-US_TOPIC_0000001917130752__image8528161218438" src="figure/en-us_image_0000001917290800.jpg"></span></div>
|
||||||
</p></li></ol>
|
</p></li></ol>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@ -1,21 +1,21 @@
|
|||||||
<a name="opengauss_api_0036"></a><a name="opengauss_api_0036"></a>
|
<a name="EN-US_TOPIC_0000001917290632"></a><a name="EN-US_TOPIC_0000001917290632"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Replication Mode Table</h1>
|
<h1 class="topictitle1">Replication Mode Table</h1>
|
||||||
<div id="body8662426"><p id="opengauss_api_0036__a241205acb0db4058b54dab74a506071f">Replication mode table</p>
|
<div id="body8662426"><p id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_ab489fa561bee423ca0a990cca864c554">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>
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_t256049fcc9bb4ca6bdea22b38b817dc6" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_r1fc5539573734a8a9ec6e7a1495cd7d2"><th align="left" class="cellrowborder" valign="top" width="41.02%" id="mcps1.3.2.1.4.1.1"><p id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_a11d62ebd2b584a54917c133f5e9f9adc"><strong id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_b1416168411153153">Replication Mode</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="34.03%" id="mcps1.3.2.1.4.1.2"><p id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_a3154ea18bb1b45b4b80cf5b387cd6c72"><strong id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_b84235270611143">Description</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="24.95%" id="mcps1.3.2.1.4.1.3"><p id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_ad41173b985f14385b926463b3b2b255d"><strong id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_b794225449153223">Remarks</strong></p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</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>
|
<tbody><tr id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_row294602349935"><td class="cellrowborder" valign="top" width="41.02%" headers="mcps1.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_p95405789935">sync</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="34.03%" headers="mcps1.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_p345893409935">Synchronous</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="24.95%" headers="mcps1.3.2.1.4.1.3 "><p id="EN-US_TOPIC_0000001917290632__en-us_topic_0110967205_p502731759935">N/A</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|||||||
@ -1,50 +1,46 @@
|
|||||||
<a name="opengauss_api_0037"></a><a name="opengauss_api_0037"></a>
|
<a name="EN-US_TOPIC_0000001917130736"></a><a name="EN-US_TOPIC_0000001917130736"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">DB Instance Class</h1>
|
<h1 class="topictitle1">DB Instance Specifications</h1>
|
||||||
<div id="body8662426"><p id="opengauss_api_0037__p8060118">This section describes the GaussDB(openGauss) DB instance class.</p>
|
<div id="body8662426"><p id="EN-US_TOPIC_0000001917130736__p8060118">This section describes the <span id="EN-US_TOPIC_0000001917130736__text1276027889">GaussDB</span> instance specifications.</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>
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130736__table64111016147"></a><a name="table64111016147"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130736__table64111016147" frame="border" border="1" rules="all"><caption><b>Table 1 </b>DB instance specifications</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130736__row241180111410"><th align="left" class="cellrowborder" valign="top" width="13.888611138886112%" id="mcps1.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001917130736__p13424010140"><strong id="EN-US_TOPIC_0000001917130736__b1031152707">Specification Type</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="41.3058694130587%" id="mcps1.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001917130736__p64290161410"><strong id="EN-US_TOPIC_0000001917130736__b529558888">Specification Code</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="24.857514248575143%" id="mcps1.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001917130736__p942609141"><strong id="EN-US_TOPIC_0000001917130736__b1588999730">vCPUs</strong></p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="19.948005199480054%" id="mcps1.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001917130736__p8421012148"><strong id="EN-US_TOPIC_0000001917130736__b169594143">Memory (GB)</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>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</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>
|
<tbody><tr id="EN-US_TOPIC_0000001917130736__row10421011140"><td class="cellrowborder" rowspan="4" valign="top" width="13.888611138886112%" headers="mcps1.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130736__p1589014643010">General-enhanced II</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="41.3058694130587%" headers="mcps1.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130736__p042160171413">gaussdb.opengauss.ee.dn.m4.2xlarge.8.in</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="24.857514248575143%" headers="mcps1.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130736__p9421051419">8</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="19.948005199480054%" headers="mcps1.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130736__p64250161411">64</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>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr id="EN-US_TOPIC_0000001917130736__row12421205143"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130736__p242100171411">gaussdb.opengauss.ee.dn.m4.4xlarge.8.in</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.2 "><p id="opengauss_api_0037__p620914201113">16</p>
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130736__p124219019145">16</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.3 "><p id="opengauss_api_0037__p3209114151118">128</p>
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130736__p14421707147">128</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr id="EN-US_TOPIC_0000001917130736__row1242009147"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130736__p3421201145">gaussdb.opengauss.ee.dn.m4.8xlarge.8.in</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.2 "><p id="opengauss_api_0037__p026730135512">32</p>
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130736__p1942206147">32</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.3 "><p id="opengauss_api_0037__p62611304556">256</p>
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130736__p18421108144">256</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr id="EN-US_TOPIC_0000001917130736__row2042180201415"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130736__p84218011140">gaussdb.opengauss.ee.dn.m4.16xlarge.8.in</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.2 "><p id="opengauss_api_0037__p1998417314553">64</p>
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130736__p0437015145">64</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.6.1.3 "><p id="opengauss_api_0037__p1598423145511">521</p>
|
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130736__p124320111416">512</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|||||||
@ -1,16 +1,36 @@
|
|||||||
<a name="opengauss_api_0038"></a><a name="opengauss_api_0038"></a>
|
<a name="EN-US_TOPIC_0000001917290528"></a><a name="EN-US_TOPIC_0000001917290528"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Change History</h1>
|
<h1 class="topictitle1">Change History</h1>
|
||||||
<div id="body8662426">
|
<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>
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290528__table7502045123619" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001917290528__row6504458364"><th align="left" class="cellrowborder" valign="top" width="18.48%" id="mcps1.3.1.1.3.1.1"><p id="EN-US_TOPIC_0000001917290528__p750645123610">Release Date</p>
|
||||||
</th>
|
</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 align="left" class="cellrowborder" valign="top" width="81.52000000000001%" id="mcps1.3.1.1.3.1.2"><p id="EN-US_TOPIC_0000001917290528__p11508455365">Description</p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</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>
|
<tbody><tr id="EN-US_TOPIC_0000001917290528__row185616735512"><td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001917290528__p15622719553">2024-08-05</p>
|
||||||
</td>
|
</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 class="cellrowborder" valign="top" width="81.52000000000001%" headers="mcps1.3.1.1.3.1.2 "><ul id="EN-US_TOPIC_0000001917290528__ul122101341195611"><li id="EN-US_TOPIC_0000001917290528__li202613918312">Added the basic concept of <a href="opengauss_api_0006.html#EN-US_TOPIC_0000001947569525__en-us_topic_0169294976_li3896216123113">project</a>.</li><li id="EN-US_TOPIC_0000001917290528__li514815114211">Added <a href="opengauss_newapi_0035.html">Obtaining Task Information</a>.</li><li id="EN-US_TOPIC_0000001917290528__li1349313246593">Added the parameters<strong id="EN-US_TOPIC_0000001917290528__b53615495185"> type</strong> and <strong id="EN-US_TOPIC_0000001917290528__b11129155419187">detail</strong> in <a href="opengauss_newapi_0030.html">Querying the Components of a DB Instance</a>.</li><li id="EN-US_TOPIC_0000001917290528__li126037412001">Modified the format of the example request in <a href="opengauss_api_0026.html">Configuring an Automated Backup Policy</a>.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290528__row89470410275"><td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001917290528__p5948124152717">2023-02-21</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="81.52000000000001%" headers="mcps1.3.1.1.3.1.2 "><ul id="EN-US_TOPIC_0000001917290528__ul7692333142818"><li id="EN-US_TOPIC_0000001917290528__li2692193315282">Changed the instance version to 1.4.</li><li id="EN-US_TOPIC_0000001917290528__li2692183392812">Revised this document according to test results.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290528__row28792592111"><td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001917290528__p888065152113">2022-05-16</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="81.52000000000001%" headers="mcps1.3.1.1.3.1.2 "><ul id="EN-US_TOPIC_0000001917290528__ul186657484212"><li id="EN-US_TOPIC_0000001917290528__li7388550152116">Modified the hyperlink address for obtaining endpoints in the test environment.</li><li id="EN-US_TOPIC_0000001917290528__li366514485212">Changed the specification code to <strong id="EN-US_TOPIC_0000001917290528__b19800112517483">gaussdb.opengauss.ee.dn.m4.</strong><em id="EN-US_TOPIC_0000001917290528__i16399235194814">xxx</em>.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290528__row197991928597"><td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001917290528__p0741428133916">2020-02-18</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="81.52000000000001%" headers="mcps1.3.1.1.3.1.2 "><ul id="EN-US_TOPIC_0000001917290528__ul18302112434618"><li id="EN-US_TOPIC_0000001917290528__li2250102954613">Moved the API from the RDS to the <span id="EN-US_TOPIC_0000001917290528__text582257707">GaussDB</span>.</li><li id="EN-US_TOPIC_0000001917290528__li330252415467">Rectified the UAT problem raised by GR.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290528__row1150745193620"><td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001917290528__p1450845193610">2020-11-30</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="81.52000000000001%" headers="mcps1.3.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001917290528__p135044519369">This issue is the first official release.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|||||||
13
docs/opengauss/api-ref/opengauss_api_1013.html
Normal file
13
docs/opengauss/api-ref/opengauss_api_1013.html
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<a name="EN-US_TOPIC_0000001917290668"></a><a name="EN-US_TOPIC_0000001917290668"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Historical APIs</h1>
|
||||||
|
<div id="body8662426"></div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_1014.html">DB Instance Management</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_1023.html">Parameter Configuration</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
21
docs/opengauss/api-ref/opengauss_api_1014.html
Normal file
21
docs/opengauss/api-ref/opengauss_api_1014.html
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
<a name="EN-US_TOPIC_0000001917130712"></a><a name="EN-US_TOPIC_0000001917130712"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">DB Instance Management</h1>
|
||||||
|
<div id="body8662426"></div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_1016.html">Scaling up Storage Space of a DB Instance</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_1017.html">Deleting a DB Instance</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_1019.html">Adding CNs</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_1020.html">Adding Shards</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_1013.html">Historical APIs</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
133
docs/opengauss/api-ref/opengauss_api_1016.html
Normal file
133
docs/opengauss/api-ref/opengauss_api_1016.html
Normal file
File diff suppressed because it is too large
Load Diff
77
docs/opengauss/api-ref/opengauss_api_1017.html
Normal file
77
docs/opengauss/api-ref/opengauss_api_1017.html
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
<a name="EN-US_TOPIC_0000001917290420"></a><a name="EN-US_TOPIC_0000001917290420"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Deleting a DB Instance</h1>
|
||||||
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section4284989"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p0506143014918">This API is used to delete a DB instance. Before calling this API:</p>
|
||||||
|
<ul id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section38564907"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_ul13194498"><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li51641620">URI format<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p819462816594"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li51641620"></a><a name="en-us_topic_0128427214_li51641620"></a>DELETE https://{<em id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/opengauss/v3/{project_id}/instances/{instance_id}</p>
|
||||||
|
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li4411135064210">Example<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p1454414211213"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li4411135064210"></a><a name="en-us_topic_0128427214_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01</p>
|
||||||
|
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li22221662">Parameter description
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290420__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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p10809459"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b9296112613193">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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p3150961"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b0858729171912">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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p53901255"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b14869123081916">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="EN-US_TOPIC_0000001917290420__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="EN-US_TOPIC_0000001917290420__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="EN-US_TOPIC_0000001917290420__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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p43776822">Project ID of a tenant in a region.</p>
|
||||||
|
<p id="EN-US_TOPIC_0000001917290420__p8544202712219">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_row19402550154517"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p1046217474614">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="EN-US_TOPIC_0000001917290420__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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p18462124174611">DB instance ID.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section1390010340492"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p2901934154915">None</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section36749739"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_ul48268995"><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li31767774">Normal response
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_table17474517" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290420__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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p32787233"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b1095164516326">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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p38520254"><strong id="EN-US_TOPIC_0000001917290420__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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p33132859"><strong id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_b11276447183217">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_row1625804435012"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p1165525810503">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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p116551958135013">String</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p16655115865012">ID of the DB instance deletion task.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li966441310127">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_codeblock11412165015361">{
|
||||||
|
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
|
||||||
|
}</pre>
|
||||||
|
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_li18559781316">Abnormal response<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_p172314336131"><a name="EN-US_TOPIC_0000001917290420__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="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a>202</p>
|
||||||
|
</li><li id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
||||||
|
</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="EN-US_TOPIC_0000001917290420__en-us_topic_0128427214_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917290420__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">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_1014.html">DB Instance Management</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
175
docs/opengauss/api-ref/opengauss_api_1019.html
Normal file
175
docs/opengauss/api-ref/opengauss_api_1019.html
Normal file
File diff suppressed because it is too large
Load Diff
134
docs/opengauss/api-ref/opengauss_api_1020.html
Normal file
134
docs/opengauss/api-ref/opengauss_api_1020.html
Normal file
File diff suppressed because it is too large
Load Diff
15
docs/opengauss/api-ref/opengauss_api_1023.html
Normal file
15
docs/opengauss/api-ref/opengauss_api_1023.html
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
<a name="EN-US_TOPIC_0000001917290400"></a><a name="EN-US_TOPIC_0000001917290400"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Parameter Configuration</h1>
|
||||||
|
<div id="body8662426"></div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="opengauss_api_1024.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_1013.html">Historical APIs</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
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