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

gaussdbformysql_api_20250318

Browse Source 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
This commit is contained in:
Wang , Deng Ke
2025-03-31 06:12:59 +00:00
committed by zuul
parent 465341a1a9
commit 41ce571d15
20 changed files with 730 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files

229
docs/gaussdb_mysql/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

337
docs/gaussdb_mysql/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

8
docs/gaussdb_mysql/api-ref/changeHistory.html
View File

@ -8,7 +8,13 @@
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="changeHistory__row12681181236"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p168389231">2024-04-15</p> <tbody><tr id="changeHistory__row197546192510"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p597556112512">2025-03-10</p>
</td>
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p1690121862512">Added the following content:</p>
<ul id="changeHistory__ul29011118192515"><li id="changeHistory__li290119184250"><a href="en-us_topic_0000002235229005.html">Querying API Versions</a></li><li id="changeHistory__li490181815252"><a href="en-us_topic_0000002200308556.html">Querying a Specified API Version</a></li></ul>
</td>
</tr>
<tr id="changeHistory__row12681181236"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p168389231">2024-04-15</p>
</td> </td>
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p5682811237">Added the following content:</p> <td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p5682811237">Added the following content:</p>
<ul id="changeHistory__ul256715408232"><li id="changeHistory__li135671140152313"><a href="UpdateGaussMySqlInstancePort.html">Changing a Database Port</a></li><li id="changeHistory__li7457145615234"><a href="UpdateSqlFilterControl.html">Enabling or Disabling SQL Statement Concurrency Control</a></li><li id="changeHistory__li449820992413"><a href="ShowSqlFilterControl.html">Querying Whether SQL Statement Concurrency Control Is Enabled</a></li><li id="changeHistory__li7770191992414"><a href="SetSqlFilterRule.html">Configuring Concurrency Control Rules of SQL Statements</a></li><li id="changeHistory__li673152872415"><a href="ShowSqlFilterRule.html">Querying Concurrency Control Rules of SQL Statements</a></li><li id="changeHistory__li449874013247"><a href="DeleteSqlFilterRule.html">Deleting Concurrency Control Rules of SQL Statements</a></li></ul> <ul id="changeHistory__ul256715408232"><li id="changeHistory__li135671140152313"><a href="UpdateGaussMySqlInstancePort.html">Changing a Database Port</a></li><li id="changeHistory__li7457145615234"><a href="UpdateSqlFilterControl.html">Enabling or Disabling SQL Statement Concurrency Control</a></li><li id="changeHistory__li449820992413"><a href="ShowSqlFilterControl.html">Querying Whether SQL Statement Concurrency Control Is Enabled</a></li><li id="changeHistory__li7770191992414"><a href="SetSqlFilterRule.html">Configuring Concurrency Control Rules of SQL Statements</a></li><li id="changeHistory__li673152872415"><a href="ShowSqlFilterRule.html">Querying Concurrency Control Rules of SQL Statements</a></li><li id="changeHistory__li449874013247"><a href="DeleteSqlFilterRule.html">Deleting Concurrency Control Rules of SQL Statements</a></li></ul>

146
docs/gaussdb_mysql/api-ref/en-us_topic_0000002200308556.html Normal file
View File

File diff suppressed because it is too large Load Diff

21
docs/gaussdb_mysql/api-ref/en-us_topic_0000002235108869.html Normal file
View File

@ -0,0 +1,21 @@
<a name="EN-US_TOPIC_0000002235108869"></a><a name="EN-US_TOPIC_0000002235108869"></a>
<h1 class="topictitle1">API Version Queries</h1>
<div id="body0000002235108869"><p id="EN-US_TOPIC_0000002235108869__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0000002235229005.html">Querying API Versions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0000002200308556.html">Querying a Specified API Version</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0000.html">APIs (Recommended)</a></div>
</div>
</div>

121
docs/gaussdb_mysql/api-ref/en-us_topic_0000002235229005.html Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/gaussdb_mysql/api-ref/gaussdb_00_0001.html
View File

@ -1,7 +1,7 @@
<a name="gaussdb_00_0001"></a><a name="gaussdb_00_0001"></a> <a name="gaussdb_00_0001"></a><a name="gaussdb_00_0001"></a>
<h1 class="topictitle1">Overview</h1> <h1 class="topictitle1">Overview</h1>
<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 id="body1526376873787"><p id="gaussdb_00_0001__p1988611570306">GaussDB(for MySQL) is a MySQL-compatible, enterprise-grade distributed database service. It decouples compute from storage and supports up to 128 TB of storage per instance. With GaussDB(for MySQL), there is no need to deal with sharding, and no need to worry about data loss. It provides the high availability and 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 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> </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__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>

2
docs/gaussdb_mysql/api-ref/gaussdb_02_0000.html
View File

@ -1,7 +1,7 @@
<a name="gaussdb_02_0000"></a><a name="gaussdb_02_0000"></a> <a name="gaussdb_02_0000"></a><a name="gaussdb_02_0000"></a>
<h1 class="topictitle1">API Overview</h1> <h1 class="topictitle1">API Overview</h1>
<div id="body1526376998678"><p id="gaussdb_02_0000__p8060118">With <span id="gaussdb_02_0000__text115861912183014">GaussDB(for MySQL)</span> APIs, you can query, set, and modify resource quotas.</p> <div id="body1526376998678"><p id="gaussdb_02_0000__p8060118">With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_02_0000__table486122013184" frame="border" border="1" rules="all"><thead align="left"><tr id="gaussdb_02_0000__row788112019189"><th align="left" class="cellrowborder" valign="top" width="23.990000000000002%" id="mcps1.3.2.1.3.1.1"><p id="gaussdb_02_0000__p18905205186"><strong id="gaussdb_02_0000__b842352706201211">Type</strong></p> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_02_0000__table486122013184" frame="border" border="1" rules="all"><thead align="left"><tr id="gaussdb_02_0000__row788112019189"><th align="left" class="cellrowborder" valign="top" width="23.990000000000002%" id="mcps1.3.2.1.3.1.1"><p id="gaussdb_02_0000__p18905205186"><strong id="gaussdb_02_0000__b842352706201211">Type</strong></p>
</th> </th>

1
docs/gaussdb_mysql/api-ref/gaussdb_03_0001.html
View File

@ -36,7 +36,6 @@
<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="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> <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> </pre></div></td></tr></table></div>
</div> </div>
</div> </div>
</div> </div>

2
docs/gaussdb_mysql/api-ref/gaussdb_04_0000.html
View File

@ -4,6 +4,8 @@
<div id="body1526376873788"></div> <div id="body1526376873788"></div>
<div> <div>
<ul class="ullinks"> <ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0000002235108869.html">API Version Queries</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0001.html">Querying Version Information About a DB Engine</a></strong><br> <li class="ulchildlink"><strong><a href="gaussdb_04_0001.html">Querying Version Information About a DB Engine</a></strong><br>
</li> </li>
<li class="ulchildlink"><strong><a href="gaussdb_04_0002.html">Querying Database Specifications</a></strong><br> <li class="ulchildlink"><strong><a href="gaussdb_04_0002.html">Querying Database Specifications</a></strong><br>

10
docs/gaussdb_mysql/api-ref/gaussdb_04_0002.html
View File

@ -161,7 +161,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0002__p488103018720">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0002__p488103018720">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0002__p1188117303712">Specification type. The value can be <strong id="gaussdb_04_0002__b193368337106">arm</strong>.</p> <td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0002__p1188117303712">Specification type. The value is <strong id="gaussdb_04_0002__b6103535141018">x86</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="gaussdb_04_0002__row4879133010713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0002__p988116309720">id</p> <tr id="gaussdb_04_0002__row4879133010713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0002__p988116309720">id</p>
@ -175,7 +175,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0002__p388119307718">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0002__p388119307718">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0002__p9881193013714">Resource specification code. Its value is same as the value of <strong id="gaussdb_04_0002__b7729140135615">flavor_ref</strong>. For example: gaussdb.mysql.xlarge.arm.8</p> <td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0002__p9881193013714">Resource specification code. Its value is same as the value of <strong id="gaussdb_04_0002__b7729140135615">flavor_ref</strong>. Example: <strong id="gaussdb_04_0002__b65931128433">gaussdb.mysql.xlarge.x86.8</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="gaussdb_04_0002__row1287911301876"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0002__p148821130578">version_name</p> <tr id="gaussdb_04_0002__row1287911301876"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0002__p148821130578">version_name</p>
@ -258,7 +258,7 @@
</table> </table>
</div> </div>
</div> </div>
<div class="section" id="gaussdb_04_0002__section118871130773"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_04_0002__screen1422425122813">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&amp;spec_code=gaussdb.mysql.xlarge.arm.8&amp;availability_zone_mode=single</pre> <div class="section" id="gaussdb_04_0002__section118871130773"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_04_0002__screen1422425122813">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&amp;spec_code=gaussdb.mysql.xlarge.x86.8&amp;availability_zone_mode=single</pre>
</div> </div>
<div class="section" id="gaussdb_04_0002__section168871530379"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_04_0002__p17887133013711"><strong id="gaussdb_04_0002__b1925118175513">Status code: 200</strong></p> <div class="section" id="gaussdb_04_0002__section168871530379"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_04_0002__p17887133013711"><strong id="gaussdb_04_0002__b1925118175513">Status code: 200</strong></p>
<p id="gaussdb_04_0002__p158873301278">Success.</p> <p id="gaussdb_04_0002__p158873301278">Success.</p>
@ -266,9 +266,9 @@
"flavors" : [ { "flavors" : [ {
"vcpus" : "4", "vcpus" : "4",
"ram" : "32", "ram" : "32",
"type" : "arm", "type" : "x86",
"id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"spec_code" : "gaussdb.mysql.xlarge.arm.8", "spec_code" : "gaussdb.mysql.xlarge.x86.8",
"instance_mode" : "Cluster", "instance_mode" : "Cluster",
"version_name" : "8.0", "version_name" : "8.0",
"az_status" : { "az_status" : {

6
docs/gaussdb_mysql/api-ref/gaussdb_04_0004.html
View File

@ -580,7 +580,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_04_0004__p878324153">Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter.</p> <td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_04_0004__p878324153">Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter.</p>
<p id="gaussdb_04_0004__p87842411516">The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.</p> <p id="gaussdb_04_0004__p87842411516">The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.</p>
<ol id="gaussdb_04_0004__ol147818247517"><li id="gaussdb_04_0004__li1478192412515">The <strong id="gaussdb_04_0004__b475848289">HH</strong> value must be 1 greater than the <strong id="gaussdb_04_0004__b556026967">hh</strong> value.</li><li id="gaussdb_04_0004__li147818242511">The values of <strong id="gaussdb_04_0004__b15704131953419">mm</strong> and <strong id="gaussdb_04_0004__b2705101918349">MM</strong> must be the same and must be set to <strong id="gaussdb_04_0004__b1870521963410">00</strong>.</li></ol> <ol id="gaussdb_04_0004__ol147818247517"><li id="gaussdb_04_0004__li1478192412515">The <strong id="gaussdb_04_0004__b248877868">HH</strong> value must be 1 greater than the <strong id="gaussdb_04_0004__b691632883">hh</strong> value.</li><li id="gaussdb_04_0004__li147818242511">The values of <strong id="gaussdb_04_0004__b15704131953419">mm</strong> and <strong id="gaussdb_04_0004__b2705101918349">MM</strong> must be the same and must be set to <strong id="gaussdb_04_0004__b1870521963410">00</strong>.</li></ol>
</td> </td>
</tr> </tr>
<tr id="gaussdb_04_0004__row39887236513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_04_0004__p87814248518">keep_days</p> <tr id="gaussdb_04_0004__row39887236513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_04_0004__p87814248518">keep_days</p>
@ -683,7 +683,7 @@ POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d
"version" : "8.0" "version" : "8.0"
}, },
"mode" : "Cluster", "mode" : "Cluster",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
@ -714,7 +714,7 @@ POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d
"version" : "8.0" "version" : "8.0"
}, },
"mode" : "Cluster", "mode" : "Cluster",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",

6
docs/gaussdb_mysql/api-ref/gaussdb_04_0005.html
View File

@ -587,10 +587,10 @@
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"flavor_info" : { "flavor_info" : {
"vcpus" : 8, "vcpus" : 4,
"ram" : 64 "ram" : 32
}, },
"backup_strategy" : { "backup_strategy" : {
"start_time" : "19:00-20:00", "start_time" : "19:00-20:00",

18
docs/gaussdb_mysql/api-ref/gaussdb_04_0006.html
View File

@ -492,7 +492,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p622172420207">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p622172420207">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p14222192402013">Update time. The format is the same as that of the <strong id="gaussdb_04_0006__b688199774">created</strong> field. The value is empty unless the DB instance creation is complete.</p> <td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p14222192402013">Update time. The format is the same as that of the <strong id="gaussdb_04_0006__b487776793">created</strong> field. The value is empty unless the DB instance creation is complete.</p>
</td> </td>
</tr> </tr>
<tr id="gaussdb_04_0006__row2061365818534"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p9530183120482">flavor_id</p> <tr id="gaussdb_04_0006__row2061365818534"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p9530183120482">flavor_id</p>
@ -747,10 +747,10 @@
"az_code" : "az1", "az_code" : "az1",
"region_code" : "br-iaas-odin1", "region_code" : "br-iaas-odin1",
"flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"max_connections" : 1500, "max_connections" : 10000,
"vcpus" : 1, "vcpus" : 4,
"ram" : 4, "ram" : 32,
"need_restart" : false, "need_restart" : false,
"priority" : 1, "priority" : 1,
"created" : "2022-07-14T16:26:58+0800", "created" : "2022-07-14T16:26:58+0800",
@ -769,10 +769,10 @@
"az_code" : "az1", "az_code" : "az1",
"region_code" : "br-iaas-odin1", "region_code" : "br-iaas-odin1",
"flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"max_connections" : 1500, "max_connections" : 10000,
"vcpus" : 1, "vcpus" : 4,
"ram" : 4, "ram" : 32,
"need_restart" : false, "need_restart" : false,
"priority" : 1, "priority" : 1,
"created" : "2022-07-14T16:26:58+0800", "created" : "2022-07-14T16:26:58+0800",

2
docs/gaussdb_mysql/api-ref/gaussdb_04_0020.html
View File

@ -198,7 +198,7 @@
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action
{ {
"resize_flavor" : { "resize_flavor" : {
"spec_code" : "gaussdb.mysql.xlarge.arm.8" "spec_code" : "gaussdb.mysql.xlarge.x86.8"
} }
}</pre> }</pre>
</div> </div>

2
docs/gaussdb_mysql/api-ref/gaussdb_10_0000.html
View File

@ -12,7 +12,7 @@
</li> </li>
<li class="ulchildlink"><strong><a href="gaussdb_10_0004.html">Obtaining a Project ID</a></strong><br> <li class="ulchildlink"><strong><a href="gaussdb_10_0004.html">Obtaining a Project ID</a></strong><br>
</li> </li>
<li class="ulchildlink"><strong><a href="gaussdb_10_0006.html">GaussDB(for MySQL) Monitoring Metrics</a></strong><br> <li class="ulchildlink"><strong><a href="gaussdb_10_0006.html">GaussDB(for MySQL) Metrics</a></strong><br>
</li> </li>
</ul> </ul>
</div> </div>

130
docs/gaussdb_mysql/api-ref/gaussdb_10_0006.html
View File

File diff suppressed because it is too large Load Diff

15
docs/gaussdb_mysql/api-ref/gaussdb_11_0002.html
View File

@ -160,7 +160,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0002__p66361968387">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0002__p66361968387">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0002__p11636176193816">Specification type. The value can be <strong id="gaussdb_11_0002__b206291213142220">arm</strong>.</p> <td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0002__p11636176193816">Specification type. The value is <strong id="gaussdb_11_0002__b17228510514">x86</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="gaussdb_11_0002__row163414643812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0002__p7636136133813">id</p> <tr id="gaussdb_11_0002__row163414643812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0002__p7636136133813">id</p>
@ -175,7 +175,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0002__p1663716113814">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0002__p1663716113814">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0002__p15559193110194">Resource specification code. Its value is same as the value of <strong id="gaussdb_11_0002__b182501357132219">flavor_ref</strong>.</p> <td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0002__p15559193110194">Resource specification code. Its value is same as the value of <strong id="gaussdb_11_0002__b182501357132219">flavor_ref</strong>.</p>
<p id="gaussdb_11_0002__p770642214313">For example, <strong id="gaussdb_11_0002__b134381229237">gaussdb.mysql.4xlarge.arm.8</strong></p> <p id="gaussdb_11_0002__p770642214313">Example: <strong id="gaussdb_11_0002__b17437733714330">gaussdb.mysql.xlarge.x86.8</strong>.</p>
</td> </td>
</tr> </tr>
<tr id="gaussdb_11_0002__row176341613381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0002__p106376683818">version_name</p> <tr id="gaussdb_11_0002__row176341613381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0002__p106376683818">version_name</p>
@ -189,7 +189,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0002__p146370693810">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0002__p146370693810">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0002__p363710693813">DB instance type. Its value is <strong id="gaussdb_11_0002__b12751203217558">Cluster</strong>.</p> <td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0002__p363710693813">DB instance type. Currently, only the cluster type is supported.</p>
</td> </td>
</tr> </tr>
<tr id="gaussdb_11_0002__row2063426183815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0002__p146372633812">az_status</p> <tr id="gaussdb_11_0002__row2063426183815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0002__p146372633812">az_status</p>
@ -259,17 +259,16 @@
</div> </div>
</div> </div>
<div class="section" id="gaussdb_11_0002__section1464156113811"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_11_0002__screen83125191411">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql</pre> <div class="section" id="gaussdb_11_0002__section1464156113811"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_11_0002__screen83125191411">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql</pre>
<p id="gaussdb_11_0002__p9173164410011"></p>
</div> </div>
<div class="section" id="gaussdb_11_0002__section15641662382"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_11_0002__p10641367386"><strong id="gaussdb_11_0002__b1299015317223">Status code: 202</strong></p> <div class="section" id="gaussdb_11_0002__section15641662382"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_11_0002__p10641367386"><strong id="gaussdb_11_0002__b1299015317223">Status code: 202</strong></p>
<p id="gaussdb_11_0002__p11641763382">Success.</p> <p id="gaussdb_11_0002__p11641763382">Success.</p>
<pre class="screen" id="gaussdb_11_0002__screen486395510165">{ <pre class="screen" id="gaussdb_11_0002__screen486395510165">{
"flavors" : [ { "flavors" : [ {
"vcpus" : "16", "vcpus" : "4",
"ram" : "128", "ram" : "32",
"type" : "arm", "type" : "x86",
"id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"spec_code" : "gaussdb.mysql.4xlarge.arm.8", "spec_code" : "gaussdb.mysql.xlarge.x86.8",
"instance_mode" : "Cluster", "instance_mode" : "Cluster",
"version_name" : "8.0", "version_name" : "8.0",
"az_status" : { "az_status" : {

10
docs/gaussdb_mysql/api-ref/gaussdb_11_0004.html
View File

@ -674,7 +674,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0004__p106638482425">Subscription period.</p> <td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0004__p106638482425">Subscription period.</p>
<p id="gaussdb_11_0004__p14663184811420">Valid value:</p> <p id="gaussdb_11_0004__p14663184811420">Valid value:</p>
<ul id="gaussdb_11_0004__ul466474884214"><li id="gaussdb_11_0004__li06641348184212"><strong id="gaussdb_11_0004__b1157536124">month</strong>: The service is subscribed by month.</li><li id="gaussdb_11_0004__li1966419483426"><strong id="gaussdb_11_0004__b841362645">year</strong>: The service is subscribed by year.</li></ul> <ul id="gaussdb_11_0004__ul466474884214"><li id="gaussdb_11_0004__li06641348184212"><strong id="gaussdb_11_0004__b181245612">month</strong>: The service is subscribed by month.</li><li id="gaussdb_11_0004__li1966419483426"><strong id="gaussdb_11_0004__b909772829">year</strong>: The service is subscribed by year.</li></ul>
<p id="gaussdb_11_0004__p13664144811428">This parameter is valid and mandatory only when <strong id="gaussdb_11_0004__b80912386373616">charge_mode</strong> is set to <strong id="gaussdb_11_0004__b73984402673616">prePaid</strong>.</p> <p id="gaussdb_11_0004__p13664144811428">This parameter is valid and mandatory only when <strong id="gaussdb_11_0004__b80912386373616">charge_mode</strong> is set to <strong id="gaussdb_11_0004__b73984402673616">prePaid</strong>.</p>
</td> </td>
</tr> </tr>
@ -744,7 +744,7 @@
</table> </table>
</div> </div>
</div> </div>
<div class="section" id="gaussdb_11_0004__section467684844210"><h4 class="sectiontitle">Example Request</h4><div class="note" id="gaussdb_11_0004__note3482053511312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_11_0004__p4494936511312">The value of <strong id="gaussdb_11_0004__b105857594">region</strong> in the following is used as an example.</p> <div class="section" id="gaussdb_11_0004__section467684844210"><h4 class="sectiontitle">Example Request</h4><div class="note" id="gaussdb_11_0004__note3482053511312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_11_0004__p4494936511312">The value of <strong id="gaussdb_11_0004__b1650634479">region</strong> in the following is used as an example.</p>
</div></div> </div></div>
<p id="gaussdb_11_0004__p11676194814422">Creating a DB instance</p> <p id="gaussdb_11_0004__p11676194814422">Creating a DB instance</p>
<pre class="screen" id="gaussdb_11_0004__screen26771848134216"> <pre class="screen" id="gaussdb_11_0004__screen26771848134216">
@ -761,7 +761,7 @@ POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930
"version" : "8.0" "version" : "8.0"
}, },
"mode" : "Cluster", "mode" : "Cluster",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
@ -775,7 +775,7 @@ POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930
"enterprise_project_id" : 0 "enterprise_project_id" : 0
}</pre> }</pre>
</div> </div>
<div class="section" id="gaussdb_11_0004__section86821748194212"><h4 class="sectiontitle">Example Response</h4><div class="note" id="gaussdb_11_0004__note58305880113644"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_11_0004__p54990880113644">The values of <strong id="gaussdb_11_0004__b1191050711">region</strong> and <strong id="gaussdb_11_0004__b1336421017">master_availability_zone</strong> are used as examples.</p> <div class="section" id="gaussdb_11_0004__section86821748194212"><h4 class="sectiontitle">Example Response</h4><div class="note" id="gaussdb_11_0004__note58305880113644"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_11_0004__p54990880113644">The values of <strong id="gaussdb_11_0004__b1743957272">region</strong> and <strong id="gaussdb_11_0004__b1145643312">master_availability_zone</strong> are used as examples.</p>
</div></div> </div></div>
<p id="gaussdb_11_0004__p268334814420"><strong id="gaussdb_11_0004__b1434323918338">Status code: 201</strong></p> <p id="gaussdb_11_0004__p268334814420"><strong id="gaussdb_11_0004__b1434323918338">Status code: 201</strong></p>
<p id="gaussdb_11_0004__p2683104813428">Success.</p> <p id="gaussdb_11_0004__p2683104813428">Success.</p>
@ -792,7 +792,7 @@ POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930
"version" : "8.0" "version" : "8.0"
}, },
"mode" : "Cluster", "mode" : "Cluster",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",

16
docs/gaussdb_mysql/api-ref/gaussdb_11_0006.html
View File

@ -614,10 +614,10 @@
</table> </table>
</div> </div>
</div> </div>
<div class="section" id="gaussdb_11_0006__section1989154716550"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_11_0006__p18872025325">Querying details of a DB instance</p> <div class="section" id="gaussdb_11_0006__section1989154716550"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_11_0006__p128910477557">Querying details of a DB instance</p>
<pre class="screen" id="gaussdb_11_0006__screen2853197185320">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/d2cda7b97a39488e8b30e3cea4066204in07</pre> <pre class="screen" id="gaussdb_11_0006__screen2853197185320">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/d2cda7b97a39488e8b30e3cea4066204in07</pre>
</div> </div>
<div class="section" id="gaussdb_11_0006__section7891847155518"><h4 class="sectiontitle">Example Response</h4><div class="note" id="gaussdb_11_0006__note172481213193911"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_11_0006__p1049202913369">The values of <strong id="gaussdb_11_0006__b1318243202">region_code</strong> and <strong id="gaussdb_11_0006__b1737305217">az_code</strong> are used as examples.</p> <div class="section" id="gaussdb_11_0006__section7891847155518"><h4 class="sectiontitle">Example Response</h4><div class="note" id="gaussdb_11_0006__note172481213193911"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_11_0006__p1049202913369">The values of <strong id="gaussdb_11_0006__b1944596614">region_code</strong> and <strong id="gaussdb_11_0006__b821654860">az_code</strong> are used as examples.</p>
</div></div> </div></div>
<p id="gaussdb_11_0006__p58920473558"><strong id="gaussdb_11_0006__b60568813773340">Status code: 201</strong></p> <p id="gaussdb_11_0006__p58920473558"><strong id="gaussdb_11_0006__b60568813773340">Status code: 201</strong></p>
<p id="gaussdb_11_0006__p5891547175516">Success.</p> <p id="gaussdb_11_0006__p5891547175516">Success.</p>
@ -670,10 +670,10 @@
"az_code": "cn-cmcc1a-01", "az_code": "cn-cmcc1a-01",
"region_code": "cn-cmcc1", "region_code": "cn-cmcc1",
"flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"flavor_ref": "gaussdb.mysql.4xlarge.arm.8", "flavor_ref": "gaussdb.mysql.xlarge.x86.8",
"max_connections": null, "max_connections": null,
"vcpus": "16", "vcpus": "4",
"ram": "128", "ram": "32",
"need_restart": false, "need_restart": false,
"priority": 1 "priority": 1
}, },
@ -693,10 +693,10 @@
"az_code": "cn-cmcc1a-01", "az_code": "cn-cmcc1a-01",
"region_code": "cn-cmcc1", "region_code": "cn-cmcc1",
"flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"flavor_ref": "gaussdb.mysql.4xlarge.arm.8", "flavor_ref": "gaussdb.mysql.xlarge.x86.8",
"max_connections": null, "max_connections": null,
"vcpus": "16", "vcpus": "4",
"ram": "128", "ram": "32",
"need_restart": false, "need_restart": false,
"priority": 1 "priority": 1
} }