1
0
forked from docs/doc-exports

Compare commits

...

1 Commits

Author SHA1 Message Date
3b004c98a0 Recreating PR
docs/doc-exports#546
2023-07-11 13:41:14 +00:00
91 changed files with 20401 additions and 2552 deletions

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

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

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

View File

@ -2,21 +2,34 @@
<h1 class="topictitle1">Change History</h1>
<div id="body1467250505020">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="changeHistory__en-us_topic_0040992811_table6481898101221" frame="border" border="1" rules="all"><thead align="left"><tr id="changeHistory__en-us_topic_0040992811_row27774172101221"><th align="left" class="cellrowborder" valign="top" width="36.4%" id="mcps1.3.1.1.3.1.1"><p id="changeHistory__en-us_topic_0040992811_p35115458101221">Released On</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="changeHistory__table83991098596" frame="border" border="1" rules="all"><thead align="left"><tr id="changeHistory__row11399129185915"><th align="left" class="cellrowborder" valign="top" width="36.4%" id="mcps1.3.1.1.3.1.1"><p id="changeHistory__p193995915918">Released On</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63.6%" id="mcps1.3.1.1.3.1.2"><p id="changeHistory__en-us_topic_0040992811_p25779820101221"><strong id="changeHistory__b8423527068368">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="63.6%" id="mcps1.3.1.1.3.1.2"><p id="changeHistory__p5399198593"><strong id="changeHistory__b178141629141914">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="changeHistory__row101351239114420"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p161351839144410">2022-10-30</p>
<tbody><tr id="changeHistory__row13363101219371"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p83634121372">2023-04-06</p>
</td>
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p113543914441">This issue is the second official release.</p>
<ul id="changeHistory__ul117213915410"><li id="changeHistory__li137219916549">Optimized the content in <a href="gaussdb_04_0009.html">Querying a Parameter Template</a>.</li><li id="changeHistory__li272139115415">Optimized the content in <a href="gaussdb_04_0005.html">Querying a DB Instance List</a>.</li></ul>
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p183630127377">Modified the following content:</p>
<ul id="changeHistory__ul17466218164112"><li id="changeHistory__li3467161816412">Deleted the <span class="parmname" id="changeHistory__parmname1528313264020"><b>backup_level</b></span> parameter in <a href="gaussdb_06_0004.html">Querying Backups</a>.</li><li id="changeHistory__li8467151824119">Deleted the <span class="parmname" id="changeHistory__parmname0158313154118"><b>retention_num_backup_level1</b></span> parameter in <a href="gaussdb_06_0005.html">Querying an Automated Backup Policy</a>.</li></ul>
</td>
</tr>
<tr id="changeHistory__en-us_topic_0040992811_row7790658101221"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__en-us_topic_0040992811_p27063598101221">2020-05-30</p>
<tr id="changeHistory__row146691251018"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p146701351102">2022-11-30</p>
</td>
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__en-us_topic_0040992811_p44667797101221">This issue is the first official release.</p>
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p136701551403">Modified the following content:</p>
<ul id="changeHistory__ul2071551398"><li id="changeHistory__li1630219195262">Added <a href="gaussdb_04_0001.html">Querying Version Information About a DB Engine</a>.</li><li id="changeHistory__li1926563910267">Added <a href="gaussdb_04_0002.html">Querying Database Specifications</a>.</li><li id="changeHistory__li663816171349">Added <a href="gaussdb_04_0007.html">Deleting a DB Instance</a>.</li><li id="changeHistory__li21511220143413">Added <a href="gaussdb_04_0006.html">Querying Details of a DB Instance</a>.</li><li id="changeHistory__li7798020173410">Added <a href="gaussdb_04_0015.html">Creating a Read Replica</a>.</li><li id="changeHistory__li10401152118347">Added <a href="gaussdb_04_0016.html">Deleting a Read Replica</a>.</li><li id="changeHistory__li111732263414">Added <a href="gaussdb_04_0018.html">Changing a DB Instance Name</a>.</li><li id="changeHistory__li316364913519">Added <a href="gaussdb_04_0019.html">Resetting a Database Password</a>.</li><li id="changeHistory__li16745155014351">Added <a href="gaussdb_04_0020.html">Changing DB Instance Specifications</a>.</li><li id="changeHistory__li712154719367">Added <a href="gaussdb_06_0003.html">Creating a Manual Backup</a>.</li><li id="changeHistory__li131212476362">Added <a href="gaussdb_06_0004.html">Querying Backups</a>.</li><li id="changeHistory__li01214478368">Added <a href="gaussdb_06_0005.html">Querying an Automated Backup Policy</a>.</li><li id="changeHistory__li812144711369">Added <a href="gaussdb_06_0006.html">Modifying an Automated Backup Policy</a>.</li><li id="changeHistory__li168041444380">Added <a href="gaussdb_04_0009.html">Querying Parameter Templates</a>.</li><li id="changeHistory__li584017571394">Added <a href="gaussdb_04_0011.html">Querying Resource Quotas</a>.</li><li id="changeHistory__li1699193210402">Added <a href="gaussdb_04_0012.html">Configuring Resource Quotas</a>.</li><li id="changeHistory__li884945684015">Added <a href="gaussdb_04_0013.html">Modifying Resource Quotas</a>.</li><li id="changeHistory__li12921612184110">Added <a href="ShowGaussMySqlProjectQuotas.html">Querying the DB Instance Quotas of a Tenant</a>.</li><li id="changeHistory__li13710516917">Added <a href="ShowGaussMySqlProxyFlavors.html">Querying Database Proxy Specifications</a>.</li><li id="changeHistory__li207145111920">Added <a href="CreateGaussMySqlProxy.html">Enabling Database Proxy</a>.</li><li id="changeHistory__li1717516913">Added <a href="DeleteGaussMySqlProxy.html">Disabling Database Proxy</a>.</li><li id="changeHistory__li8814511092">Added <a href="ExpandGaussMySqlProxy.html">Adding Database Proxy Nodes</a>.</li><li id="changeHistory__li6815511192">Added <a href="ShowGaussMySqlProxyList.html">Querying Database Proxy Instances</a>.</li><li id="changeHistory__li681951693">Added <a href="ChangeGaussMySqlProxySpecification.html">Changing Specifications of a Database Proxy Instance</a>.</li><li id="changeHistory__li685511698">Added <a href="SetGaussMySqlProxyWeight.html">Assigning Read Weights</a>.</li><li id="changeHistory__li125506136429">Added <a href="ListGaussMySqlErrorLog.html">Querying Database Error Logs</a>.</li><li id="changeHistory__li1561425017421">Added <a href="ListGaussMySqlSlowLog.html">Querying Database Slow Logs</a>.</li><li id="changeHistory__li1463872215437">Added <a href="ListInstanceTags.html">Querying Resource Tags</a>.</li><li id="changeHistory__li13369710204411">Added <a href="ListProjectTags.html">Querying Project Tags</a>.</li><li id="changeHistory__li78761425194418">Added <a href="BatchTagAction.html">Adding or Deleting Tags in Batches</a>.</li><li id="changeHistory__li8491139124419">Added <a href="SetSqlFilterRule.html">Configuring Concurrency Control Rules of SQL Statements</a>.</li><li id="changeHistory__li159111500457">Added <a href="ShowSqlFilterRule.html">Querying Concurrency Control Rules of SQL Statements</a>.</li><li id="changeHistory__li415275174612">Added <a href="DeleteSqlFilterRule.html">Deleting Concurrency Control Rules of SQL Statements</a>.</li><li id="changeHistory__li1922141811469">Added <a href="ShowGaussMySqlJobInfo.html">Obtaining Information About a Task with a Specified ID</a>.</li></ul>
</td>
</tr>
<tr id="changeHistory__row1354905735913"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p5939514105517">2020-12-09</p>
</td>
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p199399146554">Modified the following content:</p>
<p id="changeHistory__p2061203915218">Optimized the content for API usage.</p>
<p id="changeHistory__p7463174951819">Modified the <strong id="changeHistory__b20756101518211">spec_code description</strong> parameter in <a href="gaussdb_11_0002.html">Querying Database Specifications</a>.</p>
</td>
</tr>
<tr id="changeHistory__row114082098595"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p114081398598">2020-05-30</p>
</td>
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p1140811995912">This issue is the first official release.</p>
</td>
</tr>
</tbody>

View File

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

View File

Before

Width:  |  Height:  |  Size: 136 KiB

After

Width:  |  Height:  |  Size: 136 KiB

View File

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

View File

@ -1,8 +1,11 @@
<a name="gaussdb_00_0001"></a><a name="gaussdb_00_0001"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body1526376873787"><p id="gaussdb_00_0001__p14359124953115">This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see <a href="gaussdb_02_0000.html">API Overview</a>.</p>
<p id="gaussdb_00_0001__p1297413722313">If you plan to access <span id="gaussdb_00_0001__text857462612248">GaussDB(for MySQL)</span> through an API, ensure that you are familiar with <span id="gaussdb_00_0001__text083918328295">GaussDB(for MySQL)</span> concepts. For details, see "What Is GaussDB(for MySQL)?" in the <em id="gaussdb_00_0001__i7344209104116"><span id="gaussdb_00_0001__text139694474293">GaussDB(for MySQL)</span> User Guide</em>.</p>
<div id="body1526376873787"><p id="gaussdb_00_0001__p1988611570306">GaussDB(for MySQL) is a MySQL-compatible, enterprise-grade distributed database service. It uses a compute-storage decoupled architecture and supports up to 128 TB of storage. With GaussDB(for MySQL), there is no need to do sharding, and no need to worry about data loss. It provides superior performance of commercial databases at the price of open-source databases.</p>
<div class="note" id="gaussdb_00_0001__note7572161463911"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_00_0001__p175721414123914">Data Function Virtualization (DFV) is a high-performance and high-reliability distributed storage system that is vertically integrated with databases. Storage clusters are deployed in pools to improve storage utilization.</p>
</div></div>
<p id="gaussdb_00_0001__p14359124953115">This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see <a href="gaussdb_02_0000.html">API Overview</a>.</p>
<p id="gaussdb_00_0001__p11463729115518">If you plan to access GaussDB(for MySQL) through an API, ensure that you are familiar with GaussDB(for MySQL) concepts. For details, see <a href="https://docs.otc.t-systems.com/gaussdb-mysql/umn/introduction/index.html" target="_blank" rel="noopener noreferrer">Introduction</a> in <em id="gaussdb_00_0001__i18356125714618">GaussDB(for MySQL) User Guide</em>.</p>
</div>
<div>
<div class="familylinks">

View File

@ -1,7 +1,7 @@
<a name="gaussdb_00_0002"></a><a name="gaussdb_00_0002"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body1566375229410"><p id="gaussdb_00_0002__p1520294823317"><span id="gaussdb_00_0002__text381915556239">GaussDB(for MySQL)</span> supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="gaussdb_03_0000.html">Calling APIs</a>.</p>
<div id="body1566375229410"><p id="gaussdb_00_0002__p1520294823317"><span id="gaussdb_00_0002__text381915556239">GaussDB(for MySQL)</span> supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="gaussdb_03_0000.html">API Usage Guidelines</a>.</p>
</div>
<div>
<div class="familylinks">

View File

@ -1,13 +1,13 @@
<a name="gaussdb_00_0005"></a><a name="gaussdb_00_0005"></a>
<h1 class="topictitle1">Concepts</h1>
<div id="body1566375229410"><ul id="gaussdb_00_0005__ul128965163312"><li id="gaussdb_00_0005__en-us_topic_0169294976_li11478152103">Domain<p id="gaussdb_00_0005__en-us_topic_0169294976_p947810531016"><a name="gaussdb_00_0005__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 users and grant them permissions for routine management.</p>
</li><li id="gaussdb_00_0005__en-us_topic_0169294976_li15896816113116">IAM User<p id="gaussdb_00_0005__en-us_topic_0169294976_p589691603117"><a name="gaussdb_00_0005__en-us_topic_0169294976_li15896816113116"></a><a name="en-us_topic_0169294976_li15896816113116"></a>An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
<p id="gaussdb_00_0005__en-us_topic_0169294976_p9896121653112">API authentication requires information such as the account name, username, and password.</p>
<div id="body1566375229410"><ul id="gaussdb_00_0005__ul128965163312"><li id="gaussdb_00_0005__li1321965817270">Domain<p id="gaussdb_00_0005__p1021985822719"><a name="gaussdb_00_0005__li1321965817270"></a><a name="li1321965817270"></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 users and grant them permissions for routine management.</p>
</li><li id="gaussdb_00_0005__en-us_topic_0169294976_li15896816113116">IAM User<p id="gaussdb_00_0005__en-us_topic_0169294976_p589691603117"><a name="gaussdb_00_0005__en-us_topic_0169294976_li15896816113116"></a><a name="en-us_topic_0169294976_li15896816113116"></a>An IAM domain is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
<p id="gaussdb_00_0005__en-us_topic_0169294976_p9896121653112">API authentication requires information such as the domain name, username, and password.</p>
</li><li id="gaussdb_00_0005__en-us_topic_0169294976_li1564913617106">Region<p id="gaussdb_00_0005__en-us_topic_0169294976_p10588103711107"><a name="gaussdb_00_0005__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="gaussdb_00_0005__en-us_topic_0169294976_li1183783919109">AZ<p id="gaussdb_00_0005__en-us_topic_0169294976_p061084051014"><a name="gaussdb_00_0005__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="gaussdb_00_0005__en-us_topic_0169294976_li3896216123113">Project<p id="gaussdb_00_0005__en-us_topic_0169294976_p10896181643118"><a name="gaussdb_00_0005__en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0169294976_li3896216123113"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.</p>
<div class="fignone" id="gaussdb_00_0005__en-us_topic_0169294976_fig1189614168311"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="gaussdb_00_0005__en-us_topic_0169294976_image689661615316" src="en-us_image_0000001422968749.gif"></span></div>
<div class="fignone" id="gaussdb_00_0005__en-us_topic_0169294976_fig1189614168311"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="gaussdb_00_0005__en-us_topic_0169294976_image689661615316" src="en-us_image_0000001477110589.gif"></span></div>
</li></ul>
</div>
<div>

View File

@ -21,7 +21,12 @@
</tr>
<tr id="gaussdb_02_0000__row1413084519428"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p3130194524214">DB instance management</p>
</td>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p1413113451421">Create DB instances, query DB instance lists, query DB instance details, delete DB instances, create read replicas, and delete read replicas.</p>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p1413113451421">Create instances, query instance lists, query instance details, delete instances, create read replicas, delete read replicas, change instance names, reset database passwords, and change instance specifications.</p>
</td>
</tr>
<tr id="gaussdb_02_0000__row198376229191"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p20837522141911">Backup management</p>
</td>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p108371229195">Create manual backups, query backup lists, query automated backup policies, and modify automated backup policies.</p>
</td>
</tr>
<tr id="gaussdb_02_0000__row121231020111820"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p5126122015183">Parameter template management</p>
@ -34,9 +39,29 @@
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p31301820131815">Query, set, and modify resource quotas.</p>
</td>
</tr>
<tr id="gaussdb_02_0000__row39061625114416"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p12906525164415">Task information query</p>
<tr id="gaussdb_02_0000__row135994813505"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p17359134817508">Database proxy</p>
</td>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p7906192511448">Obtain task information about the task center.</p>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p635984812505">Query database proxy information and specifications, and enable or disable database proxy.</p>
</td>
</tr>
<tr id="gaussdb_02_0000__row11556145575011"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p1855665575013">Log management</p>
</td>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p1655695516502">Obtain log information, including database error logs and slow logs.</p>
</td>
</tr>
<tr id="gaussdb_02_0000__row6898211948"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p2089971343">Tag management</p>
</td>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p16899415418">Manage tags, including adding tags in batches, deleting tags in batches, and querying project tags.</p>
</td>
</tr>
<tr id="gaussdb_02_0000__row94616141417"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p13461141420410">SQL statement concurrency control</p>
</td>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p246111141241">Query, configure and delete concurrency control rules of SQL statements.</p>
</td>
</tr>
<tr id="gaussdb_02_0000__row166084384317"><td class="cellrowborder" valign="top" width="23.990000000000002%" headers="mcps1.3.2.1.3.1.1 "><p id="gaussdb_02_0000__p1457815411138">Task center</p>
</td>
<td class="cellrowborder" valign="top" width="76.01%" headers="mcps1.3.2.1.3.1.2 "><p id="gaussdb_02_0000__p657812411430">Obtain task information about the task center.</p>
</td>
</tr>
</tbody>

View File

@ -1,6 +1,6 @@
<a name="gaussdb_03_0000"></a><a name="gaussdb_03_0000"></a>
<h1 class="topictitle1">Calling APIs</h1>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body1526376873787"></div>
<div>
<ul class="ullinks">

View File

@ -6,11 +6,35 @@
<div class="section" id="gaussdb_03_0001__section2417768214391"><h4 class="sectiontitle">Token-based Authentication</h4><div class="note" id="gaussdb_03_0001__note133321911123"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_03_0001__p1254514271026">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</p>
</div></div>
<p id="gaussdb_03_0001__p18703477214">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="gaussdb_03_0001__screen1523316215617">{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "<strong id="gaussdb_03_0001__b523211213611"><em id="gaussdb_03_0001__i152321121768">username</em></strong>",
"password": "<strong id="gaussdb_03_0001__b1423242864"><em id="gaussdb_03_0001__i102321723618">********</em></strong>",
"domain": {
"name": "<strong id="gaussdb_03_0001__b1232182160"><em id="gaussdb_03_0001__i142321521463">domainname</em></strong>"
}
}
}
},
<strong id="gaussdb_03_0001__b172326214617"> "scope": {</strong><strong id="gaussdb_03_0001__b122324215616"> </strong>
<strong id="gaussdb_03_0001__b32321024619"> </strong><strong id="gaussdb_03_0001__b62336216618"> "project": {</strong><strong id="gaussdb_03_0001__b1623362867"> </strong>
<strong id="gaussdb_03_0001__b1423332562"> </strong><strong id="gaussdb_03_0001__b8233162061"> "name": "<em id="gaussdb_03_0001__i6233321063">xxxxxxxx</em>"</strong><strong id="gaussdb_03_0001__b123313217620"> </strong>
<strong id="gaussdb_03_0001__b1423332869"> </strong><strong id="gaussdb_03_0001__b52331822611"> }</strong><strong id="gaussdb_03_0001__b1223313212617"> </strong>
<strong id="gaussdb_03_0001__b182333215616"> </strong><strong id="gaussdb_03_0001__b17233172167"> }</strong><strong id="gaussdb_03_0001__b122332212612"> </strong>
}
}
</pre>
<p id="gaussdb_03_0001__p116169153412">In <a href="gaussdb_03_0005.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="gaussdb_03_0001__p9691122114266">After a token is obtained, add the <strong id="gaussdb_03_0001__b1897020427341">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="gaussdb_03_0001__parmvalue1038232518315"><b>ABCDEFJ....</b></span>, <span class="parmvalue" id="gaussdb_03_0001__parmvalue10383725113110"><b>X-Auth-Token: ABCDEFJ....</b></span> can be added to a request as follows:</p>
<div class="codecoloring" codetype="Java" id="gaussdb_03_0001__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></pre></div></td><td class="code"><div><pre><span></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="w"></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><span class="w"></span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></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>
@ -18,7 +42,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">Calling APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">API Usage Guidelines</a></div>
</div>
</div>

View File

@ -1,7 +1,7 @@
<a name="gaussdb_03_0005"></a><a name="gaussdb_03_0005"></a>
<h1 class="topictitle1">Making an API Request</h1>
<div id="body1565856735961"><p id="gaussdb_03_0005__p15648656678">This section describes the structure of a REST API, and uses the IAM API for <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a> as an example to describe how to call an API. The obtained token is used to authenticate the calling of other APIs.</p>
<div id="body1565856735961"><p id="gaussdb_03_0005__p15648656678">This section describes the structure of a REST API, and uses the IAM API for <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a> as an example to describe how to call an API. The obtained token is used to authenticate the calling of other APIs. </p>
<div class="section" id="gaussdb_03_0005__en-us_topic_0113746487_section697653216219"><h4 class="sectiontitle">Request URI</h4><p id="gaussdb_03_0005__en-us_topic_0113746487_p1327834192114">A request URI consists of the following:</p>
<p id="gaussdb_03_0005__en-us_topic_0113746487_p015994616212"><strong id="gaussdb_03_0005__en-us_topic_0113746487_b11186155382110">{URI-scheme}://{Endpoint}/{resource-path}?{query-string}</strong></p>
<p id="gaussdb_03_0005__en-us_topic_0113746487_p16960034182113">Although a request URI is included in a request header, most programming languages or frameworks require the request URI to be separately transmitted, rather than being conveyed in a request message.</p>
@ -138,7 +138,7 @@
</div>
<div class="section" id="gaussdb_03_0005__en-us_topic_0113746487_section1437471411"><h4 class="sectiontitle">(Optional) Request Body</h4><p id="gaussdb_03_0005__en-us_topic_0113746487_p76011911717">This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the <strong id="gaussdb_03_0005__b47491871565">Content-Type</strong> header field. If the request body contains full-width characters, these characters must be coded in UTF-8.</p>
<p id="gaussdb_03_0005__p1847214711331">The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.</p>
<div class="p" id="gaussdb_03_0005__p105261225101112">In the case of 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 parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="gaussdb_03_0005__i760515733013"><strong id="gaussdb_03_0005__b1759911572301">username</strong></em>, <em id="gaussdb_03_0005__i660610578309"><strong id="gaussdb_03_0005__b1360585733018">domainname</strong></em>, <strong id="gaussdb_03_0005__b66062577304"><em id="gaussdb_03_0005__i14606105723011">********</em></strong> (login password), and <strong id="gaussdb_03_0005__b16607185753018"><em id="gaussdb_03_0005__i8607957133017">xxxxxxxxxxxxxxxxxx</em></strong> (project name) with actual values. You can obtain the values from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.<div class="note" id="gaussdb_03_0005__note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_03_0005__p199011223194814">The <strong id="gaussdb_03_0005__b13818161722011">scope</strong> parameter specifies where a token takes effect. You can set <strong id="gaussdb_03_0005__b78485714154">scope</strong> to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</p>
<div class="p" id="gaussdb_03_0005__p105261225101112">In the case of 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 parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="gaussdb_03_0005__i19326175117"><strong id="gaussdb_03_0005__b183171711119">username</strong></em>, <em id="gaussdb_03_0005__i4334179114"><strong id="gaussdb_03_0005__b1533017516">domainname</strong></em>, <strong id="gaussdb_03_0005__b9351017418"><em id="gaussdb_03_0005__i163418177113">********</em></strong> (login password), and <strong id="gaussdb_03_0005__b10361171719"><em id="gaussdb_03_0005__i183617171411">xxxxxxxxxxxxxxxxxx</em></strong> (project name) with actual values. It can be obtained from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.<div class="note" id="gaussdb_03_0005__note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_03_0005__p199011223194814">The <strong id="gaussdb_03_0005__b13818161722011">scope</strong> parameter specifies where a token takes effect. You can set <strong id="gaussdb_03_0005__b78485714154">scope</strong> to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</p>
</div></div>
</div>
<pre class="screen" id="gaussdb_03_0005__screen18404136819">
@ -172,7 +172,7 @@ Content-Type: application/json
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">Calling APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">API Usage Guidelines</a></div>
</div>
</div>

View File

@ -7,7 +7,7 @@
</div>
<div class="section" id="gaussdb_03_0006__en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Header</h4><p id="gaussdb_03_0006__p384320471837">Similar to a request, a response also has a header, for example, <span class="parmvalue" id="gaussdb_03_0006__en-us_topic_0170210614_en-us_topic_0170195383_parmvalue1720109175113"><b>Content-Type</b></span>.</p>
<p id="gaussdb_03_0006__p4430113619484"><a href="#gaussdb_03_0006__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="gaussdb_03_0006__parmname1158321119598"><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="gaussdb_03_0006__fig4865141011511"><a name="gaussdb_03_0006__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="gaussdb_03_0006__image48651610135113" src="en-us_image_0000001372529646.png"></span></div>
<div class="fignone" id="gaussdb_03_0006__fig4865141011511"><a name="gaussdb_03_0006__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="gaussdb_03_0006__image48651610135113" src="en-us_image_0000001427231638.png"></span></div>
</div>
<div class="section" id="gaussdb_03_0006__en-us_topic_0113746487_section2045571671419"><h4 class="sectiontitle">(Optional) Response Body</h4><p id="gaussdb_03_0006__en-us_topic_0113746487_p64711881416">This part is optional. The body of a response is often returned in structured format as specified in the <strong id="gaussdb_03_0006__b197075411100">Content-Type</strong> header field. The response body transfers content except the response header.</p>
<div class="p" id="gaussdb_03_0006__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="gaussdb_03_0006__screen01152675713">{
@ -33,7 +33,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">Calling APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">API Usage Guidelines</a></div>
</div>
</div>

View File

@ -1,6 +1,6 @@
<a name="gaussdb_04_0000"></a><a name="gaussdb_04_0000"></a>
<h1 class="topictitle1">API</h1>
<h1 class="topictitle1">APIs (Recommended)</h1>
<div id="body1526376873788"></div>
<div>
<ul class="ullinks">
@ -10,11 +10,21 @@
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0003.html">Managing DB Instances</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0008.html">Managing Parameter Templates</a></strong><br>
<li class="ulchildlink"><strong><a href="gaussdb_06_0002.html">Backup Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0010.html">Managing Quotas</a></strong><br>
<li class="ulchildlink"><strong><a href="gaussdb_04_0008.html">Parameter Template Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0014.html">Obtaining Task Information</a></strong><br>
<li class="ulchildlink"><strong><a href="gaussdb_04_0010.html">Quota Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000006.html">Database Proxy</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000007.html">Log Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000009.html">Tag Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000012.html">SQL Statement Concurrency Control</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0014.html">Task Center</a></strong><br>
</li>
</ul>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -5,18 +5,32 @@
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="gaussdb_04_0004.html">Creating a DB instance</a></strong><br>
<li class="ulchildlink"><strong><a href="gaussdb_04_0004.html">Creating a DB Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0005.html">Querying a DB Instance List</a></strong><br>
<li class="ulchildlink"><strong><a href="gaussdb_04_0005.html">Querying DB Instances</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0007.html">Deleting a DB Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0006.html">Querying Details of a DB Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0007.html">Deleting a DB Instance</a></strong><br>
<li class="ulchildlink"><strong><a href="gaussdb_04_0015.html">Creating a Read Replica</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0016.html">Deleting a Read Replica</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0018.html">Changing a DB Instance Name</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0019.html">Resetting a Database Password</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0020.html">Changing DB Instance Specifications</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="UpdateInstanceMonitor.html">Changing the Collection Period of Monitoring by Seconds</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ShowInstanceMonitorExtend.html">Querying the Collection Period of Monitoring by Seconds</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0000.html">API</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0000.html">APIs (Recommended)</a></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

View File

@ -1,16 +1,15 @@
<a name="gaussdb_04_0008"></a><a name="gaussdb_04_0008"></a>
<h1 class="topictitle1">Managing Parameter Templates</h1>
<div id="body1590815684863"><p id="gaussdb_04_0008__p8060118"></p>
</div>
<h1 class="topictitle1">Parameter Template Management</h1>
<div id="body1590815684863"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="gaussdb_04_0009.html">Querying a Parameter Template</a></strong><br>
<li class="ulchildlink"><strong><a href="gaussdb_04_0009.html">Querying Parameter Templates</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0000.html">API</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0000.html">APIs (Recommended)</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -1,11 +1,7 @@
<a name="gaussdb_04_0010"></a><a name="gaussdb_04_0010"></a>
<h1 class="topictitle1">Managing Quotas</h1>
<div id="body1590815684864"><p id="gaussdb_04_0010__p8060118"></p>
</div>
<h1 class="topictitle1">Quota Management</h1>
<div id="body1590815684864"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="gaussdb_04_0011.html">Querying Resource Quotas</a></strong><br>
@ -14,10 +10,12 @@
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0013.html">Modifying Resource Quotas</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ShowGaussMySqlProjectQuotas.html">Querying the DB Instance Quotas of a Tenant</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0000.html">API</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0000.html">APIs (Recommended)</a></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

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