forked from docs/doc-exports
taurusdb_api
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
This commit is contained in:
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -73,7 +73,7 @@
|
||||
</div>
|
||||
<div class="section" id="DeleteGaussMySqlBackup__section13781112894317"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteGaussMySqlBackup__p17783112819433"><strong id="DeleteGaussMySqlBackup__b10783162874311">Status code: 200</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__en-us_topic_0000001421288836_response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row87849286434"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteGaussMySqlBackup__p97871128124310">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__en-us_topic_0000001421288836_response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row87849286434"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteGaussMySqlBackup__p97871128124310">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteGaussMySqlBackup__p1878882874311">Type</p>
|
||||
</th>
|
||||
@ -100,7 +100,7 @@
|
||||
</div>
|
||||
<p id="DeleteGaussMySqlBackup__p779542813436"><strong id="DeleteGaussMySqlBackup__b1579662815439">Status code: 400</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__en-us_topic_0000001421288836_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row7797102884311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="DeleteGaussMySqlBackup__p16799132874318">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__en-us_topic_0000001421288836_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row7797102884311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="DeleteGaussMySqlBackup__p16799132874318">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="DeleteGaussMySqlBackup__p108005283432">Type</p>
|
||||
</th>
|
||||
@ -127,7 +127,7 @@
|
||||
</div>
|
||||
<p id="DeleteGaussMySqlBackup__p19814828134312"><strong id="DeleteGaussMySqlBackup__b1981510286434">Status code: 500</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__table11815172854317" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameter</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row98161628184319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="DeleteGaussMySqlBackup__p1081819286439">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlBackup__table11815172854317" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="DeleteGaussMySqlBackup__row98161628184319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="DeleteGaussMySqlBackup__p1081819286439">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="DeleteGaussMySqlBackup__p1881912813439">Type</p>
|
||||
</th>
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteGaussMySqlProxy__p36821525120">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteGaussMySqlProxy__p86931565110">DB instance ID.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteGaussMySqlProxy__p86931565110">Instance ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -170,7 +170,8 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="DeleteGaussMySqlProxy__section3112101585118"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="DeleteGaussMySqlProxy__screen178951148348">DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy
|
||||
<div class="section" id="DeleteGaussMySqlProxy__section3112101585118"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="DeleteGaussMySqlProxy__screen178951148348">
|
||||
DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy
|
||||
{
|
||||
"proxy_ids" : [ "151c14381ac14ecfb9703a745b992677po01" ]
|
||||
}</pre>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -4,7 +4,7 @@
|
||||
<div id="body0000001139600175"><div class="section" id="ListGaussMySqlErrorLog__section44230431101549"><h4 class="sectiontitle">Function</h4><p id="ListGaussMySqlErrorLog__p1350220403353">This API is used to query database error logs. Before using this API:</p>
|
||||
<ul id="ListGaussMySqlErrorLog__ul924420236520"><li id="ListGaussMySqlErrorLog__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="ListGaussMySqlErrorLog__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="ListGaussMySqlErrorLog__section1879318591085"><h4 class="sectiontitle">URI</h4><p id="ListGaussMySqlErrorLog__p879315920817">GET /v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date}&node_id={node_id}</p>
|
||||
<div class="section" id="ListGaussMySqlErrorLog__section1879318591085"><h4 class="sectiontitle">URI</h4><p id="ListGaussMySqlErrorLog__p879315920817">GET /v3/{project_id}/instances/{instance_id}/errorlog</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGaussMySqlErrorLog__table18794175917820" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ListGaussMySqlErrorLog__row1279425915812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListGaussMySqlErrorLog__p19794135913815">Parameter</p>
|
||||
</th>
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
<div id="body0000001139477333"><div class="section" id="ListGaussMySqlSlowLog__section44230431101549"><h4 class="sectiontitle">Function</h4><p id="ListGaussMySqlSlowLog__p1350220403353">This API is used to query database slow logs. Before using this API:</p>
|
||||
<ul id="ListGaussMySqlSlowLog__ul924420236520"><li id="ListGaussMySqlSlowLog__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="ListGaussMySqlSlowLog__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="ListGaussMySqlSlowLog__section84423324115"><h4 class="sectiontitle">URI</h4><p id="ListGaussMySqlSlowLog__p7442143211114">GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date}&node_id={node_id}</p>
|
||||
<div class="section" id="ListGaussMySqlSlowLog__section84423324115"><h4 class="sectiontitle">URI</h4><p id="ListGaussMySqlSlowLog__p7442143211114">GET /v3/{project_id}/instances/{instance_id}/slowlog</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGaussMySqlSlowLog__table16443183221113" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ListGaussMySqlSlowLog__row16442632171118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListGaussMySqlSlowLog__p9443332151115">Parameter</p>
|
||||
</th>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -6,7 +6,7 @@
|
||||
</div>
|
||||
<div class="section" id="ListProjectTags__section165568171817"><h4 class="sectiontitle">URI</h4><p id="ListProjectTags__p19559818188">GET /v3/{project_id}/tags</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListProjectTags__table125520881814" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ListProjectTags__row95548151812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListProjectTags__p155648161814">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListProjectTags__table125520881814" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="ListProjectTags__row95548151812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListProjectTags__p155648161814">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListProjectTags__p1456288181">Mandatory</p>
|
||||
</th>
|
||||
|
||||
@ -146,7 +146,7 @@
|
||||
</div>
|
||||
<div class="section" id="SetGaussMySqlProxyWeight__section33579284496"><h4 class="sectiontitle">Response Parameters</h4><p id="SetGaussMySqlProxyWeight__p3357528114920"><strong id="SetGaussMySqlProxyWeight__b435732814499">Status code: 200</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row735822815498"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="SetGaussMySqlProxyWeight__p12358112812496">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameter</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row735822815498"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="SetGaussMySqlProxyWeight__p12358112812496">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="SetGaussMySqlProxyWeight__p14358202834918">Type</p>
|
||||
</th>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -6,9 +6,9 @@
|
||||
</div>
|
||||
<div class="section" id="ShowGaussMySqlJobInfo__section1673735194018"><h4 class="sectiontitle">Constraints</h4><ul id="ShowGaussMySqlJobInfo__ul77343544018"><li id="ShowGaussMySqlJobInfo__li4741835184011">This API is used to query asynchronous tasks of the last one month in the task center.</li><li id="ShowGaussMySqlJobInfo__li18748356404">After a job is generated, it takes several seconds to query the job ID.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="ShowGaussMySqlJobInfo__section17405171911145"><h4 class="sectiontitle">URI</h4><p id="ShowGaussMySqlJobInfo__p8405141915147">GET /v3/{project_id}/jobs?id={id}</p>
|
||||
<div class="section" id="ShowGaussMySqlJobInfo__section17405171911145"><h4 class="sectiontitle">URI</h4><p id="ShowGaussMySqlJobInfo__p8405141915147">GET /v3/{project_id}/jobs</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__table13406131913142" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row34054194144"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ShowGaussMySqlJobInfo__p1340614195144">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__table13406131913142" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row34054194144"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ShowGaussMySqlJobInfo__p1340614195144">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ShowGaussMySqlJobInfo__p5406191913140">Mandatory</p>
|
||||
</th>
|
||||
@ -32,7 +32,7 @@
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__table104079198140" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row6407191931412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ShowGaussMySqlJobInfo__p14407121917143">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__table104079198140" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameter</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row6407191931412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ShowGaussMySqlJobInfo__p14407121917143">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ShowGaussMySqlJobInfo__p340714197149">Mandatory</p>
|
||||
</th>
|
||||
|
||||
@ -33,7 +33,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowInstanceMonitorExtend__p766182611466">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowInstanceMonitorExtend__p26612694613">DB instance ID.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowInstanceMonitorExtend__p26612694613">Instance ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="ShowSqlFilterControl"></a><a name="ShowSqlFilterControl"></a>
|
||||
|
||||
<h1 class="topictitle1">Querying Whether SQL Statement Concurrency Control Is Enabled</h1>
|
||||
<div id="body8662426"><div class="section" id="ShowSqlFilterControl__section188371432266"><h4 class="sectiontitle">Function</h4><p id="ShowSqlFilterControl__p0838943182616">This API is used to query whether SQL Statement Concurrency Control is enabled. Before calling this API:</p>
|
||||
<h1 class="topictitle1">Querying Whether SQL Throttling Is Enabled</h1>
|
||||
<div id="body8662426"><div class="section" id="ShowSqlFilterControl__section188371432266"><h4 class="sectiontitle">Function</h4><p id="ShowSqlFilterControl__p0838943182616">This API is used to query whether SQL Throttling is enabled. Before calling this API:</p>
|
||||
<ul id="ShowSqlFilterControl__ul924420236520"><li id="ShowSqlFilterControl__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="ShowSqlFilterControl__gaussdb_04_0001_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="ShowSqlFilterControl__section108381943192612"><h4 class="sectiontitle">URI</h4><p id="ShowSqlFilterControl__p14838154382620">GET /v3/{project_id}/instances/{instance_id}/sql-filter/switch</p>
|
||||
@ -74,7 +74,7 @@
|
||||
</div>
|
||||
<div class="section" id="ShowSqlFilterControl__section5842643122612"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowSqlFilterControl__p9842943172620"><strong id="ShowSqlFilterControl__b284213430266">Status code: 200</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowSqlFilterControl__en-us_topic_0000001374991641_response_QuerySqlFilterControlRsp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowSqlFilterControl__row28429432269"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowSqlFilterControl__p884344392610">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowSqlFilterControl__en-us_topic_0000001374991641_response_QuerySqlFilterControlRsp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="ShowSqlFilterControl__row28429432269"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowSqlFilterControl__p884344392610">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowSqlFilterControl__p584304342614">Type</p>
|
||||
</th>
|
||||
@ -86,7 +86,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowSqlFilterControl__p198431843192611">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowSqlFilterControl__p1225718553450">Whether SQL Statement Concurrency Control is enabled.</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowSqlFilterControl__p1225718553450">Whether SQL Throttling is enabled.</p>
|
||||
<p id="ShowSqlFilterControl__p132574550455">Value:</p>
|
||||
<ul id="ShowSqlFilterControl__ul72575555452"><li id="ShowSqlFilterControl__li6257115564514"><strong id="ShowSqlFilterControl__b4897165415128">ON</strong>: enabled</li><li id="ShowSqlFilterControl__li125735584510"><strong id="ShowSqlFilterControl__b1193345615124">OFF:</strong> disabled</li></ul>
|
||||
</td>
|
||||
@ -149,7 +149,7 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="ShowSqlFilterControl__section12847144314268"><h4 class="sectiontitle">Example Request</h4><p id="ShowSqlFilterControl__p1484724315265">Querying whether SQL Statement Concurrency Control is enabled</p>
|
||||
<div class="section" id="ShowSqlFilterControl__section12847144314268"><h4 class="sectiontitle">Example Request</h4><p id="ShowSqlFilterControl__p1484724315265">Querying whether SQL Throttling is enabled</p>
|
||||
<pre class="screen" id="ShowSqlFilterControl__screen1201150751">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch</pre>
|
||||
</div>
|
||||
<div class="section" id="ShowSqlFilterControl__section284714433260"><h4 class="sectiontitle">Example Response</h4><p id="ShowSqlFilterControl__p11848104322612"><strong id="ShowSqlFilterControl__b20848184312619">Status code: 200</strong></p>
|
||||
@ -165,7 +165,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000012.html">SQL Statement Concurrency Control</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000012.html">SQL Throttling</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
210
docs/taurusdb/api-ref/UpdateInstanceConfigurations.html
Normal file
210
docs/taurusdb/api-ref/UpdateInstanceConfigurations.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -109,7 +109,7 @@
|
||||
</div>
|
||||
<div class="section" id="UpdateInstanceMonitor__section12856925104612"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateInstanceMonitor__p178562025114619"><strong id="UpdateInstanceMonitor__b212527985125041">Status code: 200</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceMonitor__en-us_topic_0000001199840946_response_TaurusModifyInstanceMonitorResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="UpdateInstanceMonitor__row0857132510464"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateInstanceMonitor__p1585782524620">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceMonitor__en-us_topic_0000001199840946_response_TaurusModifyInstanceMonitorResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="UpdateInstanceMonitor__row0857132510464"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateInstanceMonitor__p1585782524620">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdateInstanceMonitor__p13857102515466">Type</p>
|
||||
</th>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="UpdateSqlFilterControl"></a><a name="UpdateSqlFilterControl"></a>
|
||||
|
||||
<h1 class="topictitle1">Enabling or Disabling SQL Statement Concurrency Control</h1>
|
||||
<div id="body8662426"><div class="section" id="UpdateSqlFilterControl__section839753652616"><h4 class="sectiontitle">Function</h4><p id="UpdateSqlFilterControl__p639853602615">This API is used to enable or disable SQL Statement Concurrency Control. Before calling this API:</p>
|
||||
<h1 class="topictitle1">Enabling or Disabling SQL Throttling</h1>
|
||||
<div id="body8662426"><div class="section" id="UpdateSqlFilterControl__section839753652616"><h4 class="sectiontitle">Function</h4><p id="UpdateSqlFilterControl__p639853602615">This API is used to enable or disable SQL Throttling. Before calling this API:</p>
|
||||
<ul id="UpdateSqlFilterControl__ul924420236520"><li id="UpdateSqlFilterControl__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="UpdateSqlFilterControl__gaussdb_04_0001_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="UpdateSqlFilterControl__section19401113611261"><h4 class="sectiontitle">URI</h4><p id="UpdateSqlFilterControl__p740215366264">POST /v3/{project_id}/instances/{instance_id}/sql-filter/switch</p>
|
||||
@ -72,7 +72,7 @@
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateSqlFilterControl__en-us_topic_0000001323431640_request_OperateSqlFilterControlReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="UpdateSqlFilterControl__row1243093672611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateSqlFilterControl__p114311836132618">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateSqlFilterControl__en-us_topic_0000001323431640_request_OperateSqlFilterControlReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="UpdateSqlFilterControl__row1243093672611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateSqlFilterControl__p114311836132618">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateSqlFilterControl__p8432163632618">Mandatory</p>
|
||||
</th>
|
||||
@ -88,7 +88,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateSqlFilterControl__p19437163642618">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateSqlFilterControl__p1419965618458">Whether SQL Statement Concurrency Control is enabled. Value:</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateSqlFilterControl__p1419965618458">Whether SQL Throttling is enabled. Value:</p>
|
||||
<ul id="UpdateSqlFilterControl__ul719914565451"><li id="UpdateSqlFilterControl__li51991256114512"><strong id="UpdateSqlFilterControl__b4216133418123">ON</strong>: enabled</li><li id="UpdateSqlFilterControl__li111991256164517"><strong id="UpdateSqlFilterControl__b6297194015126">OFF</strong>: disabled</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
@ -98,7 +98,7 @@
|
||||
</div>
|
||||
<div class="section" id="UpdateSqlFilterControl__section16439836162610"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateSqlFilterControl__p244015362261"><strong id="UpdateSqlFilterControl__b1444119369261">Status code: 200</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateSqlFilterControl__en-us_topic_0000001323431640_response_OperateSqlFilterControlRsp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="UpdateSqlFilterControl__row15441153614264"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateSqlFilterControl__p124431536132616">Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateSqlFilterControl__en-us_topic_0000001323431640_response_OperateSqlFilterControlRsp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="UpdateSqlFilterControl__row15441153614264"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateSqlFilterControl__p124431536132616">Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdateSqlFilterControl__p6443236202619">Type</p>
|
||||
</th>
|
||||
@ -110,7 +110,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateSqlFilterControl__p11446836102617">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateSqlFilterControl__p184473365260">ID of the task for enabling or disabling SQL Statement Concurrency Control.</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateSqlFilterControl__p184473365260">ID of the task for enabling or disabling SQL Throttling.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -171,11 +171,11 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="UpdateSqlFilterControl__section13469173692616"><h4 class="sectiontitle">Example Request</h4><ul id="UpdateSqlFilterControl__ul1447113619264"><li id="UpdateSqlFilterControl__li15471133632613">Enabling SQL Statement Concurrency Control<pre class="screen" id="UpdateSqlFilterControl__screen047316365267">POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
|
||||
<div class="section" id="UpdateSqlFilterControl__section13469173692616"><h4 class="sectiontitle">Example Request</h4><ul id="UpdateSqlFilterControl__ul1447113619264"><li id="UpdateSqlFilterControl__li15471133632613">Enabling SQL Throttling<pre class="screen" id="UpdateSqlFilterControl__screen047316365267">POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
|
||||
{
|
||||
"switch_status" : "ON"
|
||||
}</pre>
|
||||
</li><li id="UpdateSqlFilterControl__li747763632617">Disabling SQL Statement Concurrency Control<pre class="screen" id="UpdateSqlFilterControl__screen15478936142616">POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
|
||||
</li><li id="UpdateSqlFilterControl__li747763632617">Disabling SQL Throttling<pre class="screen" id="UpdateSqlFilterControl__screen15478936142616">POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
|
||||
{
|
||||
"switch_status" : "OFF"
|
||||
}</pre>
|
||||
@ -194,7 +194,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000012.html">SQL Statement Concurrency Control</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000012.html">SQL Throttling</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -8,7 +8,13 @@
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="changeHistory__row1720516010395"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p17841659123514">2025-03-27</p>
|
||||
<tbody><tr id="changeHistory__row1958020550107"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p19154151161119">2025-07-16</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p1515414113117">Modified the following content:</p>
|
||||
<p id="changeHistory__p7590201211119">Added <a href="UpdateInstanceConfigurations.html">Modifying Parameters of a Specified Instance</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="changeHistory__row1720516010395"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p17841659123514">2025-03-27</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p1771021210364">Modified the following content:</p>
|
||||
<ul id="changeHistory__ul794611954715"><li id="changeHistory__li594618914717">Renamed GaussDB(for MySQL) to TaurusDB.</li><li id="changeHistory__li1552751314713">Added <a href="ListInstanceConfigurations.html">Obtaining Parameter Information of a Specified DB Instance</a>.</li></ul>
|
||||
@ -23,7 +29,7 @@
|
||||
<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 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 Throttling</a></li><li id="changeHistory__li449820992413"><a href="ShowSqlFilterControl.html">Querying Whether SQL Throttling Is Enabled</a></li><li id="changeHistory__li7770191992414"><a href="SetSqlFilterRule.html">Configuring SQL Throttling Rules</a></li><li id="changeHistory__li673152872415"><a href="ShowSqlFilterRule.html">Querying SQL Throttling Rules</a></li><li id="changeHistory__li449874013247"><a href="DeleteSqlFilterRule.html">Deleting SQL Throttling Rules</a></li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="changeHistory__row339116271357"><td class="cellrowborder" valign="top" width="36.4%" headers="mcps1.3.1.1.3.1.1 "><p id="changeHistory__p1539113271854">2024-02-28</p>
|
||||
@ -49,7 +55,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="63.6%" headers="mcps1.3.1.1.3.1.2 "><p id="changeHistory__p43511748112511">Modified the following content:</p>
|
||||
<p id="changeHistory__p220014114380">Delete the following APIs:</p>
|
||||
<ul id="changeHistory__ul1851784753914"><li id="changeHistory__li1517747163917">Configuring Concurrency Control Rules of SQL Statements</li><li id="changeHistory__li17517114753916">Querying Concurrency Control Rules of SQL Statements</li><li id="changeHistory__li75171047173914">Deleting Concurrency Control Rules of SQL Statements</li></ul>
|
||||
<ul id="changeHistory__ul1851784753914"><li id="changeHistory__li1517747163917">Configuring SQL Throttling Rules</li><li id="changeHistory__li17517114753916">Querying SQL Throttling Rules</li><li id="changeHistory__li75171047173914">Deleting SQL Throttling Rules</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
@ -62,7 +68,7 @@
|
||||
</td>
|
||||
<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>
|
||||
<p id="changeHistory__p466115132518">Added the following APIs:</p>
|
||||
<ul id="changeHistory__ul2071551398"><li id="changeHistory__li1630219195262"><a href="gaussdb_04_0001.html">Querying Version Information About a DB Engine</a></li><li id="changeHistory__li1926563910267"><a href="gaussdb_04_0002.html">Querying Database Specifications</a></li><li id="changeHistory__li663816171349"><a href="gaussdb_04_0007.html">Deleting a DB Instance</a></li><li id="changeHistory__li21511220143413"><a href="gaussdb_04_0006.html">Querying Details of a DB Instance</a></li><li id="changeHistory__li7798020173410"><a href="gaussdb_04_0015.html">Creating a Read Replica</a></li><li id="changeHistory__li10401152118347"><a href="gaussdb_04_0016.html">Deleting a Read Replica</a></li><li id="changeHistory__li111732263414"><a href="gaussdb_04_0018.html">Changing a DB Instance Name</a></li><li id="changeHistory__li316364913519"><a href="gaussdb_04_0019.html">Resetting a Database Password</a></li><li id="changeHistory__li16745155014351"><a href="gaussdb_04_0020.html">Changing DB Instance Specifications</a></li><li id="changeHistory__li712154719367"><a href="gaussdb_06_0003.html">Creating a Manual Backup</a></li><li id="changeHistory__li131212476362"><a href="gaussdb_06_0004.html">Querying Backups</a></li><li id="changeHistory__li01214478368"><a href="gaussdb_06_0005.html">Querying an Automated Backup Policy</a></li><li id="changeHistory__li812144711369"><a href="gaussdb_06_0006.html">Modifying an Automated Backup Policy</a></li><li id="changeHistory__li168041444380"><a href="gaussdb_04_0009.html">Querying Parameter Templates</a></li><li id="changeHistory__li584017571394"><a href="gaussdb_04_0011.html">Querying Resource Quotas</a></li><li id="changeHistory__li1699193210402"><a href="gaussdb_04_0012.html">Configuring Resource Quotas</a></li><li id="changeHistory__li884945684015"><a href="gaussdb_04_0013.html">Modifying Resource Quotas</a></li><li id="changeHistory__li12921612184110"><a href="ShowGaussMySqlProjectQuotas.html">Querying the DB Instance Quotas of a Tenant</a></li><li id="changeHistory__li13710516917"><a href="ShowGaussMySqlProxyFlavors.html">Querying Database Proxy Specifications</a></li><li id="changeHistory__li207145111920"><a href="CreateGaussMySqlProxy.html">Enabling Database Proxy</a></li><li id="changeHistory__li1717516913"><a href="DeleteGaussMySqlProxy.html">Disabling Database Proxy</a></li><li id="changeHistory__li8814511092"><a href="ExpandGaussMySqlProxy.html">Adding Database Proxy Nodes</a></li><li id="changeHistory__li6815511192"><a href="ShowGaussMySqlProxyList.html">Querying Database Proxy Instances</a></li><li id="changeHistory__li681951693"><a href="ChangeGaussMySqlProxySpecification.html">Changing Specifications of a Database Proxy Instance</a></li><li id="changeHistory__li685511698"><a href="SetGaussMySqlProxyWeight.html">Assigning Read Weights</a></li><li id="changeHistory__li125506136429"><a href="ListGaussMySqlErrorLog.html">Querying Database Error Logs</a></li><li id="changeHistory__li1561425017421"><a href="ListGaussMySqlSlowLog.html">Querying Database Slow Logs</a></li><li id="changeHistory__li1463872215437"><a href="ListInstanceTags.html">Querying Resource Tags</a></li><li id="changeHistory__li13369710204411"><a href="ListProjectTags.html">Querying Project Tags</a></li><li id="changeHistory__li78761425194418"><a href="BatchTagAction.html">Adding or Deleting Tags in Batches</a></li><li id="changeHistory__li1922141811469"><a href="ShowGaussMySqlJobInfo.html">Obtaining Information About a Task with a Specified ID</a></li><li id="changeHistory__li8491139124419">Configuring Concurrency Control Rules of SQL Statements</li><li id="changeHistory__li159111500457">Querying Concurrency Control Rules of SQL Statements</li><li id="changeHistory__li415275174612">Deleting Concurrency Control Rules of SQL Statements</li></ul>
|
||||
<ul id="changeHistory__ul2071551398"><li id="changeHistory__li1630219195262"><a href="gaussdb_04_0001.html">Querying Version Information About a DB Engine</a></li><li id="changeHistory__li1926563910267"><a href="gaussdb_04_0002.html">Querying Database Specifications</a></li><li id="changeHistory__li663816171349"><a href="gaussdb_04_0007.html">Deleting a DB Instance</a></li><li id="changeHistory__li21511220143413"><a href="gaussdb_04_0006.html">Querying Details of a DB Instance</a></li><li id="changeHistory__li7798020173410"><a href="gaussdb_04_0015.html">Creating a Read Replica</a></li><li id="changeHistory__li10401152118347"><a href="gaussdb_04_0016.html">Deleting a Read Replica</a></li><li id="changeHistory__li111732263414"><a href="gaussdb_04_0018.html">Changing a DB Instance Name</a></li><li id="changeHistory__li316364913519"><a href="gaussdb_04_0019.html">Resetting a Database Password</a></li><li id="changeHistory__li16745155014351"><a href="gaussdb_04_0020.html">Changing DB Instance Specifications</a></li><li id="changeHistory__li712154719367"><a href="gaussdb_06_0003.html">Creating a Manual Backup</a></li><li id="changeHistory__li131212476362"><a href="gaussdb_06_0004.html">Querying Backups</a></li><li id="changeHistory__li01214478368"><a href="gaussdb_06_0005.html">Querying an Automated Backup Policy</a></li><li id="changeHistory__li812144711369"><a href="gaussdb_06_0006.html">Modifying an Automated Backup Policy</a></li><li id="changeHistory__li168041444380"><a href="gaussdb_04_0009.html">Querying Parameter Templates</a></li><li id="changeHistory__li584017571394"><a href="gaussdb_04_0011.html">Querying Resource Quotas</a></li><li id="changeHistory__li1699193210402"><a href="gaussdb_04_0012.html">Configuring Resource Quotas</a></li><li id="changeHistory__li884945684015"><a href="gaussdb_04_0013.html">Modifying Resource Quotas</a></li><li id="changeHistory__li12921612184110"><a href="ShowGaussMySqlProjectQuotas.html">Querying the DB Instance Quotas of a Tenant</a></li><li id="changeHistory__li13710516917"><a href="ShowGaussMySqlProxyFlavors.html">Querying Database Proxy Specifications</a></li><li id="changeHistory__li207145111920"><a href="CreateGaussMySqlProxy.html">Enabling Database Proxy</a></li><li id="changeHistory__li1717516913"><a href="DeleteGaussMySqlProxy.html">Disabling Database Proxy</a></li><li id="changeHistory__li8814511092"><a href="ExpandGaussMySqlProxy.html">Adding Database Proxy Nodes</a></li><li id="changeHistory__li6815511192"><a href="ShowGaussMySqlProxyList.html">Querying Database Proxy Instances</a></li><li id="changeHistory__li681951693"><a href="ChangeGaussMySqlProxySpecification.html">Changing Specifications of a Database Proxy Instance</a></li><li id="changeHistory__li685511698"><a href="SetGaussMySqlProxyWeight.html">Assigning Read Weights</a></li><li id="changeHistory__li125506136429"><a href="ListGaussMySqlErrorLog.html">Querying Database Error Logs</a></li><li id="changeHistory__li1561425017421"><a href="ListGaussMySqlSlowLog.html">Querying Database Slow Logs</a></li><li id="changeHistory__li1463872215437"><a href="ListInstanceTags.html">Querying Resource Tags</a></li><li id="changeHistory__li13369710204411"><a href="ListProjectTags.html">Querying Project Tags</a></li><li id="changeHistory__li78761425194418"><a href="BatchTagAction.html">Adding or Deleting Tags in Batches</a></li><li id="changeHistory__li1922141811469"><a href="ShowGaussMySqlJobInfo.html">Obtaining Information About a Task with a Specified ID</a></li><li id="changeHistory__li8491139124419">Configuring SQL Throttling Rules</li><li id="changeHistory__li159111500457">Querying SQL Throttling Rules</li><li id="changeHistory__li415275174612">Deleting SQL Throttling Rules</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>
|
||||
|
||||
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
@ -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">TaurusDB 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 id="body1566375229410"><p id="gaussdb_00_0002__p1520294823317">TaurusDB 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>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="gaussdb_00_0003"></a><a name="gaussdb_00_0003"></a>
|
||||
|
||||
<h1 class="topictitle1">Endpoints</h1>
|
||||
<div id="body1566375229410"><p id="gaussdb_00_0003__p19425105421612">An endpoint is the <strong id="gaussdb_00_0003__b10925123104011">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="body1566375229410"><p id="gaussdb_00_0003__p19425105421612">An endpoint is the <strong id="gaussdb_00_0003__b075413917233">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
|
||||
@ -54,6 +54,11 @@
|
||||
<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 throttling</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 SQL throttling rules.</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>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<a name="gaussdb_03_0000"></a><a name="gaussdb_03_0000"></a>
|
||||
|
||||
<h1 class="topictitle1">API Usage Guidelines</h1>
|
||||
<h1 class="topictitle1">Calling APIs</h1>
|
||||
<div id="body1526376873787"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
|
||||
@ -41,7 +41,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">API Usage Guidelines</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">Calling APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<p id="gaussdb_03_0005__p3759142614815">For example, 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 method is POST. The request is as follows:</p>
|
||||
<p id="gaussdb_03_0005__p3759142614815">For example, for the URI 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 method is POST. The request is as follows:</p>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_03_0005__section479119143310"><h4 class="sectiontitle">Request Header</h4><p id="gaussdb_03_0005__p269363935616">You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, to request for the authentication information, add <span class="parmname" id="gaussdb_03_0005__en-us_topic_0170210613_en-us_topic_0170165298_parmname28091429124915"><b>Content-Type</b></span>, which specifies the request body type.</p>
|
||||
<div class="p" id="gaussdb_03_0005__p56967114331"><a href="#gaussdb_03_0005__table1986821153312">Table 3</a> lists common request header fields.
|
||||
@ -134,11 +134,11 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<p id="gaussdb_03_0005__p42118461957">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> does not require authentication. Therefore, only the <span class="parmname" id="gaussdb_03_0005__parmname2074608145"><b>Content-Type</b></span> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
|
||||
<p id="gaussdb_03_0005__p42118461957">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> does not require authentication. Therefore, only the <span class="parmname" id="gaussdb_03_0005__parmname4725721193311"><b>Content-Type</b></span> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
|
||||
</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__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 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__i939613720335"><strong id="gaussdb_03_0005__b1339653718339">username</strong></em>, <em id="gaussdb_03_0005__i03961837163313"><strong id="gaussdb_03_0005__b1139673717331">domainname</strong></em>, <strong id="gaussdb_03_0005__b2039719370333"><em id="gaussdb_03_0005__i6397183720330">********</em></strong> (login password), and <strong id="gaussdb_03_0005__b13979377331"><em id="gaussdb_03_0005__i11397137133311">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__b166594436336">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">API Usage Guidelines</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">Calling APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -3,13 +3,13 @@
|
||||
<h1 class="topictitle1">Response</h1>
|
||||
<div id="body1566198938627"><div class="section" id="gaussdb_03_0006__section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_03_0006__p4624111624411">After sending a request, you will receive a response, including the status code, response header, and response body.</p>
|
||||
<p id="gaussdb_03_0006__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="gaussdb_10_0002.html">Status Codes</a>.</p>
|
||||
<p id="gaussdb_03_0006__p2861496519">For example, if status code <strong id="gaussdb_03_0006__b43411500525">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>
|
||||
<p id="gaussdb_03_0006__p2861496519">For example, if status code <strong id="gaussdb_03_0006__b199161019103512">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="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_0000001427231638.png"></span></div>
|
||||
<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__parmname139891824123519"><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_0000001562311076.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="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 (for example, JSON or XML) as specified in the <strong id="gaussdb_03_0006__b1435273843410">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">{
|
||||
"token": {
|
||||
"expires_at": "2019-02-13T06:52:13.855000Z",
|
||||
@ -33,7 +33,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">API Usage Guidelines</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_03_0000.html">Calling APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@
|
||||
</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 class="ulchildlink"><strong><a href="topic_300000012.html">SQL Throttling</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="gaussdb_04_0014.html">Task Center</a></strong><br>
|
||||
</li>
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
<div id="body1590815684863"><div class="section" id="gaussdb_04_0002__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="gaussdb_04_0002__p52780252141331">This API is used to query the database specifications of a specified DB engine version. Before calling this API:</p>
|
||||
<ul id="gaussdb_04_0002__ul924420236520"><li id="gaussdb_04_0002__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_04_0002__gaussdb_04_0001_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_04_0002__section58691830774"><h4 class="sectiontitle">URI</h4><p id="gaussdb_04_0002__p886912301775">GET /v3/{project_id}/flavors/{database_name}?availability_zone_mode={availability_zone_mode}</p>
|
||||
<div class="section" id="gaussdb_04_0002__section58691830774"><h4 class="sectiontitle">URI</h4><p id="gaussdb_04_0002__p886912301775">GET /v3/{project_id}/flavors/{database_name}</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0002__table10870143018720" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="gaussdb_04_0002__row178701630774"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="gaussdb_04_0002__p5870183013717">Parameter</p>
|
||||
</th>
|
||||
|
||||
@ -580,7 +580,7 @@
|
||||
</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>
|
||||
<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__b1759092011">HH</strong> value must be 1 greater than the <strong id="gaussdb_04_0004__b1448174085">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__b1745788089">HH</strong> value must be 1 greater than the <strong id="gaussdb_04_0004__b433054006">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>
|
||||
</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>
|
||||
|
||||
@ -492,7 +492,7 @@
|
||||
</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>
|
||||
<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__b2012118802">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__b63060484">created</strong> field. The value is empty unless the DB instance creation is complete.</p>
|
||||
</td>
|
||||
</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>
|
||||
|
||||
@ -8,6 +8,8 @@
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="ListInstanceConfigurations.html">Obtaining Parameter Information of a Specified DB Instance</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="UpdateInstanceConfigurations.html">Modifying Parameters of a Specified Instance</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="gaussdb_06_0005__p18101650111814">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_06_0005__p1981055014183">DB instance ID, which is compliant with the UUID format.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_06_0005__p1981055014183">Instance ID, which is compliant with the UUID format.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -193,7 +193,8 @@
|
||||
"keep_days" : "7,",
|
||||
"start_time" : "19:00-20:00",
|
||||
"period" : "1,2"
|
||||
}
|
||||
|
||||
}
|
||||
}</pre>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_06_0005__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_06_0005__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
<div id="body1526376873787"><div class="section" id="gaussdb_10_0004__section236911484369"><h4 class="sectiontitle">Scenarios</h4><p id="gaussdb_10_0004__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. Two methods are available:</p>
|
||||
<ul id="gaussdb_10_0004__ul1938973714396"><li id="gaussdb_10_0004__li183897377391"><a href="#gaussdb_10_0004__section85791974381">Obtaining the Project ID by Calling an API</a></li><li id="gaussdb_10_0004__li11307945123915"><a href="#gaussdb_10_0004__section196091152113715">Obtain a Project ID from the Console</a></li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_10_0004__section85791974381"><a name="gaussdb_10_0004__section85791974381"></a><a name="section85791974381"></a><h4 class="sectiontitle">Obtaining the Project ID by Calling an API</h4><p id="gaussdb_10_0004__p857314915139">The API used to obtain a project ID is <strong id="gaussdb_10_0004__b6269145015550">GET https://{Endpoint}/v3/projects</strong>. <strong id="gaussdb_10_0004__b1754910177566">{Endpoint}</strong> is the IAM endpoint and 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>. For details about API authentication, see <a href="gaussdb_03_0001.html">Authentication</a>.</p>
|
||||
<div class="section" id="gaussdb_10_0004__section85791974381"><a name="gaussdb_10_0004__section85791974381"></a><a name="section85791974381"></a><h4 class="sectiontitle">Obtaining the Project ID by Calling an API</h4><p id="gaussdb_10_0004__p857314915139">The API used to obtain a project ID is <strong id="gaussdb_10_0004__b1126952992510">GET https://{Endpoint}/v3/projects</strong>. <strong id="gaussdb_10_0004__b32705291255">{Endpoint}</strong> is the IAM endpoint and 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>. For details about API authentication, see <a href="gaussdb_03_0001.html">Authentication</a>.</p>
|
||||
<p id="gaussdb_10_0004__p3770181514218">The following is an example response. The value of <strong id="gaussdb_10_0004__b1342435175018">id</strong> is the project ID.</p>
|
||||
<pre class="screen" id="gaussdb_10_0004__screen676419149446">{
|
||||
"projects": [
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0001__en-us_topic_0000001250985350_ul924420236520"><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0001__en-us_topic_0000001250985350_section18965813"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0001__en-us_topic_0000001250985350_ul55999443"><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li34232944">URI format<p id="gaussdb_11_0001__en-us_topic_0000001250985350_p39661040"><a name="gaussdb_11_0001__en-us_topic_0000001250985350_li34232944"></a><a name="en-us_topic_0000001250985350_li34232944"></a>GET https://{endpoint}/mysql/v3/{project_id}/datastores/{database_name}</p>
|
||||
</li><li id="gaussdb_11_0001__li8332948201111">Example<p id="gaussdb_11_0001__p166911333175216"><a name="gaussdb_11_0001__li8332948201111"></a><a name="li8332948201111"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql</p>
|
||||
</li><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li4411135064210">URI example<p id="gaussdb_11_0001__p166911333175216"><a name="gaussdb_11_0001__en-us_topic_0000001250985350_li4411135064210"></a><a name="en-us_topic_0000001250985350_li4411135064210"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql</p>
|
||||
</li><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li21405046">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0001__en-us_topic_0000001250985350_table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0001__en-us_topic_0000001250985350_row1482002"><th align="left" class="cellrowborder" valign="top" width="21.3%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p52933326"><strong id="gaussdb_11_0001__en-us_topic_0000001250985350_b46257291255">Name</strong></p>
|
||||
</th>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0002__en-us_topic_0000001267522832_en-us_topic_0000001250985350_ul924420236520"><li id="gaussdb_11_0002__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0002__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0002__en-us_topic_0000001297664645_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0002__en-us_topic_0000001297664645_ul53354139141429"><li id="gaussdb_11_0002__en-us_topic_0000001297664645_li1270098217262">URI format<p id="gaussdb_11_0002__en-us_topic_0000001297664645_p66079617141421"><a name="gaussdb_11_0002__en-us_topic_0000001297664645_li1270098217262"></a><a name="en-us_topic_0000001297664645_li1270098217262"></a>GET https://{endpoint}/mysql/v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&availability_zone_mode={availability_zone_mode}</p>
|
||||
</li><li id="gaussdb_11_0002__en-us_topic_0000001297664645_li4411135064210">Example<p id="gaussdb_11_0002__p2012712491798"><a name="gaussdb_11_0002__en-us_topic_0000001297664645_li4411135064210"></a><a name="en-us_topic_0000001297664645_li4411135064210"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql</p>
|
||||
</li><li id="gaussdb_11_0002__en-us_topic_0000001297664645_li4411135064210">URI example<p id="gaussdb_11_0002__p2012712491798"><a name="gaussdb_11_0002__en-us_topic_0000001297664645_li4411135064210"></a><a name="en-us_topic_0000001297664645_li4411135064210"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql</p>
|
||||
</li></ul>
|
||||
<ul id="gaussdb_11_0002__en-us_topic_0000001297664645_ul49831254144655"><li id="gaussdb_11_0002__en-us_topic_0000001297664645_li15430535">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0002__en-us_topic_0000001297664645_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0002__en-us_topic_0000001297664645_row60083059"><th align="left" class="cellrowborder" valign="top" width="19.28%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="gaussdb_11_0002__en-us_topic_0000001297664645_p34889605"><strong id="gaussdb_11_0002__en-us_topic_0000001297664645_b1781355075812">Name</strong></p>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0004__en-us_topic_0000001267522832_en-us_topic_0000001250985350_ul924420236520"><li id="gaussdb_11_0004__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0004__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0004__en-us_topic_0000001297545181_section38564907"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0004__en-us_topic_0000001297545181_ul13194498"><li id="gaussdb_11_0004__en-us_topic_0000001297545181_li51641620">URI format<p id="gaussdb_11_0004__en-us_topic_0000001297545181_p62121397"><a name="gaussdb_11_0004__en-us_topic_0000001297545181_li51641620"></a><a name="en-us_topic_0000001297545181_li51641620"></a>POST https://{endpoint}/mysql/v3/{project_id}/instances</p>
|
||||
</li><li id="gaussdb_11_0004__en-us_topic_0000001297545181_li4411135064210">Example<p id="gaussdb_11_0004__p678662414552"><a name="gaussdb_11_0004__en-us_topic_0000001297545181_li4411135064210"></a><a name="en-us_topic_0000001297545181_li4411135064210"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances</p>
|
||||
</li><li id="gaussdb_11_0004__en-us_topic_0000001297545181_li4411135064210">URI example<p id="gaussdb_11_0004__p678662414552"><a name="gaussdb_11_0004__en-us_topic_0000001297545181_li4411135064210"></a><a name="en-us_topic_0000001297545181_li4411135064210"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances</p>
|
||||
</li><li id="gaussdb_11_0004__en-us_topic_0000001297545181_li22221662">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0004__en-us_topic_0000001297545181_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0004__en-us_topic_0000001297545181_row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0004__en-us_topic_0000001297545181_p10809459"><strong id="gaussdb_11_0004__en-us_topic_0000001297545181_b167031065177">Name</strong></p>
|
||||
</th>
|
||||
@ -674,7 +674,7 @@
|
||||
</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>
|
||||
<p id="gaussdb_11_0004__p14663184811420">Values:</p>
|
||||
<ul id="gaussdb_11_0004__ul466474884214"><li id="gaussdb_11_0004__li06641348184212"><strong id="gaussdb_11_0004__b1939906960">month</strong>: The service is subscribed by month.</li><li id="gaussdb_11_0004__li1966419483426"><strong id="gaussdb_11_0004__b1289412">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__b250072193">month</strong>: The service is subscribed by month.</li><li id="gaussdb_11_0004__li1966419483426"><strong id="gaussdb_11_0004__b1645421929">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>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0005__en-us_topic_0000001297344601_ul924420236520"><li id="gaussdb_11_0005__en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0005__en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0005__en-us_topic_0000001297344601_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0005__en-us_topic_0000001297344601_ul19983374101549"><li id="gaussdb_11_0005__en-us_topic_0000001297344601_li45632644101549">URI format<p id="gaussdb_11_0005__en-us_topic_0000001297344601_p8040618101549"><a name="gaussdb_11_0005__en-us_topic_0000001297344601_li45632644101549"></a><a name="en-us_topic_0000001297344601_li45632644101549"></a>GET https://{endpoint}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}</p>
|
||||
</li><li id="gaussdb_11_0005__en-us_topic_0000001297344601_li54691335131412">Example<p id="gaussdb_11_0005__p69316282316"><a name="gaussdb_11_0005__en-us_topic_0000001297344601_li54691335131412"></a><a name="en-us_topic_0000001297344601_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10</p>
|
||||
</li><li id="gaussdb_11_0005__en-us_topic_0000001297344601_li54691335131412">URI example<p id="gaussdb_11_0005__p69316282316"><a name="gaussdb_11_0005__en-us_topic_0000001297344601_li54691335131412"></a><a name="en-us_topic_0000001297344601_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10</p>
|
||||
</li><li id="gaussdb_11_0005__en-us_topic_0000001297344601_li47310355101549">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001297344601_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p36866898101549"><strong id="gaussdb_11_0005__en-us_topic_0000001297344601_b1296923713513">Name</strong></p>
|
||||
</th>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0006__en-us_topic_0000001297344605_ul924420236520"><li id="gaussdb_11_0006__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0006__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0006__en-us_topic_0000001297344605_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0006__en-us_topic_0000001297344605_ul19983374101549"><li id="gaussdb_11_0006__en-us_topic_0000001297344605_li45632644101549">URI format<p id="gaussdb_11_0006__en-us_topic_0000001297344605_p8040618101549"><a name="gaussdb_11_0006__en-us_topic_0000001297344605_li45632644101549"></a><a name="en-us_topic_0000001297344605_li45632644101549"></a>GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}</p>
|
||||
</li><li id="gaussdb_11_0006__en-us_topic_0000001297344605_li54691335131412">Example<p id="gaussdb_11_0006__p1439511401536"><a name="gaussdb_11_0006__en-us_topic_0000001297344605_li54691335131412"></a><a name="en-us_topic_0000001297344605_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07</p>
|
||||
</li><li id="gaussdb_11_0006__en-us_topic_0000001297344605_li54691335131412">URI example<p id="gaussdb_11_0006__p1439511401536"><a name="gaussdb_11_0006__en-us_topic_0000001297344605_li54691335131412"></a><a name="en-us_topic_0000001297344605_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07</p>
|
||||
</li><li id="gaussdb_11_0006__en-us_topic_0000001297344605_li47310355101549">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001297344605_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0006__en-us_topic_0000001297344605_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p36866898101549"><strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b471785919390">Name</strong></p>
|
||||
</th>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0007__en-us_topic_0000001297664637_ul924420236520"><li id="gaussdb_11_0007__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0007__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0007__en-us_topic_0000001297664637_section38564907"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0007__en-us_topic_0000001297664637_ul13194498"><li id="gaussdb_11_0007__en-us_topic_0000001297664637_li51641620">URI format<p id="gaussdb_11_0007__en-us_topic_0000001297664637_p819462816594"><a name="gaussdb_11_0007__en-us_topic_0000001297664637_li51641620"></a><a name="en-us_topic_0000001297664637_li51641620"></a>DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}</p>
|
||||
</li><li id="gaussdb_11_0007__en-us_topic_0000001297664637_li4411135064210">Example<p id="gaussdb_11_0007__p1136115117314"><a name="gaussdb_11_0007__en-us_topic_0000001297664637_li4411135064210"></a><a name="en-us_topic_0000001297664637_li4411135064210"></a>DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01</p>
|
||||
</li><li id="gaussdb_11_0007__en-us_topic_0000001297664637_li4411135064210">URI example<p id="gaussdb_11_0007__p1136115117314"><a name="gaussdb_11_0007__en-us_topic_0000001297664637_li4411135064210"></a><a name="en-us_topic_0000001297664637_li4411135064210"></a>DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01</p>
|
||||
</li><li id="gaussdb_11_0007__en-us_topic_0000001297664637_li22221662">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0007__en-us_topic_0000001297664637_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0007__en-us_topic_0000001297664637_row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0007__en-us_topic_0000001297664637_p10809459"><strong id="gaussdb_11_0007__en-us_topic_0000001297664637_b1145921914594">Name</strong></p>
|
||||
</th>
|
||||
@ -27,7 +27,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="gaussdb_11_0007__en-us_topic_0000001297664637_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="gaussdb_11_0007__en-us_topic_0000001297664637_p18462124174611">DB instance ID, which is compliant with the UUID format.</p>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="gaussdb_11_0007__en-us_topic_0000001297664637_p18462124174611">Instance ID, which is compliant with the UUID format.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0015__en-us_topic_0000001297545185_ul924420236520"><li id="gaussdb_11_0015__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0015__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0015__en-us_topic_0000001297545185_section38564907"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0015__en-us_topic_0000001297545185_ul13194498"><li id="gaussdb_11_0015__en-us_topic_0000001297545185_li51641620">URI format<p id="gaussdb_11_0015__en-us_topic_0000001297545185_p819462816594"><a name="gaussdb_11_0015__en-us_topic_0000001297545185_li51641620"></a><a name="en-us_topic_0000001297545185_li51641620"></a>POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/enlarge</p>
|
||||
</li><li id="gaussdb_11_0015__en-us_topic_0000001297545185_li4411135064210">Example<p id="gaussdb_11_0015__p11417181546"><a name="gaussdb_11_0015__en-us_topic_0000001297545185_li4411135064210"></a><a name="en-us_topic_0000001297545185_li4411135064210"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/enlarge</p>
|
||||
</li><li id="gaussdb_11_0015__en-us_topic_0000001297545185_li4411135064210">URI example<p id="gaussdb_11_0015__p11417181546"><a name="gaussdb_11_0015__en-us_topic_0000001297545185_li4411135064210"></a><a name="en-us_topic_0000001297545185_li4411135064210"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/enlarge</p>
|
||||
</li><li id="gaussdb_11_0015__en-us_topic_0000001297545185_li22221662">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0015__en-us_topic_0000001297545185_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0015__en-us_topic_0000001297545185_row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0015__en-us_topic_0000001297545185_p10809459"><strong id="gaussdb_11_0015__en-us_topic_0000001297545185_b1423013135011">Name</strong></p>
|
||||
</th>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0016__en-us_topic_0000001297664649_ul924420236520"><li id="gaussdb_11_0016__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0016__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0016__en-us_topic_0000001297664649_section38564907"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0016__en-us_topic_0000001297664649_ul13194498"><li id="gaussdb_11_0016__en-us_topic_0000001297664649_li51641620">URI format<p id="gaussdb_11_0016__en-us_topic_0000001297664649_p819462816594"><a name="gaussdb_11_0016__en-us_topic_0000001297664649_li51641620"></a><a name="en-us_topic_0000001297664649_li51641620"></a>DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id}</p>
|
||||
</li><li id="gaussdb_11_0016__en-us_topic_0000001297664649_li4411135064210">Example<p id="gaussdb_11_0016__p197591101041"><a name="gaussdb_11_0016__en-us_topic_0000001297664649_li4411135064210"></a><a name="en-us_topic_0000001297664649_li4411135064210"></a>DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/d11ae66fsfdsaer3w3ino9</p>
|
||||
</li><li id="gaussdb_11_0016__en-us_topic_0000001297664649_li4411135064210">URI example<p id="gaussdb_11_0016__p197591101041"><a name="gaussdb_11_0016__en-us_topic_0000001297664649_li4411135064210"></a><a name="en-us_topic_0000001297664649_li4411135064210"></a>DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/d11ae66fsfdsaer3w3ino9</p>
|
||||
</li><li id="gaussdb_11_0016__en-us_topic_0000001297664649_li22221662">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0016__en-us_topic_0000001297664649_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0016__en-us_topic_0000001297664649_row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0016__en-us_topic_0000001297664649_p10809459"><strong id="gaussdb_11_0016__en-us_topic_0000001297664649_b14734114718102">Name</strong></p>
|
||||
</th>
|
||||
@ -27,7 +27,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="gaussdb_11_0016__en-us_topic_0000001297664649_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="gaussdb_11_0016__en-us_topic_0000001297664649_p18462124174611">DB instance ID, which is compliant with the UUID format.</p>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="gaussdb_11_0016__en-us_topic_0000001297664649_p18462124174611">Instance ID, which is compliant with the UUID format.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="gaussdb_11_0016__en-us_topic_0000001297664649_row1858005911288"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="gaussdb_11_0016__en-us_topic_0000001297664649_p97461944293">node_id</p>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0018__en-us_topic_0000001250985338_ul924420236520"><li id="gaussdb_11_0018__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0018__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0018__en-us_topic_0000001250985338_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0018__en-us_topic_0000001250985338_ul19983374101549"><li id="gaussdb_11_0018__en-us_topic_0000001250985338_li45632644101549">URI format<p id="gaussdb_11_0018__en-us_topic_0000001250985338_p8040618101549"><a name="gaussdb_11_0018__en-us_topic_0000001250985338_li45632644101549"></a><a name="en-us_topic_0000001250985338_li45632644101549"></a>PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/name</p>
|
||||
</li><li id="gaussdb_11_0018__en-us_topic_0000001250985338_li54691335131412">Example<p id="gaussdb_11_0018__p135916465414"><a name="gaussdb_11_0018__en-us_topic_0000001250985338_li54691335131412"></a><a name="en-us_topic_0000001250985338_li54691335131412"></a>PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/name</p>
|
||||
</li><li id="gaussdb_11_0018__en-us_topic_0000001250985338_li54691335131412">URI example<p id="gaussdb_11_0018__p135916465414"><a name="gaussdb_11_0018__en-us_topic_0000001250985338_li54691335131412"></a><a name="en-us_topic_0000001250985338_li54691335131412"></a>PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/name</p>
|
||||
</li><li id="gaussdb_11_0018__en-us_topic_0000001250985338_li47310355101549">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0018__en-us_topic_0000001250985338_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0018__en-us_topic_0000001250985338_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0018__en-us_topic_0000001250985338_p36866898101549"><strong id="gaussdb_11_0018__en-us_topic_0000001250985338_b478518251911">Name</strong></p>
|
||||
</th>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0019__en-us_topic_0000001297545189_ul924420236520"><li id="gaussdb_11_0019__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0019__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0019__en-us_topic_0000001297545189_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0019__en-us_topic_0000001297545189_ul19983374101549"><li id="gaussdb_11_0019__en-us_topic_0000001297545189_li45632644101549">URI format<p id="gaussdb_11_0019__en-us_topic_0000001297545189_p8040618101549"><a name="gaussdb_11_0019__en-us_topic_0000001297545189_li45632644101549"></a><a name="en-us_topic_0000001297545189_li45632644101549"></a>POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/password</p>
|
||||
</li><li id="gaussdb_11_0019__en-us_topic_0000001297545189_li54691335131412">Example<p id="gaussdb_11_0019__p122361054848"><a name="gaussdb_11_0019__en-us_topic_0000001297545189_li54691335131412"></a><a name="en-us_topic_0000001297545189_li54691335131412"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/password</p>
|
||||
</li><li id="gaussdb_11_0019__en-us_topic_0000001297545189_li54691335131412">URI example<p id="gaussdb_11_0019__p122361054848"><a name="gaussdb_11_0019__en-us_topic_0000001297545189_li54691335131412"></a><a name="en-us_topic_0000001297545189_li54691335131412"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/password</p>
|
||||
</li><li id="gaussdb_11_0019__en-us_topic_0000001297545189_li47310355101549">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0019__en-us_topic_0000001297545189_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0019__en-us_topic_0000001297545189_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0019__en-us_topic_0000001297545189_p36866898101549"><strong id="gaussdb_11_0019__en-us_topic_0000001297545189_b423219151362">Name</strong></p>
|
||||
</th>
|
||||
@ -164,8 +164,9 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0019__section13990163002320"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_11_0019__p128503773615">Resetting a database password</p>
|
||||
<pre class="screen" id="gaussdb_11_0019__screen8857377367">POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password
|
||||
<div class="section" id="gaussdb_11_0019__section13990163002320"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_11_0019__p6990183012317">Resetting a database password</p>
|
||||
<pre class="screen" id="gaussdb_11_0019__screen119911330182314">
|
||||
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password
|
||||
{
|
||||
"password" : "Test_345612"
|
||||
}</pre>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0020__en-us_topic_0000001250985358_ul924420236520"><li id="gaussdb_11_0020__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0020__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0020__en-us_topic_0000001250985358_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0020__en-us_topic_0000001250985358_ul19983374101549"><li id="gaussdb_11_0020__en-us_topic_0000001250985358_li45632644101549">URI format<p id="gaussdb_11_0020__en-us_topic_0000001250985358_p8040618101549"><a name="gaussdb_11_0020__en-us_topic_0000001250985358_li45632644101549"></a><a name="en-us_topic_0000001250985358_li45632644101549"></a>POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/action</p>
|
||||
</li><li id="gaussdb_11_0020__en-us_topic_0000001250985358_li54691335131412">Example<p id="gaussdb_11_0020__p14871182018"><a name="gaussdb_11_0020__en-us_topic_0000001250985358_li54691335131412"></a><a name="en-us_topic_0000001250985358_li54691335131412"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.commysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/action</p>
|
||||
</li><li id="gaussdb_11_0020__en-us_topic_0000001250985358_li54691335131412">URI example<p id="gaussdb_11_0020__p14871182018"><a name="gaussdb_11_0020__en-us_topic_0000001250985358_li54691335131412"></a><a name="en-us_topic_0000001250985358_li54691335131412"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.commysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/action</p>
|
||||
</li><li id="gaussdb_11_0020__en-us_topic_0000001250985358_li47310355101549">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0020__en-us_topic_0000001250985358_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0020__en-us_topic_0000001250985358_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0020__en-us_topic_0000001250985358_p36866898101549"><strong id="gaussdb_11_0020__en-us_topic_0000001250985358_b99928401771">Name</strong></p>
|
||||
</th>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0022__en-us_topic_0000001250825618_ul924420236520"><li id="gaussdb_11_0022__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0022__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0022__en-us_topic_0000001250825618_section38564907"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0022__en-us_topic_0000001250825618_ul13194498"><li id="gaussdb_11_0022__en-us_topic_0000001250825618_li51641620">URI format<p id="gaussdb_11_0022__en-us_topic_0000001250825618_p819462816594"><a name="gaussdb_11_0022__en-us_topic_0000001250825618_li51641620"></a><a name="en-us_topic_0000001250825618_li51641620"></a>POST https://{endpoint}/mysql/v3/{project_id}/backups/create</p>
|
||||
</li><li id="gaussdb_11_0022__en-us_topic_0000001250825618_li4411135064210">Example<p id="gaussdb_11_0022__p1881713159208"><a name="gaussdb_11_0022__en-us_topic_0000001250825618_li4411135064210"></a><a name="en-us_topic_0000001250825618_li4411135064210"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create</p>
|
||||
</li><li id="gaussdb_11_0022__en-us_topic_0000001250825618_li4411135064210">URI example<p id="gaussdb_11_0022__p1881713159208"><a name="gaussdb_11_0022__en-us_topic_0000001250825618_li4411135064210"></a><a name="en-us_topic_0000001250825618_li4411135064210"></a>POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create</p>
|
||||
</li><li id="gaussdb_11_0022__en-us_topic_0000001250825618_li22221662">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0022__en-us_topic_0000001250825618_table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0022__en-us_topic_0000001250825618_row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0022__en-us_topic_0000001250825618_p10809459"><strong id="gaussdb_11_0022__en-us_topic_0000001250825618_b210358445364637">Name</strong></p>
|
||||
</th>
|
||||
@ -86,7 +86,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="gaussdb_11_0022__p284502212815">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="gaussdb_11_0022__p7845112252810">DB instance ID, which is compliant with the UUID format.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="gaussdb_11_0022__p7845112252810">Instance ID, which is compliant with the UUID format.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="gaussdb_11_0022__row1384417225280"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="gaussdb_11_0022__p38451722102811">name</p>
|
||||
@ -191,7 +191,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0022__p884922232812">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0022__p5849132219288">DB instance ID.</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0022__p5849132219288">Instance ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -252,8 +252,10 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0022__section98521722192812"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_11_0022__p2872133113818">Creating a Manual Backup</p>
|
||||
<pre class="screen" id="gaussdb_11_0022__screen58728319382">POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create
|
||||
<div class="section" id="gaussdb_11_0022__section98521722192812"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_11_0022__p188521622192810">Creating a Manual Backup</p>
|
||||
<pre class="screen" id="gaussdb_11_0022__screen15852922142816">
|
||||
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create
|
||||
|
||||
{
|
||||
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
|
||||
"name": "backup-1",
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0023__en-us_topic_0000001251145110_ul924420236520"><li id="gaussdb_11_0023__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0023__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0023__en-us_topic_0000001251145110_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0023__en-us_topic_0000001251145110_ul19983374101549"><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li45632644101549">URI format<p id="gaussdb_11_0023__en-us_topic_0000001251145110_p8040618101549"><a name="gaussdb_11_0023__en-us_topic_0000001251145110_li45632644101549"></a><a name="en-us_topic_0000001251145110_li45632644101549"></a>GET https://{endpoint}/mysql/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time}</p>
|
||||
</li><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li54691335131412">Example<p id="gaussdb_11_0023__p8831102411208"><a name="gaussdb_11_0023__en-us_topic_0000001251145110_li54691335131412"></a><a name="en-us_topic_0000001251145110_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800</p>
|
||||
</li><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li54691335131412">URI example<p id="gaussdb_11_0023__p8831102411208"><a name="gaussdb_11_0023__en-us_topic_0000001251145110_li54691335131412"></a><a name="en-us_topic_0000001251145110_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800</p>
|
||||
</li><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li47310355101549">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0023__en-us_topic_0000001251145110_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p36866898101549"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b32177663564738">Name</strong></p>
|
||||
</th>
|
||||
@ -226,7 +226,7 @@
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p1767022723310">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p919461732116">Backup type. Value:</p>
|
||||
<ul id="gaussdb_11_0023__ul2194161716215"><li id="gaussdb_11_0023__li3194141762118"><strong id="gaussdb_11_0023__b1672761669">auto</strong>: automated full backup</li><li id="gaussdb_11_0023__li11194151719213"><strong id="gaussdb_11_0023__b1319200784">manual</strong>: manual full backup</li></ul>
|
||||
<ul id="gaussdb_11_0023__ul2194161716215"><li id="gaussdb_11_0023__li3194141762118"><strong id="gaussdb_11_0023__b1941838993">auto</strong>: automated full backup</li><li id="gaussdb_11_0023__li11194151719213"><strong id="gaussdb_11_0023__b1029399587">manual</strong>: manual full backup</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="gaussdb_11_0023__row8667427113311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p10671162716334">size</p>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0024__en-us_topic_0000001251304370_ul924420236520"><li id="gaussdb_11_0024__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0024__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0024__en-us_topic_0000001251304370_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0024__en-us_topic_0000001251304370_ul19983374101549"><li id="gaussdb_11_0024__en-us_topic_0000001251304370_li45632644101549">URI format<p id="gaussdb_11_0024__en-us_topic_0000001251304370_p8040618101549"><a name="gaussdb_11_0024__en-us_topic_0000001251304370_li45632644101549"></a><a name="en-us_topic_0000001251304370_li45632644101549"></a>GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy</p>
|
||||
</li><li id="gaussdb_11_0024__en-us_topic_0000001251304370_li54691335131412">Example<p id="gaussdb_11_0024__p1321413419208"><a name="gaussdb_11_0024__en-us_topic_0000001251304370_li54691335131412"></a><a name="en-us_topic_0000001251304370_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy</p>
|
||||
</li><li id="gaussdb_11_0024__en-us_topic_0000001251304370_li54691335131412">URI example<p id="gaussdb_11_0024__p1321413419208"><a name="gaussdb_11_0024__en-us_topic_0000001251304370_li54691335131412"></a><a name="en-us_topic_0000001251304370_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy</p>
|
||||
</li><li id="gaussdb_11_0024__en-us_topic_0000001251304370_li47310355101549">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0024__en-us_topic_0000001251304370_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0024__en-us_topic_0000001251304370_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0024__en-us_topic_0000001251304370_p36866898101549"><strong id="gaussdb_11_0024__en-us_topic_0000001251304370_b142249647764726">Name</strong></p>
|
||||
</th>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0025__en-us_topic_0000001297344597_ul924420236520"><li id="gaussdb_11_0025__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0025__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0025__en-us_topic_0000001297344597_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0025__en-us_topic_0000001297344597_ul19983374101549"><li id="gaussdb_11_0025__en-us_topic_0000001297344597_li45632644101549">URI format<p id="gaussdb_11_0025__en-us_topic_0000001297344597_p8040618101549"><a name="gaussdb_11_0025__en-us_topic_0000001297344597_li45632644101549"></a><a name="en-us_topic_0000001297344597_li45632644101549"></a>PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy/update</p>
|
||||
</li><li id="gaussdb_11_0025__en-us_topic_0000001297344597_li54691335131412">Example<p id="gaussdb_11_0025__p1494154252018"><a name="gaussdb_11_0025__en-us_topic_0000001297344597_li54691335131412"></a><a name="en-us_topic_0000001297344597_li54691335131412"></a>PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy/update</p>
|
||||
</li><li id="gaussdb_11_0025__en-us_topic_0000001297344597_li54691335131412">URI example<p id="gaussdb_11_0025__p1494154252018"><a name="gaussdb_11_0025__en-us_topic_0000001297344597_li54691335131412"></a><a name="en-us_topic_0000001297344597_li54691335131412"></a>PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy/update</p>
|
||||
</li><li id="gaussdb_11_0025__en-us_topic_0000001297344597_li47310355101549">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0025__en-us_topic_0000001297344597_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0025__en-us_topic_0000001297344597_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0025__en-us_topic_0000001297344597_p36866898101549"><strong id="gaussdb_11_0025__en-us_topic_0000001297344597_b20503133664718">Name</strong></p>
|
||||
</th>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<ul id="gaussdb_11_0029__en-us_topic_0000001251304378_ul924420236520"><li id="gaussdb_11_0029__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0029__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="gaussdb_11_0029__en-us_topic_0000001251304378_section18965813"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0029__en-us_topic_0000001251304378_ul55999443"><li id="gaussdb_11_0029__en-us_topic_0000001251304378_li34232944">URI format<p id="gaussdb_11_0029__en-us_topic_0000001251304378_p39661040"><a name="gaussdb_11_0029__en-us_topic_0000001251304378_li34232944"></a><a name="en-us_topic_0000001251304378_li34232944"></a>GET https://{endpoint}/mysql/v3/{project_id}/quotas</p>
|
||||
</li><li id="gaussdb_11_0029__en-us_topic_0000001251304378_li4411135064210">Example<p id="gaussdb_11_0029__p10188162242117"><a name="gaussdb_11_0029__en-us_topic_0000001251304378_li4411135064210"></a><a name="en-us_topic_0000001251304378_li4411135064210"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas</p>
|
||||
</li><li id="gaussdb_11_0029__en-us_topic_0000001251304378_li4411135064210">URI example<p id="gaussdb_11_0029__p10188162242117"><a name="gaussdb_11_0029__en-us_topic_0000001251304378_li4411135064210"></a><a name="en-us_topic_0000001251304378_li4411135064210"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas</p>
|
||||
</li><li id="gaussdb_11_0029__en-us_topic_0000001251304378_li21405046">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0029__en-us_topic_0000001251304378_table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0029__en-us_topic_0000001251304378_row1482002"><th align="left" class="cellrowborder" valign="top" width="22.5%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0029__en-us_topic_0000001251304378_p52933326"><strong id="gaussdb_11_0029__en-us_topic_0000001251304378_b84235270691445">Name</strong></p>
|
||||
</th>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user