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

GeminiDB_API

Browse Source 
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:
Wang , Deng Ke
2026-03-12 09:56:41 +00:00
committed by zuul
parent 218900ecfc
commit 59805c5073
67 changed files with 5771 additions and 533 deletions
Download Patch File Download Diff File Expand all files Collapse all files

652
docs/geminidb/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

32
docs/geminidb/api-ref/BatchTagAction.html
View File

@ -3,11 +3,11 @@
<h1 class="topictitle1">Adding or Deleting Resource Tags in Batches</h1>
<div id="body14685135718507"><div class="section" id="BatchTagAction__section968665716502"><h4 class="sectiontitle">Function</h4><p id="BatchTagAction__p186871957105018">This API is used to add tags to or delete tags from a specified DB instance in batches.</p>
</div>
<div class="section" id="BatchTagAction__section11207174134816"><h4 class="sectiontitle">Constraints</h4><p id="BatchTagAction__p3567737111013">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="BatchTagAction__section11207174134816"><h4 class="sectiontitle">Constraints</h4><p id="BatchTagAction__p3567737111013">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="BatchTagAction__p1556584614314">A maximum of 20 tags can be added to an instance. The tag key must be unique.</p>
<p id="BatchTagAction__p147966511659">If the request body contains duplicated keys, an error message will be reported when the API is called.</p>
<p id="BatchTagAction__p1488415410512">If the key in the request body is the same as an existing key in a specified instance, the value of the <strong id="BatchTagAction__b96976259613">value</strong> parameter that corresponds to the existing key is overwritten.</p>
<p id="BatchTagAction__p551350134">If the tag to be deleted does not exist, the system deems the deletion operation successful by default but does not check whether the tag key and value meets character set rules.</p>
<p id="BatchTagAction__p551350134">If the tag to be deleted does not exist, the operation is considered successful by default. The character set of the tag is not verified during the deletion.</p>
</div>
<div class="section" id="BatchTagAction__section1771585714501"><h4 class="sectiontitle">URI</h4><p id="BatchTagAction__p47181357115015">POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags/action</p>
@ -44,32 +44,32 @@
</div>
</div>
<div class="section" id="BatchTagAction__section97361057125012"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchTagAction__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="BatchTagAction__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="BatchTagAction__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchTagAction__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="BatchTagAction__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="BatchTagAction__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="BatchTagAction__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="BatchTagAction__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="BatchTagAction__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="BatchTagAction__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="BatchTagAction__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="BatchTagAction__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchTagAction__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="BatchTagAction__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="BatchTagAction__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="BatchTagAction__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="BatchTagAction__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="BatchTagAction__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="BatchTagAction__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="BatchTagAction__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="BatchTagAction__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="BatchTagAction__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="BatchTagAction__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="BatchTagAction__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="BatchTagAction__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="BatchTagAction__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="BatchTagAction__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="BatchTagAction__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="BatchTagAction__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="BatchTagAction__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="BatchTagAction__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="BatchTagAction__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="BatchTagAction__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="BatchTagAction__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
@ -149,7 +149,7 @@
<div class="section" id="BatchTagAction__section1880614576507"><h4 class="sectiontitle">Response Parameters</h4><p id="BatchTagAction__p14315124451617"><strong id="BatchTagAction__b12847248144115">Status code: 200</strong></p>
<p id="BatchTagAction__p480813573506">None</p>
</div>
<div class="section" id="BatchTagAction__section6809185715017"><h4 class="sectiontitle">Example Request</h4><ul id="BatchTagAction__ul12810195775012"><li id="BatchTagAction__li117711743187">URI example<pre class="screen" id="BatchTagAction__screen8771154316815">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags/action</pre>
<div class="section" id="BatchTagAction__section6809185715017"><h4 class="sectiontitle">Example Requests</h4><ul id="BatchTagAction__ul12810195775012"><li id="BatchTagAction__li117711743187">URI example<pre class="screen" id="BatchTagAction__screen8771154316815">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags/action</pre>
</li><li id="BatchTagAction__li48171570506">Adding two tags<pre class="screen" id="BatchTagAction__screen5821457145018">{
"action" : "create",
"tags" : [ {
@ -171,7 +171,7 @@
}</pre>
</li></ul>
</div>
<div class="section" id="BatchTagAction__section98445574504"><h4 class="sectiontitle">Example Response</h4><p id="BatchTagAction__p28469572504">Status code: 200</p>
<div class="section" id="BatchTagAction__section98445574504"><h4 class="sectiontitle">Example Responses</h4><p id="BatchTagAction__p28469572504">Status code: 200</p>
<p id="BatchTagAction__p4847457175014">Success</p>
<pre class="screen" id="BatchTagAction__screen38481357145019">{ }</pre>
</div>

237
docs/geminidb/api-ref/BatchUpgradeDbVersion.html Normal file
View File

File diff suppressed because it is too large Load Diff

404
docs/geminidb/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

107
docs/geminidb/api-ref/DeleteBackup.html Normal file
View File

File diff suppressed because it is too large Load Diff

20
docs/geminidb/api-ref/ListInstanceTags.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying Tags of an Instance</h1>
<div id="body1452903875318"><div class="section" id="ListInstanceTags__section1552923815534"><h4 class="sectiontitle">Function</h4><p id="ListInstanceTags__p053133885319">This API is used to query tags of a specified instance.</p>
</div>
<div class="section" id="ListInstanceTags__section11207174134816"><h4 class="sectiontitle">Constraints</h4><p id="ListInstanceTags__p3567737111013">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="ListInstanceTags__section11207174134816"><h4 class="sectiontitle">Constraints</h4><p id="ListInstanceTags__p3567737111013">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="ListInstanceTags__p125747532014">A maximum of 20 tags can be added to a DB instance. The tag key must be unique.</p>
</div>
<div class="section" id="ListInstanceTags__section9563113855312"><h4 class="sectiontitle">URI</h4><p id="ListInstanceTags__p1256573813534">GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags</p>
@ -41,23 +41,23 @@
</div>
</div>
<div class="section" id="ListInstanceTags__section259173875317"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceTags__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="ListInstanceTags__row4593638155315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListInstanceTags__p10596153816539">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceTags__table7578162422" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ListInstanceTags__row8247141418567"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListInstanceTags__p524791410567">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ListInstanceTags__p13598338165311">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ListInstanceTags__p924791425613">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ListInstanceTags__p059993813535">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ListInstanceTags__p9247131495619">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ListInstanceTags__p1560215381539">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ListInstanceTags__p024716149563">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceTags__row459363865311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListInstanceTags__p14604738155311">X-Auth-Token</p>
<tbody><tr id="ListInstanceTags__row724920143568"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListInstanceTags__p524901417564">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListInstanceTags__p160583817535">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListInstanceTags__p724961405617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListInstanceTags__p1360714385533">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListInstanceTags__p10249131475614">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListInstanceTags__p4609838145319">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListInstanceTags__p124911148560">User token</p>
</td>
</tr>
</tbody>
@ -66,7 +66,7 @@
</div>
<div class="section" id="ListInstanceTags__section126105382536"><h4 class="sectiontitle">Response Parameters</h4><p id="ListInstanceTags__p66121838125317">Status code: 200</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceTags__response_ListInstanceTagsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="ListInstanceTags__row176149386530"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ListInstanceTags__p5617153835310">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceTags__response_ListInstanceTagsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ListInstanceTags__row176149386530"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ListInstanceTags__p5617153835310">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="ListInstanceTags__p17618133895314">Type</p>
</th>

32
docs/geminidb/api-ref/ListInstancesByResourceTags.html
View File

@ -3,12 +3,12 @@
<h1 class="topictitle1">Querying an Instance by Tag</h1>
<div id="body2097311694613"><div class="section" id="ListInstancesByResourceTags__section1797311664619"><h4 class="sectiontitle">Function</h4><p id="ListInstancesByResourceTags__p10973166124614">This API is used to query a specified instance by tag.</p>
</div>
<div class="section" id="ListInstancesByResourceTags__section11207174134816"><h4 class="sectiontitle">Constraints</h4><p id="ListInstancesByResourceTags__p3567737111013">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="ListInstancesByResourceTags__section11207174134816"><h4 class="sectiontitle">Constraints</h4><p id="ListInstancesByResourceTags__p3567737111013">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="ListInstancesByResourceTags__p125747532014">A maximum of 20 tags can be added to a DB instance. The tag key must be unique.</p>
</div>
<div class="section" id="ListInstancesByResourceTags__section1397918644618"><h4 class="sectiontitle">URI</h4><p id="ListInstancesByResourceTags__p59791869462">POST https://{Endpoint}/v3/{project_id}/instances/resource-instances/action</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesByResourceTags__table49810654616" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="ListInstancesByResourceTags__row99807615467"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ListInstancesByResourceTags__p1981136134617">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesByResourceTags__table49810654616" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ListInstancesByResourceTags__row99807615467"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ListInstancesByResourceTags__p1981136134617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ListInstancesByResourceTags__p129812624615">Mandatory</p>
</th>
@ -32,32 +32,32 @@
</div>
</div>
<div class="section" id="ListInstancesByResourceTags__section109869664619"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesByResourceTags__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="ListInstancesByResourceTags__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListInstancesByResourceTags__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesByResourceTags__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ListInstancesByResourceTags__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListInstancesByResourceTags__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ListInstancesByResourceTags__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ListInstancesByResourceTags__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ListInstancesByResourceTags__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ListInstancesByResourceTags__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ListInstancesByResourceTags__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ListInstancesByResourceTags__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesByResourceTags__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListInstancesByResourceTags__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="ListInstancesByResourceTags__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListInstancesByResourceTags__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListInstancesByResourceTags__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListInstancesByResourceTags__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListInstancesByResourceTags__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListInstancesByResourceTags__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListInstancesByResourceTags__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="ListInstancesByResourceTags__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListInstancesByResourceTags__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="ListInstancesByResourceTags__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="ListInstancesByResourceTags__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListInstancesByResourceTags__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="ListInstancesByResourceTags__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListInstancesByResourceTags__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListInstancesByResourceTags__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListInstancesByResourceTags__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListInstancesByResourceTags__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListInstancesByResourceTags__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListInstancesByResourceTags__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListInstancesByResourceTags__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
@ -283,7 +283,7 @@
</table>
</div>
</div>
<div class="section" id="ListInstancesByResourceTags__section74412764611"><h4 class="sectiontitle">Example Request</h4><ul id="ListInstancesByResourceTags__ul11441679466"><li id="ListInstancesByResourceTags__li144613715810">URI example<pre class="screen" id="ListInstancesByResourceTags__screen14653712582">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/resource-instances/action</pre>
<div class="section" id="ListInstancesByResourceTags__section74412764611"><h4 class="sectiontitle">Example Requests</h4><ul id="ListInstancesByResourceTags__ul11441679466"><li id="ListInstancesByResourceTags__li144613715810">URI example<pre class="screen" id="ListInstancesByResourceTags__screen14653712582">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/resource-instances/action</pre>
</li><li id="ListInstancesByResourceTags__li44677204620">Example request body<p id="ListInstancesByResourceTags__p34615784615"><a name="ListInstancesByResourceTags__li44677204620"></a><a name="li44677204620"></a>Querying an instance by name (Set <strong id="ListInstancesByResourceTags__b282883592417">offset </strong>to <strong id="ListInstancesByResourceTags__b99218171211">100 </strong>and <strong id="ListInstancesByResourceTags__b1816615547249">limit</strong> to <strong id="ListInstancesByResourceTags__b1167125692418">100</strong>.)</p>
<pre class="screen" id="ListInstancesByResourceTags__screen13470719461">{
"offset" : 100,
@ -318,7 +318,7 @@
}</pre>
</li></ul>
</div>
<div class="section" id="ListInstancesByResourceTags__section855127144618"><h4 class="sectiontitle">Example Response</h4><p id="ListInstancesByResourceTags__p185517154618">Status code: 200</p>
<div class="section" id="ListInstancesByResourceTags__section855127144618"><h4 class="sectiontitle">Example Responses</h4><p id="ListInstancesByResourceTags__p185517154618">Status code: 200</p>
<p id="ListInstancesByResourceTags__p25537184614">Success</p>
<pre class="screen" id="ListInstancesByResourceTags__screen75677124618">{
"total_count": 1,

8
docs/geminidb/api-ref/ListRestoreTime.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying the Time Window When a Backup Can Be Restored</h1>
<div id="body18478143116441"><div class="section" id="ListRestoreTime__section3478173116445"><h4 class="sectiontitle">Function</h4><p id="ListRestoreTime__p12479183114449">This API is used to query the time window when a backup can be restored.</p>
</div>
<div class="section" id="ListRestoreTime__section1148013134418"><h4 class="sectiontitle">Constraints</h4><p id="ListRestoreTime__p1648073154416">This API supports the following types of instances:</p>
<div class="section" id="ListRestoreTime__section1148013134418"><h4 class="sectiontitle">Constraints</h4><p id="ListRestoreTime__p1648073154416">This API supports the following instances:</p>
<ul id="ListRestoreTime__ul6481123154415"><li id="ListRestoreTime__li2662142313617"><span id="ListRestoreTime__text1695791011492">GeminiDB Cassandra</span></li></ul>
<p id="ListRestoreTime__p19482133144413">Make sure that full backup, incremental backup, and automated backup have been enabled. To enable incremental backup, contact customer service. This function can be used only when the next automated backup is performed.</p>
<p id="ListRestoreTime__p12482203115448">This API can be used to query the time point that a backup can be restored to, so values of <strong id="ListRestoreTime__b525884416479">start_time</strong> and <strong id="ListRestoreTime__b15117184924716">end_time</strong> are the same.</p>
@ -94,7 +94,7 @@
</div>
</div>
<div class="section" id="ListRestoreTime__section15513531204411"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListRestoreTime__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameter</caption><thead align="left"><tr id="ListRestoreTime__row18514131114418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListRestoreTime__p1516193119448">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListRestoreTime__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListRestoreTime__row18514131114418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListRestoreTime__p1516193119448">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ListRestoreTime__p15516931104418">Mandatory</p>
</th>
@ -171,10 +171,10 @@
</table>
</div>
</div>
<div class="section" id="ListRestoreTime__section1753753174415"><h4 class="sectiontitle">Example Request</h4><ul id="ListRestoreTime__ul15537031104410"><li id="ListRestoreTime__li9289101216433">URI example<pre class="screen" id="ListRestoreTime__screen628911254311">GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&amp;end_time=2022-06-01T19:50:20+0800&amp;offset=0&amp;limit=1000</pre>
<div class="section" id="ListRestoreTime__section1753753174415"><h4 class="sectiontitle">Example Requests</h4><ul id="ListRestoreTime__ul15537031104410"><li id="ListRestoreTime__li9289101216433">URI example<pre class="screen" id="ListRestoreTime__screen628911254311">GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&amp;end_time=2022-06-01T19:50:20+0800&amp;offset=0&amp;limit=1000</pre>
</li></ul>
</div>
<div class="section" id="ListRestoreTime__section2054093104410"><h4 class="sectiontitle">Example Response</h4><p id="ListRestoreTime__p254112317442"><strong id="ListRestoreTime__b76354211119">Status code: 200</strong></p>
<div class="section" id="ListRestoreTime__section2054093104410"><h4 class="sectiontitle">Example Responses</h4><p id="ListRestoreTime__p254112317442"><strong id="ListRestoreTime__b76354211119">Status code: 200</strong></p>
<p id="ListRestoreTime__p75411731204416">Success</p>
<pre class="screen" id="ListRestoreTime__screen254212315447">{
"total_count" : 1,

6
docs/geminidb/api-ref/ListSlowLogs.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying Database Slow Logs</h1>
<div id="body939919141847"><div class="section" id="ListSlowLogs__section540014141047"><h4 class="sectiontitle">Function</h4><p id="ListSlowLogs__p8402414646">This API is used to query the latest 2,000 slow query logs of an instance. Searching by keyword is not supported.</p>
</div>
<div class="section" id="ListSlowLogs__section2563029124413"><h4 class="sectiontitle">Constraints</h4><ul id="ListSlowLogs__ul1212104116497"><li id="ListSlowLogs__li1012174174916">This API supports <span id="ListSlowLogs__text157761531103515">GeminiDB Cassandra</span> instances.</li><li id="ListSlowLogs__li19379646185817">This API can be used to query only the latest 2000 slow query logs in a specified time range.</li></ul>
<div class="section" id="ListSlowLogs__section2563029124413"><h4 class="sectiontitle">Constraints</h4><ul id="ListSlowLogs__ul1212104116497"><li id="ListSlowLogs__li1012174174916">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</li><li id="ListSlowLogs__li19379646185817">This API can be used to query only the latest 2000 slow query logs in a specified time range.</li></ul>
</div>
<div class="section" id="ListSlowLogs__section14167141741"><h4 class="sectiontitle">URI</h4><p id="ListSlowLogs__p941711149420">GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog</p>
@ -234,9 +234,9 @@
} ]
}</pre>
</div>
<div class="section" id="ListSlowLogs__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ListSlowLogs__en-us_topic_0000001354223196_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="ListSlowLogs__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ListSlowLogs__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="ListSlowLogs__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ListSlowLogs__en-us_topic_0000001354223196_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="ListSlowLogs__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ListSlowLogs__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

179
docs/geminidb/api-ref/QueryApplicableInstances.html Normal file
View File

File diff suppressed because it is too large Load Diff

207
docs/geminidb/api-ref/QueryApplyHistory.html Normal file
View File

File diff suppressed because it is too large Load Diff

224
docs/geminidb/api-ref/QueryModifyHistory.html Normal file
View File

File diff suppressed because it is too large Load Diff

59
docs/geminidb/api-ref/nosql_05_0014.html
View File

File diff suppressed because it is too large Load Diff

4
docs/geminidb/api-ref/nosql_05_0015.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Deleting an Instance</h1>
<div id="body1088017855115"><div class="section" id="nosql_05_0015__section1880178105110"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0015__p1888119815112">This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.</p>
</div>
<div class="section" id="nosql_05_0015__section1732516875115"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0015__p153256865116">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0015__section1732516875115"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0015__p153256865116">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
</div>
<div class="section" id="nosql_05_0015__section189003825117"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0015__p17901158165113">DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}</p>
@ -40,7 +40,7 @@
</div>
</div>
<div class="section" id="nosql_05_0015__section11915158185113"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0015__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0015__row691616875119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0015__p99181184519">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0015__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0015__row691616875119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0015__p99181184519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0015__p19919884511">Mandatory</p>
</th>

16
docs/geminidb/api-ref/nosql_05_0016.html
View File

@ -3,11 +3,11 @@
<h1 class="topictitle1">Querying Instances and Details</h1>
<div id="body42460955120"><div class="section" id="nosql_05_0016__section16247169175111"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0016__p19247495514">This API is used to query instances and details based on specified conditions.</p>
</div>
<div class="section" id="nosql_05_0016__section10248119105117"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0016__en-us_topic_0000001346779660_p153256865116">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0016__section10248119105117"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0016__en-us_topic_0000001346779660_p153256865116">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
</div>
<div class="section" id="nosql_05_0016__section72693985115"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0016__p122707955119">GET https://{Endpoint}/v3/{project_id}/instances</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__table1027417912511" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="nosql_05_0016__row132721891518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0016__p1274094516">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__table1027417912511" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0016__row132721891518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0016__p1274094516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_05_0016__p182751915517">Mandatory</p>
</th>
@ -68,6 +68,7 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p23084914519">Database type. The value can be:</p>
<p id="nosql_05_0016__p712310465405"><strong id="nosql_05_0016__b185361809910">cassandra</strong>, indicating that <span id="nosql_05_0016__text5790123765117">GeminiDB Cassandra</span> instances are queried.</p>
<p id="nosql_05_0016__p2509154122417">If you set this parameter to <strong id="nosql_05_0016__b1472971852110">influxdb</strong>,GeminiDB Influx instances are queried.</p>
<p id="nosql_05_0016__p1912394610403">If this parameter is not transferred, all database instances are queried.</p>
</td>
</tr>
@ -78,7 +79,8 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p931999155119">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p163201895519">Instance type. The value can be:</p>
<p id="nosql_05_0016__p16547324105017"><strong id="nosql_05_0016__b1188612371543">Cluster</strong>: GeminiDB Cassandra cluster instances</p>
<ul id="nosql_05_0016__ul695312312434"><li id="nosql_05_0016__li139531231184317"><strong id="nosql_05_0016__b924981914104">Cluster</strong>: GeminiDB Cassandra cluster instance</li><li id="nosql_05_0016__li161001912138"><p id="nosql_05_0016__p1739142181315"><a name="nosql_05_0016__li161001912138"></a><a name="li161001912138"></a><strong id="nosql_05_0016__b1375313251106">CloudNativeCluster</strong>: GeminiDB Influx cluster (performance-enhanced) instance</p>
</li></ul>
<p id="nosql_05_0016__p6197153310392">The system ignores this parameter if parameter <strong id="nosql_05_0016__b1060613510339">datastore_type</strong> is not transferred.</p>
</td>
</tr>
@ -127,7 +129,7 @@
</div>
</div>
<div class="section" id="nosql_05_0016__section1359197515"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0016__row1836011915517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0016__p93632985112">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0016__row1836011915517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0016__p93632985112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0016__p12363595519">Mandatory</p>
</th>
@ -278,7 +280,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p3435799515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p16436119165119">Subnet ID.</p>
<p id="nosql_05_0016__p643915935118">One <span id="nosql_05_0016__text78441114155410">GeminiDB Cassandra</span> instance may use multiple subnets. For the subnet ID, see <a href="#nosql_05_0016__response_ListInstancesNodeResult">Table 10</a>.</p>
<p id="nosql_05_0016__p643915935118">One instance may use multiple subnets. For the subnet ID, see <a href="#nosql_05_0016__response_ListInstancesNodeResult">Table 10</a>.</p>
</td>
</tr>
<tr id="nosql_05_0016__row33857925117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p13441169155115">security_group_id</p>
@ -548,14 +550,14 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0016__section12191010105120"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0016__ul3220171013519"><li id="nosql_05_0016__li162201410205116">URI example<p id="nosql_05_0016__p1822051019511"><a name="nosql_05_0016__li162201410205116"></a><a name="li162201410205116"></a>Querying all instances and details</p>
<div class="section" id="nosql_05_0016__section12191010105120"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0016__ul3220171013519"><li id="nosql_05_0016__li162201410205116">URI example<p id="nosql_05_0016__p1822051019511"><a name="nosql_05_0016__li162201410205116"></a><a name="li162201410205116"></a>Querying all instances and details</p>
<pre class="screen" id="nosql_05_0016__screen42212010145118">GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances</pre>
</li><li id="nosql_05_0016__li1122131035116">URI example<p id="nosql_05_0016__p82211210115113"><a name="nosql_05_0016__li1122131035116"></a><a name="li1122131035116"></a>Querying instances and details based on specified conditions</p>
<pre class="screen" id="nosql_05_0016__screen17222151075111">GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&amp;limit=10&amp;id=ed7cc6166ec24360a5ed5c5c9c2ed726in06&amp;name=hy&amp;mode={mode}&amp;datastore_type={datastore_type}&amp;vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&amp;subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0016__section32272103511"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0016__p122731085118">Status code: 200</p>
<div class="section" id="nosql_05_0016__section32272103511"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0016__p122731085118">Status code: 200</p>
<p id="nosql_05_0016__p112283100512">Success</p>
<pre class="screen" id="nosql_05_0016__screen1926451015517">{
"instances" : [ {

30
docs/geminidb/api-ref/nosql_05_0050.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Scaling Up Storage Space of an Instance</h1>
<div id="body1873329115116"><div class="section" id="nosql_05_0050__section773314917515"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0050__p187341193518">This API is used to scale up storage space of an instance.</p>
</div>
<div class="section" id="nosql_05_0050__section14736394517"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0050__en-us_topic_0000001397139461_p153256865116">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0050__section14736394517"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0050__en-us_topic_0000001397139461_p153256865116">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
</div>
<div class="section" id="nosql_05_0050__section1375209195113"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0050__p175359115110">POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/extend-volume</p>
@ -40,32 +40,32 @@
</div>
</div>
<div class="section" id="nosql_05_0050__section3768398515"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0050__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0050__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0050__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0050__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0050__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0050__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0050__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0050__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0050__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0050__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0050__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0050__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0050__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0050__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_05_0050__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0050__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0050__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0050__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0050__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0050__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0050__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_05_0050__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0050__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_05_0050__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_05_0050__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0050__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_05_0050__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0050__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0050__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0050__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0050__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0050__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0050__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0050__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
@ -118,13 +118,13 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0050__section1083115919511"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0050__ul5832109175117"><li id="nosql_05_0050__li1867764121413">URI example<pre class="screen" id="nosql_05_0050__screen4677441101412">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume</pre>
<div class="section" id="nosql_05_0050__section1083115919511"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0050__ul5832109175117"><li id="nosql_05_0050__li1867764121413">URI example<pre class="screen" id="nosql_05_0050__screen4677441101412">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume</pre>
</li><li id="nosql_05_0050__li14837129195115">Scaling up storage space of an instance to 550 GB<pre class="screen" id="nosql_05_0050__screen483849205116">{
"size" : 550
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0050__section198417917518"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0050__p28431997515"><strong id="nosql_05_0050__b1348020274218">Status code: 202</strong></p>
<div class="section" id="nosql_05_0050__section198417917518"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0050__p28431997515"><strong id="nosql_05_0050__b1348020274218">Status code: 202</strong></p>
<p id="nosql_05_0050__p1384413935120">Accepted</p>
<pre class="screen" id="nosql_05_0050__screen1184579135120">{
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"

30
docs/geminidb/api-ref/nosql_05_0051.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Adding Nodes for an Instance</h1>
<div id="body154313106514"><div class="section" id="nosql_05_0051__section15431171095117"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0051__p7432191095110">This API is used to add nodes for a specified instance.</p>
</div>
<div class="section" id="nosql_05_0051__section643301019517"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0051__p1243321045113">This API supports GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0051__section643301019517"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0051__p0433110135111">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
</div>
<div class="section" id="nosql_05_0051__section9441181035119"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0051__p0441171055112">POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-node</p>
@ -40,32 +40,32 @@
</div>
</div>
<div class="section" id="nosql_05_0051__section4449171015512"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0051__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0051__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0051__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0051__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0051__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0051__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0051__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0051__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0051__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0051__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0051__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0051__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0051__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0051__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_05_0051__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0051__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0051__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0051__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0051__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0051__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0051__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_05_0051__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0051__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_05_0051__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_05_0051__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0051__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_05_0051__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0051__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0051__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0051__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0051__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0051__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0051__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0051__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
@ -126,13 +126,13 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0051__section748216106513"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0051__ul148314108517"><li id="nosql_05_0051__li1735645731913">URI example<pre class="screen" id="nosql_05_0051__screen43561157181914">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node</pre>
<div class="section" id="nosql_05_0051__section748216106513"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0051__ul148314108517"><li id="nosql_05_0051__li1735645731913">URI example<pre class="screen" id="nosql_05_0051__screen43561157181914">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node</pre>
</li><li id="nosql_05_0051__li174858108514">Adding a node<pre class="screen" id="nosql_05_0051__screen1748641045115">{
"num" : 1
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0051__section164875101514"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0051__p94876100511"><strong id="nosql_05_0051__b329185142110">Status code: 202</strong></p>
<div class="section" id="nosql_05_0051__section164875101514"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0051__p94876100511"><strong id="nosql_05_0051__b329185142110">Status code: 202</strong></p>
<p id="nosql_05_0051__p64881210175115">Accepted</p>
<pre class="screen" id="nosql_05_0051__screen6488171017518">{
"job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"

28
docs/geminidb/api-ref/nosql_05_0052.html
View File

@ -40,32 +40,32 @@
</div>
</div>
<div class="section" id="nosql_05_0052__section52714137347"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0052__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0052__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0052__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0052__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0052__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0052__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0052__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0052__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0052__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0052__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0052__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0052__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0052__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0052__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_05_0052__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0052__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0052__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0052__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0052__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0052__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0052__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_05_0052__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0052__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_05_0052__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_05_0052__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0052__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_05_0052__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0052__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0052__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0052__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0052__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0052__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0052__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0052__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
@ -131,14 +131,14 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0052__section19180113123415"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0052__ul1618401316346"><li id="nosql_05_0052__li323702618269">URI example<pre class="screen" id="nosql_05_0052__screen3237626102617">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node</pre>
<div class="section" id="nosql_05_0052__section19180113123415"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0052__ul1618401316346"><li id="nosql_05_0052__li323702618269">URI example<pre class="screen" id="nosql_05_0052__screen3237626102617">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node</pre>
</li><li id="nosql_05_0052__li519816136341">Deleting a node<pre class="screen" id="nosql_05_0052__screen1620514132347">{
"num" : 1,
"node_list" : [ "116ba14da34a42d28ecd83a38c218907no12" ]
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0052__section13221101313413"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0052__p1422461313414"><strong id="nosql_05_0052__b3291632180">Status code: 202</strong></p>
<div class="section" id="nosql_05_0052__section13221101313413"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0052__p1422461313414"><strong id="nosql_05_0052__b3291632180">Status code: 202</strong></p>
<p id="nosql_05_0052__p522781393414">Accepted</p>
<pre class="screen" id="nosql_05_0052__screen9231131343412">{
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"

123
docs/geminidb/api-ref/nosql_05_0062.html Normal file
View File

File diff suppressed because it is too large Load Diff

30
docs/geminidb/api-ref/nosql_05_0100.html
View File

@ -5,7 +5,7 @@
<div class="note" id="nosql_05_0100__note4251636141110"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nosql_05_0100__p14254153651112">Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution when performing this operation.</p>
</div></div>
</div>
<div class="section" id="nosql_05_0100__section325783601116"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0100__p1226813671119">This API supports GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0100__section325783601116"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0100__p1226813671119">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="nosql_05_0100__p10273336151112">This API can be used to scale up or down specifications of an instance.</p>
<p id="nosql_05_0100__p7275103691115">The new specifications cannot be the same as the original specifications.</p>
<p id="nosql_05_0100__p15277536101111">Specifications can be modified only when the instance status is <strong id="nosql_05_0100__b92928503498">normal</strong>.</p>
@ -46,32 +46,32 @@
</div>
</div>
<div class="section" id="nosql_05_0100__section7321153631116"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0100__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0100__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0100__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0100__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0100__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0100__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0100__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0100__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0100__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0100__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0100__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0100__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0100__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0100__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_05_0100__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0100__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0100__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0100__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0100__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0100__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0100__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_05_0100__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0100__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_05_0100__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_05_0100__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0100__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_05_0100__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0100__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0100__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0100__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0100__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0100__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0100__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0100__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
@ -146,7 +146,7 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0100__section644416365115"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0100__ul134475367114"><li id="nosql_05_0100__li1099262253219">URI example<pre class="screen" id="nosql_05_0100__screen19922022103217">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize</pre>
<div class="section" id="nosql_05_0100__section644416365115"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0100__ul134475367114"><li id="nosql_05_0100__li1099262253219">URI example<pre class="screen" id="nosql_05_0100__screen19922022103217">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize</pre>
</li><li id="nosql_05_0100__li74581936171116">Changing instance specifications to 16 vCPUs and 64 GB<pre class="screen" id="nosql_05_0100__screen3461536141114">{
"resize" : {
"target_spec_code" : "geminidb.cassandra.4xlarge.4"
@ -154,7 +154,7 @@
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0100__section14472173641114"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0100__p11474136151119"><strong id="nosql_05_0100__b62175577411">Status code: 202</strong></p>
<div class="section" id="nosql_05_0100__section14472173641114"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0100__p11474136151119"><strong id="nosql_05_0100__b62175577411">Status code: 202</strong></p>
<p id="nosql_05_0100__p647612364111">Accepted</p>
<pre class="screen" id="nosql_05_0100__screen1047913368112">{
"job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"

32
docs/geminidb/api-ref/nosql_05_0101.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Resetting the Administrator Password of an Instance</h1>
<div id="body18871912111610"><div class="section" id="nosql_05_0101__section14883121167"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0101__p7911412131618">This API is used to reset the administrator password of an instance.</p>
</div>
<div class="section" id="nosql_05_0101__section1239972118494"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0101__p3567737111013">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0101__section1239972118494"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0101__p3567737111013">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="nosql_05_0101__p19996168945">Abnormal instances do not support this operation.</p>
<p id="nosql_05_0101__p948312111245">Only the password of user <strong id="nosql_05_0101__b8111101116117">rwuser</strong> can be reset.</p>
</div>
@ -42,39 +42,39 @@
</div>
</div>
<div class="section" id="nosql_05_0101__section81917128167"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0101__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0101__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0101__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0101__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0101__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0101__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0101__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0101__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0101__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0101__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0101__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0101__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_05_0101__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0101__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0101__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0101__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0101__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0101__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0101__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_05_0101__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0101__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_05_0101__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_05_0101__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0101__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_05_0101__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0101__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0101__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0101__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0101__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0101__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0101__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0101__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__request_ResetPasswordRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="nosql_05_0101__row1821941211162"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0101__p32240128169">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__request_ResetPasswordRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_05_0101__row1821941211162"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0101__p32240128169">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_05_0101__p82261212181613">Mandatory</p>
</th>
@ -102,13 +102,13 @@
<div class="section" id="nosql_05_0101__section1624981215168"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0101__p4253171210166">Status code: 204</p>
<p id="nosql_05_0101__p125651291588">None</p>
</div>
<div class="section" id="nosql_05_0101__section5255191221618"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0101__ul32585125163"><li id="nosql_05_0101__li15613018366">URI example<pre class="screen" id="nosql_05_0101__screen5561209366">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/password</pre>
<div class="section" id="nosql_05_0101__section5255191221618"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0101__ul32585125163"><li id="nosql_05_0101__li15613018366">URI example<pre class="screen" id="nosql_05_0101__screen5561209366">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/password</pre>
</li><li id="nosql_05_0101__li15273161217166">Resetting the administrator password of an instance to <strong id="nosql_05_0101__b190971871211">******</strong><pre class="screen" id="nosql_05_0101__screen172760126164">{
"password" : "******"
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0101__section2284161214169"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0101__p11474136151119"><strong id="nosql_05_0101__b136821620131816">Status code: 204</strong></p>
<div class="section" id="nosql_05_0101__section2284161214169"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0101__p11474136151119"><strong id="nosql_05_0101__b136821620131816">Status code: 204</strong></p>
<p id="nosql_05_0101__p647612364111">No Content</p>
</div>
<div class="section" id="nosql_05_0101__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0101__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>

32
docs/geminidb/api-ref/nosql_05_0102.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Editing the Name of an Instance</h1>
<div id="body11523216172217"><div class="section" id="nosql_05_0102__section11524616102217"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0102__p165250166226">This API is used to edit the name of an instance.</p>
</div>
<div class="section" id="nosql_05_0102__section15431919165"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0102__p3567737111013">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0102__section15431919165"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0102__p3567737111013">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="nosql_05_0102__p174928344611">The name of the instance that is being created or fails to be created cannot be edited.</p>
</div>
<div class="section" id="nosql_05_0102__section165521516192212"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0102__p155536165221">PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name</p>
@ -41,39 +41,39 @@
</div>
</div>
<div class="section" id="nosql_05_0102__section18575141613229"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0102__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0102__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0102__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0102__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0102__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0102__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0102__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0102__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0102__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0102__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0102__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0102__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_05_0102__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0102__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0102__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0102__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0102__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0102__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0102__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_05_0102__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0102__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_05_0102__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_05_0102__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0102__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_05_0102__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0102__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0102__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0102__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0102__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0102__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0102__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0102__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__request_UpdateInstanceNameRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="nosql_05_0102__row115915165223"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0102__p17593161632219">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__request_UpdateInstanceNameRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_05_0102__row115915165223"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0102__p17593161632219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_05_0102__p759581632211">Mandatory</p>
</th>
@ -101,13 +101,13 @@
<div class="section" id="nosql_05_0102__section56112166225"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0102__p1231417042713">Status code: 204</p>
<p id="nosql_05_0102__p1761341682219">None</p>
</div>
<div class="section" id="nosql_05_0102__section561491619225"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0102__ul126161416102211"><li id="nosql_05_0102__li1612212299387">URI example<pre class="screen" id="nosql_05_0102__screen61231229183815">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/name</pre>
<div class="section" id="nosql_05_0102__section561491619225"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0102__ul126161416102211"><li id="nosql_05_0102__li1612212299387">URI example<pre class="screen" id="nosql_05_0102__screen61231229183815">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/name</pre>
</li><li id="nosql_05_0102__li562391632210">Changing the instance name to <strong id="nosql_05_0102__b7597113016124">myNewName</strong><pre class="screen" id="nosql_05_0102__screen562561612219">{
"name" : "myNewName"
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0102__section5629416132219"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0102__p363014169224">None</p>
<div class="section" id="nosql_05_0102__section5629416132219"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0102__p363014169224">None</p>
</div>
<div class="section" id="nosql_05_0102__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0102__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>

34
docs/geminidb/api-ref/nosql_05_0103.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Changing the Security Group of an Instance</h1>
<div id="body111011223122810"><div class="section" id="nosql_05_0103__section14102152317280"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0103__p111031023162819">This API is used to change the security group associated with an instance.</p>
</div>
<div class="section" id="nosql_05_0103__section15431919165"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0103__p3567737111013">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0103__section15431919165"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0103__p3567737111013">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="nosql_05_0103__p7325516151015">Abnormal instances do not support this operation.</p>
<p id="nosql_05_0103__p152701189107">Please confirm the modified security group rule. This policy may affect connections to the current instance, interrupting services.</p>
</div>
@ -42,39 +42,39 @@
</div>
</div>
<div class="section" id="nosql_05_0103__section2138723122817"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0103__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0103__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0103__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0103__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0103__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0103__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0103__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0103__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0103__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0103__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0103__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0103__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_05_0103__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0103__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0103__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0103__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0103__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0103__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0103__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_05_0103__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0103__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_05_0103__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_05_0103__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0103__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_05_0103__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0103__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0103__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0103__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0103__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0103__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0103__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0103__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__request_UpdateSecurityGroupRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="nosql_05_0103__row815012312818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0103__p19151112310285">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__request_UpdateSecurityGroupRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_05_0103__row815012312818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0103__p19151112310285">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_05_0103__p5152112392810">Mandatory</p>
</th>
@ -99,7 +99,7 @@
</div>
<div class="section" id="nosql_05_0103__section715922302813"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0103__p12160323182815"><strong id="nosql_05_0103__b81553541385">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__response_UpdateSecurityGroupResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="nosql_05_0103__row1516162312819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0103__p191638237286">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__response_UpdateSecurityGroupResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_05_0103__row1516162312819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0103__p191638237286">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_05_0103__p17164152372813">Type</p>
</th>
@ -118,13 +118,13 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0103__section416912362818"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0103__ul817017237287"><li id="nosql_05_0103__li674321618428">URI example<pre class="screen" id="nosql_05_0103__screen10743816114213">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/security-group</pre>
<div class="section" id="nosql_05_0103__section416912362818"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0103__ul817017237287"><li id="nosql_05_0103__li674321618428">URI example<pre class="screen" id="nosql_05_0103__screen10743816114213">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/security-group</pre>
</li><li id="nosql_05_0103__li1917812236289">Example request body<pre class="screen" id="nosql_05_0103__screen2017916233287">{
"security_group_id" : "73bed21a-708b-4985-b697-a96d0e0d2b39"
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0103__section81821523202815"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0103__p13183122318280"><strong id="nosql_05_0103__b16884356188">Status code: 202</strong></p>
<div class="section" id="nosql_05_0103__section81821523202815"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0103__p13183122318280"><strong id="nosql_05_0103__b16884356188">Status code: 202</strong></p>
<p id="nosql_05_0103__p718315231287">No Content</p>
<pre class="screen" id="nosql_05_0103__screen1918442318280">{
"job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"

149
docs/geminidb/api-ref/nosql_05_0107.html Normal file
View File

File diff suppressed because it is too large Load Diff

117
docs/geminidb/api-ref/nosql_05_0108.html Normal file
View File

File diff suppressed because it is too large Load Diff

33
docs/geminidb/api-ref/nosql_05_0109.html
View File

@ -31,32 +31,32 @@
</div>
</div>
<div class="section" id="nosql_05_0109__section159441919151012"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0109__table199451119111018" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_05_0109__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0109__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0109__table199451119111018" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0109__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0109__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0109__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0109__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0109__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0109__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0109__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0109__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0109__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0109__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_05_0109__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0109__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0109__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0109__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0109__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0109__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0109__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_05_0109__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0109__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_05_0109__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_05_0109__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0109__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_05_0109__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0109__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0109__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0109__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0109__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0109__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0109__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0109__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
@ -124,7 +124,6 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_05_0109__p181995520587">Threshold for triggering autoscaling.</p>
<ul id="nosql_05_0109__ul104924115911"><li id="nosql_05_0109__li10492191155920">GeminiDB Cassandra instance<ul id="nosql_05_0109__ul1493163716592"><li id="nosql_05_0109__li169315374597">The value can be <strong id="nosql_05_0109__b1673205584813">80</strong>, <strong id="nosql_05_0109__b155591457174813">85</strong>, or <strong id="nosql_05_0109__b4658759114812">90</strong>.</li><li id="nosql_05_0109__li184091844145915">The default threshold is <strong id="nosql_05_0109__b151139474916">90</strong>, indicating that autoscaling is enabled when the used storage space exceeds 90% of total storage space or the available storage space is less than 10 GB.</li></ul>
</li><li id="nosql_05_0109__li426942565919">GeminiDB Redis instance<ul id="nosql_05_0109__ul52621213018"><li id="nosql_05_0109__li151231531200">The value can be <strong id="nosql_05_0109__b1461594964912">60</strong>, <strong id="nosql_05_0109__b1799119519495">65</strong>, <strong id="nosql_05_0109__b18313185412497">70</strong>, <strong id="nosql_05_0109__b0445125614498">75</strong>, <strong id="nosql_05_0109__b863710589491">80</strong>, <strong id="nosql_05_0109__b672113010509">85</strong>, and <strong id="nosql_05_0109__b675115225012">90</strong>.</li><li id="nosql_05_0109__li01231635018">The default threshold is <strong id="nosql_05_0109__b97664133506">80</strong>, indicating that autoscaling is enabled when the used storage space exceeds 80% of total storage space.</li></ul>
</li></ul>
</td>
</tr>
@ -136,10 +135,8 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_05_0109__p14279499110">Autoscaling step (s%).</p>
<ul id="nosql_05_0109__ul656217517211"><li id="nosql_05_0109__li9563452026">GeminiDB Cassandra instance<ul id="nosql_05_0109__ul35631451123"><li id="nosql_05_0109__li4563115923">The value can be <strong id="nosql_05_0109__b28841321520">10</strong>, <strong id="nosql_05_0109__b10885103213525">15</strong>, or <strong id="nosql_05_0109__b0885183219523">20</strong>, and the default value is <strong id="nosql_05_0109__b11885832185218">10</strong>.</li><li id="nosql_05_0109__li5750138174">After autoscaling is enabled, storage space will increase by s% automatically.</li></ul>
</li><li id="nosql_05_0109__li185641156212">GeminiDB Redis instance<ul id="nosql_05_0109__ul75641852219"><li id="nosql_05_0109__li6564125423">The value can be <strong id="nosql_05_0109__b25931477532">10</strong>, <strong id="nosql_05_0109__b125930735316">15</strong>, or <strong id="nosql_05_0109__b1759312715315">20</strong>, and the default value is <strong id="nosql_05_0109__b059320795310">20</strong>.</li><li id="nosql_05_0109__li7580502717">When the storage usage is greater than 98%: If the total storage is less than 600 GB, the storage usage after autoscaling (used storage space/total storage space) will be less than 85%. If the total storage is greater than or equal to 600 GB, the system automatically scales up the storage space by over 90 GB.</li></ul>
</li></ul>
<div class="note" id="nosql_05_0109__note35211329133010"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="nosql_05_0109__ul3521202919304"><li id="nosql_05_0109__li41522544415">GeminiDB Cassandra instance<ul id="nosql_05_0109__ul14152175420411"><li id="nosql_05_0109__li1735531751">If the autoscaling step is not a multiple of 10, round it up.</li><li id="nosql_05_0109__li5361731052">The value after the decimal point is rounded. The minimum step is 100 GB by default.</li></ul>
</li><li id="nosql_05_0109__li161527547417">GeminiDB Redis instance<ul id="nosql_05_0109__ul815275413419"><li id="nosql_05_0109__li20996177351">The value after the decimal point is rounded. The minimum step is 1 GB by default.</li></ul>
</li></ul>
</div></div>
</td>
@ -152,8 +149,6 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_05_0109__p57901373171">Storage limit in GB that autoscaling can increase storage space to.</p>
<ul id="nosql_05_0109__ul1412516183210"><li id="nosql_05_0109__li13858102020205">GeminiDB Cassandra instance<ul id="nosql_05_0109__ul19706195515200"><li id="nosql_05_0109__li1520222618394">Storage upper limit ≥ Current storage + 100 GB</li><li id="nosql_05_0109__li106018302394">The upper limit cannot exceed the maximum storage supported by the current specifications.</li><li id="nosql_05_0109__li75180063916">The value cannot be specified during batch autoscaling. By default, the storage is scaled up to the maximum defined by your instance specifications.</li></ul>
</li><li id="nosql_05_0109__li8832133322017">GeminiDB Redis instance<ul id="nosql_05_0109__ul932911595204"><li id="nosql_05_0109__li2053517438433">Storage upper limit ≥ Current storage + 1 GB<p id="nosql_05_0109__p584225712315"><a name="nosql_05_0109__li2053517438433"></a><a name="li2053517438433"></a>The upper limit cannot exceed the maximum storage supported by the current specifications.</p>
</li><li id="nosql_05_0109__li7147182524313">The value cannot be specified during batch autoscaling. By default, the storage is scaled up to the maximum defined by your instance specifications.</li></ul>
</li></ul>
</td>
</tr>
@ -164,7 +159,7 @@
<div class="section" id="nosql_05_0109__section1199311196100"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0109__p1027095916335"><strong id="nosql_05_0109__b44001241201210">Status code: 204</strong></p>
<p id="nosql_05_0109__p141162209102">No response parameters</p>
</div>
<div class="section" id="nosql_05_0109__section1899419190101"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0109__ul128810405126"><li id="nosql_05_0109__li8881404122">Enabling the autoscaling policy of storage space<ul id="nosql_05_0109__ul16116151161414"><li id="nosql_05_0109__li425852911417">URI example<pre class="screen" id="nosql_05_0109__screen1625811295140">POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion </pre>
<div class="section" id="nosql_05_0109__section1899419190101"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0109__ul128810405126"><li id="nosql_05_0109__li8881404122">Enabling the autoscaling policy of storage space<ul id="nosql_05_0109__ul16116151161414"><li id="nosql_05_0109__li425852911417">URI example<pre class="screen" id="nosql_05_0109__screen1625811295140">POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion </pre>
</li><li id="nosql_05_0109__li525820299144">Enabling autoscaling for storage space (Set <strong id="nosql_05_0109__b2373173912610">threshold</strong> to <strong id="nosql_05_0109__b1163416451865">90</strong>, <strong id="nosql_05_0109__b848313219710">step</strong> to <strong id="nosql_05_0109__b127281823101710">10</strong>, and <strong id="nosql_05_0109__b145971957101714">size</strong> to <strong id="nosql_05_0109__b196912595172">600</strong>.)<pre class="screen" id="nosql_05_0109__screen525842911146">{
"instance_ids" : [ "93e4b3eda14349b1b870f72829bc3b9bin06" ],
"policy" : {
@ -182,7 +177,7 @@
</li></ul>
</li></ul>
</div>
<div class="section" id="nosql_05_0109__section10492019101"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0109__p12116820191016"><strong id="nosql_05_0109__b1166612285012">Status code: 204</strong></p>
<div class="section" id="nosql_05_0109__section10492019101"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0109__p12116820191016"><strong id="nosql_05_0109__b1166612285012">Status code: 204</strong></p>
<p id="nosql_05_0109__p2011612020100">No Content</p>
<pre class="screen" id="nosql_05_0109__screen41161120111016">{ }</pre>
</div>

131
docs/geminidb/api-ref/nosql_05_0110.html Normal file
View File

File diff suppressed because it is too large Load Diff

142
docs/geminidb/api-ref/nosql_05_0113.html Normal file
View File

File diff suppressed because it is too large Load Diff

151
docs/geminidb/api-ref/nosql_05_0114.html Normal file
View File

File diff suppressed because it is too large Load Diff

143
docs/geminidb/api-ref/nosql_05_0116.html Normal file
View File

File diff suppressed because it is too large Load Diff

8
docs/geminidb/api-ref/nosql_05_0156.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying Changeable Specifications</h1>
<div id="body0000001437221857"><div class="section" id="nosql_05_0156__section1626013643116"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0156__p134711236113114">This API is used to query instance specifications that can be changed.</p>
</div>
<div class="section" id="nosql_05_0156__section8163461222"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0156__p153256865116">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_05_0156__section8163461222"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0156__p153256865116">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
</div>
<div class="section" id="nosql_05_0156__section12264636163115"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0156__p9471103620319">GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/available-flavors</p>
@ -180,6 +180,8 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0156__p14751536183113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0156__p1547583619317">Region status.</p>
<div class="note" id="nosql_05_0156__note163331352267"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="nosql_05_0156__p520235314131">This parameter has been deprecated and does not take effect. Ignore and do not use it.</p>
</div></div>
</td>
</tr>
</tbody>
@ -212,11 +214,11 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0156__section644416365115"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_05_0156__ul134475367114"><li id="nosql_05_0156__li1099262253219">URI example<pre class="screen" id="nosql_05_0156__screen19922022103217">GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/094424666ef04f79a2dfbe9f5b8b31a5in06/available-flavors</pre>
<div class="section" id="nosql_05_0156__section644416365115"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0156__ul134475367114"><li id="nosql_05_0156__li1099262253219">URI example<pre class="screen" id="nosql_05_0156__screen19922022103217">GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/094424666ef04f79a2dfbe9f5b8b31a5in06/available-flavors</pre>
</li><li id="nosql_05_0156__li74581936171116">Example request body<p id="nosql_05_0156__p195806812371"><a name="nosql_05_0156__li74581936171116"></a><a name="li74581936171116"></a>None</p>
</li></ul>
</div>
<div class="section" id="nosql_05_0156__section2318163618315"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0156__p94781836203113">Status code: 200</p>
<div class="section" id="nosql_05_0156__section2318163618315"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0156__p94781836203113">Status code: 200</p>
<div class="p" id="nosql_05_0156__p147823673117">Success<pre class="screen" id="nosql_05_0156__screen1247811361313">{
"instance_id" : "094424666ef04f79a2dfbe9f5b8b31a5in06",
"instance_name" : "geminidb_instance_noreuse_0_ZKv2FSkxgoc3F8bGzsaxNg",

25
docs/geminidb/api-ref/nosql_06_0002.html
View File

@ -3,11 +3,11 @@
<h1 class="topictitle1">Obtaining Parameter Templates</h1>
<div id="body13537176819"><div class="section" id="nosql_06_0002__section18353517281"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0002__p13354417981">This API is used to obtain parameter templates, including all of the default and custom parameter templates.</p>
</div>
<div class="section" id="nosql_06_0002__section235152119396"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0002__p1051945243413">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_06_0002__section235152119396"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0002__p1051945243413">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
</div>
<div class="section" id="nosql_06_0002__section53581517785"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0002__p0358161713815">GET https://{Endpoint}/v3.1/{project_id}/configurations</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__table33591617183" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="nosql_06_0002__row103580174817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0002__p83608178819">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__table33591617183" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_06_0002__row103580174817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0002__p83608178819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_06_0002__p7360141712813">Mandatory</p>
</th>
@ -65,7 +65,7 @@
</div>
</div>
<div class="section" id="nosql_06_0002__section73687176814"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameter</caption><thead align="left"><tr id="nosql_06_0002__row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0002__p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0002__row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0002__p936941712818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0002__p2369717883">Mandatory</p>
</th>
@ -75,16 +75,7 @@
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0002__row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0002__p047832135015">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0002__p34785216504">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0002__p082192665218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0002__en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_06_0002__b1528010571035">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_06_0002__row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0002__p1937017171284">X-Auth-Token</p>
<tbody><tr id="nosql_06_0002__row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0002__p1937017171284">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0002__p15371517489">Yes</p>
</td>
@ -196,7 +187,7 @@
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p1330318483711">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p89591358972">Instance type. The value can be:</p>
<p id="nosql_06_0002__p47561685"><strong id="nosql_06_0002__b19613182021219">Cluster</strong>, indicating that the instance is of the <span id="nosql_06_0002__text195724581167">GeminiDB Cassandra</span> cluster type.</p>
<ul id="nosql_06_0002__ul935815517116"><li id="nosql_06_0002__li193581355121115"><strong id="nosql_06_0002__b1135941936">Cluster</strong>: classic GeminiDB Cassandra or Influx cluster instance</li><li id="nosql_06_0002__li11358155161112"><strong id="nosql_06_0002__b11480205919310">CloudNativeCluster</strong>: cloud native GeminiDB Cassandra, Influx, or Redis cluster instance</li><li id="nosql_06_0002__li13358135514117"><strong id="nosql_06_0002__b153253271748">EnhancedCluster</strong>: classic GeminiDB Influx cluster (performance-enhanced) instance</li><li id="nosql_06_0002__li1358205541117"><strong id="nosql_06_0002__b177241936649">All</strong>: Parameter templates of instance with all storage types are queried.</li></ul>
</td>
</tr>
<tr id="nosql_06_0002__row1737918175816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p1938813174816">user_defined</p>
@ -211,11 +202,11 @@
</table>
</div>
</div>
<div class="section" id="nosql_06_0002__section13891717586"><h4 class="sectiontitle">Example Request</h4><div class="p" id="nosql_06_0002__p1536118118273">URI example<pre class="screen" id="nosql_06_0002__screen16871929144">GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations?offset=0&amp;limit=10 </pre>
<div class="section" id="nosql_06_0002__section13891717586"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_06_0002__p1536118118273">URI example<pre class="screen" id="nosql_06_0002__screen16871929144">GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations?offset=0&amp;limit=10 </pre>
</div>
</div>
<div class="section" id="nosql_06_0002__section163911217587"><h4 class="sectiontitle">Example Response</h4><p id="nosql_06_0002__p153919173810">Status code: 200</p>
<p id="nosql_06_0002__p163911172087">Successful request</p>
<div class="section" id="nosql_06_0002__section163911217587"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0002__p153919173810">Status code: 200</p>
<p id="nosql_06_0002__p163911172087">Success</p>
<pre class="screen" id="nosql_06_0002__screen2392171719812">{
"count" : 2,
"quota": 100,

103
docs/geminidb/api-ref/nosql_06_0003.html
View File

File diff suppressed because it is too large Load Diff

31
docs/geminidb/api-ref/nosql_06_0004.html
View File

@ -3,8 +3,7 @@
<h1 class="topictitle1">Modifying Parameters in a Parameter Template</h1>
<div id="body6782105512105"><div class="section" id="nosql_06_0004__section1078285513104"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0004__p177821355141014">This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.</p>
</div>
<div class="section" id="nosql_06_0004__section485625054612"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0004__p3761115274117">This API can be used for GeminiDB Cassandra instances.</p>
<p id="nosql_06_0004__p136561026114311">The modified parameter template name must be different from the name of any existing or default parameter template.</p>
<div class="section" id="nosql_06_0004__section485625054612"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0004__p136561026114311">The modified parameter template name must be different from the name of any existing or default parameter template.</p>
<p id="nosql_06_0004__p175371228144311">Default parameter templates cannot be modified.</p>
<p id="nosql_06_0004__p17503203044313">For configuration item <strong id="nosql_06_0004__b19621562011">values</strong>, you can enter system-defined parameters that allow for modification.</p>
</div>
@ -43,32 +42,32 @@
</div>
</div>
<div class="section" id="nosql_06_0004__section379195510106"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0004__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_06_0004__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0004__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0004__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0004__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0004__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0004__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0004__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0004__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0004__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_06_0004__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_06_0004__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0004__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0004__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_06_0004__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0004__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0004__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0004__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0004__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0004__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0004__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_06_0004__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0004__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_06_0004__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_06_0004__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0004__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_06_0004__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0004__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0004__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0004__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0004__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0004__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0004__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0004__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
@ -119,7 +118,7 @@
<div class="section" id="nosql_06_0004__section4802105541012"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0004__p1823917276130">Status code: 200</p>
<p id="nosql_06_0004__p18497183717132">None</p>
</div>
<div class="section" id="nosql_06_0004__section1080216555109"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_06_0004__ul168031755121017"><li id="nosql_06_0004__li432617343211">URI example<pre class="screen" id="nosql_06_0004__screen18326434172114">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06</pre>
<div class="section" id="nosql_06_0004__section1080216555109"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_06_0004__ul168031755121017"><li id="nosql_06_0004__li432617343211">URI example<pre class="screen" id="nosql_06_0004__screen18326434172114">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06</pre>
</li><li id="nosql_06_0004__li280485519108">Modifying Parameters in a Parameter Template<div class="note" id="nosql_06_0004__note480817557105"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nosql_06_0004__p58088556108">At least one parameter in the request body must be specified. Otherwise, the request cannot be delivered.</p>
</div></div>
<pre class="screen" id="nosql_06_0004__screen11809175516109">{
@ -131,7 +130,7 @@
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_06_0004__section158121755141019"><h4 class="sectiontitle">Example Response</h4><p id="nosql_06_0004__p198131955101018">None</p>
<div class="section" id="nosql_06_0004__section158121755141019"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0004__p198131955101018">None</p>
</div>
<div class="section" id="nosql_06_0004__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0004__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>

32
docs/geminidb/api-ref/nosql_06_0005.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Applying a Parameter Template</h1>
<div id="body48542055141011"><div class="section" id="nosql_06_0005__section885418552109"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0005__p2854155531018">This API is used to apply a parameter template to one or more instances.</p>
</div>
<div class="section" id="nosql_06_0005__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0005__p12792357124410">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_06_0005__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0005__p12792357124410">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="nosql_06_0005__p13736514459">This API is an asynchronous API. A successful response does not indicate that the parameter template is successfully applied.</p>
</div>
<div class="section" id="nosql_06_0005__section48594558107"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0005__p1968392416521">PUT https://{Endpoint}/v3.1/{project_id}/configurations/{config_id}/apply</p>
@ -41,39 +41,39 @@
</div>
</div>
<div class="section" id="nosql_06_0005__section188661455121016"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0005__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_06_0005__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0005__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0005__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0005__row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0005__p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0005__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0005__p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0005__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0005__p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_06_0005__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_06_0005__p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0005__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0005__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_06_0005__row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0005__p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0005__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0005__p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0005__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0005__p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0005__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_06_0005__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0005__p822614372917">MIME type of the request body. <strong id="nosql_06_0005__b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_06_0005__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0005__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_06_0005__row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0005__p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0005__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0005__p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0005__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0005__p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0005__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0005__p1797243342916">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0005__request_ApplyConfigurationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="nosql_06_0005__row1786975541020"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_06_0005__p98701155121016">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0005__request_ApplyConfigurationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_06_0005__row1786975541020"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_06_0005__p98701155121016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_06_0005__p1487095512107">Mandatory</p>
</th>
@ -125,13 +125,13 @@
</table>
</div>
</div>
<div class="section" id="nosql_06_0005__section1187817553101"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_06_0005__ul1878355151012"><li id="nosql_06_0005__li9155336143612">URI example<pre class="screen" id="nosql_06_0005__screen51551936133612">PUT https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply</pre>
<div class="section" id="nosql_06_0005__section1187817553101"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_06_0005__ul1878355151012"><li id="nosql_06_0005__li9155336143612">URI example<pre class="screen" id="nosql_06_0005__screen51551936133612">PUT https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply</pre>
</li><li id="nosql_06_0005__li38791655151014">Applying a Parameter Template<pre class="screen" id="nosql_06_0005__screen138802552102">{
"instance_ids" : [ "73ea2bf70c73497f89ee0ad4ee008aa2in06" ]
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_06_0005__section5880355111018"><h4 class="sectiontitle">Example Response</h4><p id="nosql_06_0005__p4881855131019">Status code: 202</p>
<div class="section" id="nosql_06_0005__section5880355111018"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0005__p4881855131019">Status code: 202</p>
<p id="nosql_06_0005__p168812558109">Success</p>
<pre class="screen" id="nosql_06_0005__screen288145501013">{
"job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",

32
docs/geminidb/api-ref/nosql_06_0006.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Modifying Parameters of a Specified Instance</h1>
<div id="body12686712181517"><div class="section" id="nosql_06_0006__section968681217152"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0006__p16687412171516">This API is used to modify parameters of a specified instance.</p>
</div>
<div class="section" id="nosql_06_0006__section9749104794719"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0006__p75701734811">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_06_0006__section9749104794719"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0006__p75701734811">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
<p id="nosql_06_0006__p182191618484">For configuration item <strong id="nosql_06_0006__b032714505249">values</strong>, you can enter system-defined parameters that allow for modification.</p>
<p id="nosql_06_0006__p4123918154817">This API is an asynchronous API. A successful response does not indicate that the parameters are successfully modified.</p>
</div>
@ -42,39 +42,39 @@
</div>
</div>
<div class="section" id="nosql_06_0006__section97131012151512"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0006__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_06_0006__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0006__nosql_06_0002_p936941712818">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0006__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0006__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0006__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0006__nosql_06_0002_p2369717883">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0006__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0006__nosql_06_0002_p93709171881">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0006__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_06_0006__nosql_06_0002_p1937018171381">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_06_0006__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0006__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0006__nosql_06_0002_p047832135015">Content-Type</p>
<tbody><tr id="nosql_06_0006__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0006__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0006__nosql_06_0002_p34785216504">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0006__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0006__nosql_06_0002_p082192665218">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0006__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0006__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_06_0006__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0006__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_06_0006__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_06_0006__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0006__nosql_06_0002_p1937017171284">X-Auth-Token</p>
<tr id="nosql_06_0006__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0006__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0006__nosql_06_0002_p15371517489">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0006__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0006__nosql_06_0002_p1437119171810">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0006__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0006__nosql_06_0002_p1237131714819">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0006__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0006__request_UpdateInstanceConfigurationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="nosql_06_0006__row1372371261517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_06_0006__p5724151231518">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0006__request_UpdateInstanceConfigurationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_06_0006__row1372371261517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_06_0006__p5724151231518">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_06_0006__p12725121213155">Mandatory</p>
</th>
@ -126,7 +126,7 @@
</table>
</div>
</div>
<div class="section" id="nosql_06_0006__section1674591231512"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_06_0006__ul67481912151510"><li id="nosql_06_0006__li195201319104218">URI example<pre class="screen" id="nosql_06_0006__screen135200197426">PUT https://{Endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/instances/392850e624504e1490901d50b585a60din06/configurations</pre>
<div class="section" id="nosql_06_0006__section1674591231512"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_06_0006__ul67481912151510"><li id="nosql_06_0006__li195201319104218">URI example<pre class="screen" id="nosql_06_0006__screen135200197426">PUT https://{Endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/instances/392850e624504e1490901d50b585a60din06/configurations</pre>
</li><li id="nosql_06_0006__li775421215159">Modifying Parameters of a Specified Instance<pre class="screen" id="nosql_06_0006__screen2755151218156">{
"values" : {
"request_timeout_in_ms" : "10000"
@ -134,7 +134,7 @@
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_06_0006__section1975821216158"><h4 class="sectiontitle">Example Response</h4><p id="nosql_06_0006__p27591412151520">Status code: 202</p>
<div class="section" id="nosql_06_0006__section1975821216158"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0006__p27591412151520">Status code: 202</p>
<p id="nosql_06_0006__p0760161201512">Success</p>
<pre class="screen" id="nosql_06_0006__screen11761912151510">{
"job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",

12
docs/geminidb/api-ref/nosql_06_0007.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying Instance Parameter Settings</h1>
<div id="body1932024102010"><div class="section" id="nosql_06_0007__section83315242204"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0007__p5361824152016">This API is used to query instance parameter settings.</p>
</div>
<div class="section" id="nosql_06_0007__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0007__p12792357124410">This API can be used for GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_06_0007__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0007__p12792357124410">This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.</p>
</div>
<div class="section" id="nosql_06_0007__section669112417204"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0007__p172162414208">GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations</p>
@ -40,7 +40,7 @@
</div>
</div>
<div class="section" id="nosql_06_0007__section141131124202019"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_06_0007__row141171124112015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0007__p151221224182018">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0007__row141171124112015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0007__p151221224182018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0007__p6124172462010">Mandatory</p>
</th>
@ -85,6 +85,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p19174122415202">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p81771224122013">Database name.</p>
<ul id="nosql_06_0007__ul152215541482"><li id="nosql_06_0007__li75221554104812"><strong id="nosql_06_0007__b87294154124">cassandra</strong>: GeminiDB Cassandra instance</li><li id="nosql_06_0007__li259895604815"><strong id="nosql_06_0007__b1487341871210">influxdb</strong>: GeminiDB Influx instance</li></ul>
</td>
</tr>
<tr id="nosql_06_0007__row1715072414204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p1418052422018">created</p>
@ -115,7 +116,8 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p1466134815720">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p119732591511">Instance type. The value can be:</p>
<p id="nosql_06_0007__p67984319220"><strong id="nosql_06_0007__b148181141329">Cluster</strong>, indicating that the instance is of the <span id="nosql_06_0007__text4603113651810">GeminiDB Cassandra</span> cluster type.</p>
<p id="nosql_06_0007__p67984319220"><strong id="nosql_06_0007__b12555153021213">Cluster</strong>: <span id="nosql_06_0007__text4603113651810">GeminiDB Cassandra</span> cluster instance</p>
<p id="nosql_06_0007__p1577119368453"><strong id="nosql_06_0007__b89351954201218">CloudNativeCluster</strong>: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage</p>
</td>
</tr>
<tr id="nosql_06_0007__row41501224172015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p122071424132015">configuration_parameters</p>
@ -192,10 +194,10 @@
</table>
</div>
</div>
<div class="section" id="nosql_06_0007__section131172410205"><h4 class="sectiontitle">Example Request</h4><div class="p" id="nosql_06_0007__p74431203282">URI example<pre class="screen" id="nosql_06_0007__screen1023681116333">GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations </pre>
<div class="section" id="nosql_06_0007__section131172410205"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_06_0007__p74431203282">URI example<pre class="screen" id="nosql_06_0007__screen1023681116333">GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations </pre>
</div>
</div>
<div class="section" id="nosql_06_0007__section15329202420203"><h4 class="sectiontitle">Example Response</h4><p id="nosql_06_0007__p033217245208">Status code: 200</p>
<div class="section" id="nosql_06_0007__section15329202420203"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0007__p033217245208">Status code: 200</p>
<p id="nosql_06_0007__p133341124162014">Success</p>
<pre class="screen" id="nosql_06_0007__screen1334112243207">{
"datastore_version_name" : "3.11",

181
docs/geminidb/api-ref/nosql_06_0110.html Normal file
View File

File diff suppressed because it is too large Load Diff

154
docs/geminidb/api-ref/nosql_06_0111.html Normal file
View File

File diff suppressed because it is too large Load Diff

138
docs/geminidb/api-ref/nosql_06_0112.html Normal file
View File

File diff suppressed because it is too large Load Diff

329
docs/geminidb/api-ref/nosql_10_0003.html Normal file
View File

File diff suppressed because it is too large Load Diff

16
docs/geminidb/api-ref/nosql_10_0100.html
View File

@ -110,23 +110,23 @@
</div>
</div>
<div class="section" id="nosql_10_0100__section7509101414414"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0100__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_10_0100__row551114141446"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="nosql_10_0100__p651418147413">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0100__table783114133814" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_10_0100__row18123191155715"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="nosql_10_0100__p11123711195712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="nosql_10_0100__p751719141646">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="nosql_10_0100__p10123161120572">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="nosql_10_0100__p9520314848">Type</p>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="nosql_10_0100__p8123161115576">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="nosql_10_0100__p752241412410">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="nosql_10_0100__p1012371112575">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0100__row1651120141642"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="nosql_10_0100__p12524114448">X-Auth-Token</p>
<tbody><tr id="nosql_10_0100__row1312510113575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="nosql_10_0100__p412514113577">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="nosql_10_0100__p1852571412411">Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="nosql_10_0100__p15125111175712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="nosql_10_0100__p1252719141642">String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="nosql_10_0100__p41258116574">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="nosql_10_0100__p1528814542">User token.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="nosql_10_0100__p3125911145711">User token</p>
</td>
</tr>
</tbody>

108
docs/geminidb/api-ref/nosql_10_0101.html Normal file
View File

File diff suppressed because it is too large Load Diff

281
docs/geminidb/api-ref/nosql_10_0102.html Normal file
View File

File diff suppressed because it is too large Load Diff

94
docs/geminidb/api-ref/nosql_10_0103.html Normal file
View File

@ -0,0 +1,94 @@
<a name="nosql_10_0103"></a><a name="nosql_10_0103"></a>
<h1 class="topictitle1">Canceling a Scheduled Task</h1>
<div id="body0000001852583549"><div class="section" id="nosql_10_0103__section18164555125515"><h4 class="sectiontitle">Function</h4><p id="nosql_10_0103__p16318155510557">This function is used to cancel a scheduled task based on the task ID.</p>
</div>
<div class="section" id="nosql_10_0103__section716625510552"><h4 class="sectiontitle">Constraints</h4><p id="nosql_10_0103__p324933832614">This API supports the following types of instances:</p>
<ul id="nosql_10_0103__ul15249173882614"><li id="nosql_10_0103__li52491138122614"><span id="nosql_10_0103__text1984604319313">GeminiDB Influx</span></li><li id="nosql_10_0103__li118533714519"><span id="nosql_10_0103__text13378141911520">GeminiDB Cassandra</span></li></ul>
</div>
<div class="section" id="nosql_10_0103__section7173195555511"><h4 class="sectiontitle">URI</h4><p id="nosql_10_0103__p5318155545515">DELETE https://{Endpoint}/v3/{project_id}/scheduled-jobs/{job_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0103__table517475565514" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_10_0103__row3318155585518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_10_0103__p431816556559">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_10_0103__p731875515559">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_10_0103__p1131885514555">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_10_0103__p14318205517555">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0103__row16318185517559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_10_0103__p14318195575515">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_10_0103__p831895510554">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_10_0103__p19318145513552">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_10_0103__p173181355135513">Project ID of a user in a region</p>
</td>
</tr>
<tr id="nosql_10_0103__row1431895516559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_10_0103__p1318175565513">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_10_0103__p3318655125515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_10_0103__p1231875518556">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_10_0103__p5318355105511">Task ID. The value is the same as the <strong id="nosql_10_0103__b064020291384">job_id</strong> field returned in the scheduled task list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_10_0103__section8188135575518"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0103__table1419045535514" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_10_0103__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_10_0103__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_10_0103__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_10_0103__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_10_0103__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0103__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_10_0103__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_10_0103__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_10_0103__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_10_0103__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="nosql_10_0103__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="nosql_10_0103__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_10_0103__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_10_0103__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_10_0103__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_10_0103__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_10_0103__section219985505510"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_10_0103__p031914556550"><strong id="nosql_10_0103__b1397844520389">Status code: 204</strong></p>
<p id="nosql_10_0103__p0319195535516">None</p>
</div>
<div class="section" id="nosql_10_0103__section622265517552"><h4 class="sectiontitle">Example Requests</h4><p id="nosql_10_0103__p4320855145515">Cancel a scheduled task.</p>
<pre class="screen" id="nosql_10_0103__screen14320125510559">DELETE https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/scheduled-jobs/56d3c1138dcf4f1da73b0170700c78d0</pre>
</div>
<div class="section" id="nosql_10_0103__section10224755165518"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_10_0103__p18320195511558">None</p>
</div>
<div class="section" id="nosql_10_0103__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_10_0103__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_10_0103__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_10_0103__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000016.html">Task Management</a></div>
</div>
</div>

2
docs/geminidb/api-ref/nosql_12_0004.html
View File

@ -22,6 +22,8 @@
</li>
<li class="ulchildlink"><strong><a href="topic_300000016.html">Task Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000017.html">Enterprise Projects</a></strong><br>
</li>
</ul>
</div>

2
docs/geminidb/api-ref/nosql_12_0005.html
View File

@ -7,7 +7,7 @@
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_12_0006.html">Versions and Specifications</a></strong><br>
<li class="ulchildlink"><strong><a href="nosql_12_0006.html">API Versions and Specifications</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_12_0007.html">Backup and Restoration</a></strong><br>
</li>

7
docs/geminidb/api-ref/nosql_12_0006.html
View File

@ -1,10 +1,7 @@
<a name="nosql_12_0006"></a><a name="nosql_12_0006"></a>
<h1 class="topictitle1">Versions and Specifications</h1>
<div id="body0000002252677825"></div>
<h1 class="topictitle1"><span id="text1312316012166">API</span> Versions and Specifications</h1>
<div id="body0000002252677825"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_instance_specification.html">Querying Instance Specifications</a></strong><br>

6
docs/geminidb/api-ref/nosql_12_0013.html
View File

@ -54,7 +54,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nosql_12_0013__en-us_topic_0000001580721473_p1855618139498">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nosql_12_0013__en-us_topic_0000001580721473_p1955601364915">Database type. The value can be:</p>
<ul id="nosql_12_0013__en-us_topic_0000001580721473_ul145561413154916"><li id="nosql_12_0013__en-us_topic_0000001580721473_li135561013114919">cassandra</li></ul>
<ul id="nosql_12_0013__en-us_topic_0000001580721473_ul145561413154916"><li id="nosql_12_0013__en-us_topic_0000001580721473_li135561013114919">cassandra</li><li id="nosql_12_0013__en-us_topic_0000001580721473_li85565138491">influxdb</li></ul>
</td>
</tr>
<tr id="nosql_12_0013__en-us_topic_0000001580721473_row855651334914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nosql_12_0013__en-us_topic_0000001580721473_p955661354911">backup_id</p>
@ -334,12 +334,12 @@
</table>
</div>
</div>
<div class="section" id="nosql_12_0013__en-us_topic_0000001580721473_section836651314490"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_12_0013__en-us_topic_0000001580721473_ul16894796285"><li id="nosql_12_0013__en-us_topic_0000001580721473_li08941596286">URI example<pre class="screen" id="nosql_12_0013__en-us_topic_0000001580721473_screen9191139162918">GET https://{Endpoint}/v4/
<div class="section" id="nosql_12_0013__en-us_topic_0000001580721473_section836651314490"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_12_0013__en-us_topic_0000001580721473_ul16894796285"><li id="nosql_12_0013__en-us_topic_0000001580721473_li08941596286">URI example<pre class="screen" id="nosql_12_0013__en-us_topic_0000001580721473_screen9191139162918">GET https://{Endpoint}/v4/
054b61972980d4552f0bc00ac8d3f5cd/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&amp;offset=2&amp;limit=2&amp;begin_time=2019-05-27T03:38:51+0000&amp;end_time=2019-05-28T03:38:51+0000&amp;type=DatabaseTable</pre>
</li><li id="nosql_12_0013__en-us_topic_0000001580721473_li119031955202817">Example request body<p id="nosql_12_0013__en-us_topic_0000001580721473_p1877918314588"><a name="nosql_12_0013__en-us_topic_0000001580721473_li119031955202817"></a><a name="en-us_topic_0000001580721473_li119031955202817"></a>None</p>
</li></ul>
</div>
<div class="section" id="nosql_12_0013__en-us_topic_0000001580721473_section3368171317499"><h4 class="sectiontitle">Example Response</h4><p id="nosql_12_0013__en-us_topic_0000001580721473_p1956312136493">Status code: 200</p>
<div class="section" id="nosql_12_0013__en-us_topic_0000001580721473_section3368171317499"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_12_0013__en-us_topic_0000001580721473_p1956312136493">Status code: 200</p>
<p id="nosql_12_0013__en-us_topic_0000001580721473_p5133351125917">Success</p>
<pre class="screen" id="nosql_12_0013__en-us_topic_0000001580721473_screen7563171384911">{
"total_count" : 4,

10
docs/geminidb/api-ref/nosql_api_0030.html
View File

@ -64,7 +64,7 @@
</div>
</div>
<div class="section" id="nosql_api_0030__section191261931184410"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_api_0030__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameter</caption><thead align="left"><tr id="nosql_api_0030__row131291431134417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_api_0030__p1130331144420">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_api_0030__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_api_0030__row131291431134417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_api_0030__p1130331144420">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_api_0030__p5130531114415">Mandatory</p>
</th>
@ -89,7 +89,7 @@
</div>
<div class="section" id="nosql_api_0030__section6134031194418"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_api_0030__p1113413154414">Status code: 200</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_api_0030__response_ShowBackupPolicyResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="nosql_api_0030__row21351931164410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_api_0030__p10136113116443">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_api_0030__response_ShowBackupPolicyResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_api_0030__row21351931164410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_api_0030__p10136113116443">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_api_0030__p11137203112443">Type</p>
</th>
@ -158,11 +158,11 @@
</table>
</div>
</div>
<div class="section" id="nosql_api_0030__section514819315445"><h4 class="sectiontitle">Example Request</h4><div class="p" id="nosql_api_0030__p1452923510310">URI example<pre class="screen" id="nosql_api_0030__screen35303356313">GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy?type=Instance</pre>
<div class="section" id="nosql_api_0030__section514819315445"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_api_0030__p1452923510310">URI example<pre class="screen" id="nosql_api_0030__screen35303356313">GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy?type=Instance</pre>
</div>
</div>
<div class="section" id="nosql_api_0030__section1115173118442"><h4 class="sectiontitle">Example Response</h4><p id="nosql_api_0030__p015123112449">Status code: 200</p>
<p id="nosql_api_0030__p10151123120442">Successful request</p>
<div class="section" id="nosql_api_0030__section1115173118442"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_api_0030__p015123112449">Status code: 200</p>
<p id="nosql_api_0030__p10151123120442">Success</p>
<p id="nosql_api_0030__p1577413414449">Response when an automated backup policy is enabled</p>
<pre class="screen" id="nosql_api_0030__screen117516113413">{
"backup_policy" : {

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