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
2025-09-04 07:22:35 +00:00
committed by zuul
parent f9e2808b7c
commit 8d0926f0e5
68 changed files with 3922 additions and 1132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because it is too large Load Diff

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

@ -3,7 +3,7 @@
<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 supports 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 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>
@ -11,7 +11,7 @@
</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>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchTagAction__table872045755014" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="BatchTagAction__row471935714508"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="BatchTagAction__p1272195719500">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchTagAction__table872045755014" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="BatchTagAction__row471935714508"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="BatchTagAction__p1272195719500">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="BatchTagAction__p197230571507">Mandatory</p>
</th>
@ -44,23 +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 parameters</caption><thead align="left"><tr id="BatchTagAction__row117381857165019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="BatchTagAction__p117411757175018">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="BatchTagAction__p1274218574506">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_0002_p2369717883">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="BatchTagAction__p1874319575509">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_0002_p93709171881">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="BatchTagAction__p1974445715501">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchTagAction__row5738757115013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="BatchTagAction__p107451557195020">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="BatchTagAction__p167470575505">Yes</p>
<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>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="BatchTagAction__p674819574505">String</p>
<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>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="BatchTagAction__p19749205745017">User token.</p>
<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>
</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>
</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>
<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>
<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>
</tr>
</tbody>
@ -138,9 +147,9 @@
</div>
</div>
<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">No response parameters</p>
<p id="BatchTagAction__p480813573506">None</p>
</div>
<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>
<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>
</li><li id="BatchTagAction__li48171570506">Adding two tags<pre class="screen" id="BatchTagAction__screen5821457145018">{
"action" : "create",
"tags" : [ {
@ -162,13 +171,13 @@
}</pre>
</li></ul>
</div>
<div class="section" id="BatchTagAction__section98445574504"><h4 class="sectiontitle">Example Responses</h4><p id="BatchTagAction__p28469572504"><strong id="BatchTagAction__b162662031101218">Status code: 200</strong></p>
<div class="section" id="BatchTagAction__section98445574504"><h4 class="sectiontitle">Example Response</h4><p id="BatchTagAction__p28469572504">Status code: 200</p>
<p id="BatchTagAction__p4847457175014">Success</p>
<pre class="screen" id="BatchTagAction__screen38481357145019">{ }</pre>
</div>
<div class="section" id="BatchTagAction__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="BatchTagAction__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="BatchTagAction__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="BatchTagAction__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="BatchTagAction__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="BatchTagAction__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="BatchTagAction__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="BatchTagAction__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

File diff suppressed because it is too large Load Diff

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

@ -3,12 +3,12 @@
<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 supports 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 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>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceTags__table057033875320" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="ListInstanceTags__row956813810535"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ListInstanceTags__p357123816535">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceTags__table057033875320" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ListInstanceTags__row956813810535"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ListInstanceTags__p357123816535">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ListInstanceTags__p757303885310">Mandatory</p>
</th>
@ -41,7 +41,7 @@
</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 parameters</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__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>
</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>
@ -64,9 +64,9 @@
</table>
</div>
</div>
<div class="section" id="ListInstanceTags__section126105382536"><h4 class="sectiontitle">Response Parameters</h4><p id="ListInstanceTags__p66121838125317"><strong id="ListInstanceTags__b19533172563020">Status code: 200</strong></p>
<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 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>
<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>
</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>
@ -113,10 +113,10 @@
</table>
</div>
</div>
<div class="section" id="ListInstanceTags__section4656123835316"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="ListInstanceTags__p126725082915">URI example<pre class="screen" id="ListInstanceTags__screen796744261119">GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags</pre>
<div class="section" id="ListInstanceTags__section4656123835316"><h4 class="sectiontitle">Example Request</h4><div class="p" id="ListInstanceTags__p126725082915">URI example<pre class="screen" id="ListInstanceTags__screen796744261119">GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags</pre>
</div>
</div>
<div class="section" id="ListInstanceTags__section156681638125313"><h4 class="sectiontitle">Example Responses</h4><p id="ListInstanceTags__p10670173816537"><strong id="ListInstanceTags__b1322861465115">Status code: 200</strong></p>
<div class="section" id="ListInstanceTags__section156681638125313"><h4 class="sectiontitle">Example Response</h4><p id="ListInstanceTags__p10670173816537">Status code: 200</p>
<p id="ListInstanceTags__p116711038145311">Success</p>
<pre class="screen" id="ListInstanceTags__screen1867616385538">{
"tags" : [ {
@ -128,9 +128,9 @@
} ]
}</pre>
</div>
<div class="section" id="ListInstanceTags__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ListInstanceTags__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="ListInstanceTags__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ListInstanceTags__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="ListInstanceTags__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ListInstanceTags__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="ListInstanceTags__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ListInstanceTags__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

41
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 supports 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 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>Path 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>
<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>
</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,23 +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 parameters</caption><thead align="left"><tr id="ListInstancesByResourceTags__row798711664615"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListInstancesByResourceTags__p19988116104620">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ListInstancesByResourceTags__p11989461465">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_0002_p2369717883">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ListInstancesByResourceTags__p29892063460">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_0002_p93709171881">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ListInstancesByResourceTags__p1990662461">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesByResourceTags__row898712634618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListInstancesByResourceTags__p2990126124620">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListInstancesByResourceTags__p999117617465">Yes</p>
<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>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListInstancesByResourceTags__p1799106114620">String</p>
<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>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListInstancesByResourceTags__p1899120615468">User token.</p>
<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>
</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>
</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>
<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>
<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>
</tr>
</tbody>
@ -178,14 +187,14 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="ListInstancesByResourceTags__p112317712464">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="ListInstancesByResourceTags__p12477104610">Tag values. Each tag value can contain a maximum of 43 Unicode characters and cannot contain spaces. Before using <strong id="ListInstancesByResourceTags__b12924854144916">values</strong>, delete spaces before and after the value.</p>
<p id="ListInstancesByResourceTags__p1124674467">If the <strong id="ListInstancesByResourceTags__b187664395014">values</strong> is not specified, any parameter value can be queried. All values are in the OR relationship.</p>
<p id="ListInstancesByResourceTags__p1124674467">If <strong id="ListInstancesByResourceTags__b5978144175612">values</strong> is not specified, any value can be queried. All values are in the OR relationship.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstancesByResourceTags__section8241474465"><h4 class="sectiontitle">Response Parameters</h4><p id="ListInstancesByResourceTags__p32513724615"><strong id="ListInstancesByResourceTags__b117378916540">Status code: 200</strong></p>
<div class="section" id="ListInstancesByResourceTags__section8241474465"><h4 class="sectiontitle">Response Parameters</h4><p id="ListInstancesByResourceTags__p32513724615">Status code: 200</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesByResourceTags__response_ListInstancesByTagsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ListInstancesByResourceTags__row112516724611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ListInstancesByResourceTags__p226107124614">Parameter</p>
</th>
@ -274,7 +283,7 @@
</table>
</div>
</div>
<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>
<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>
</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,
@ -309,7 +318,7 @@
}</pre>
</li></ul>
</div>
<div class="section" id="ListInstancesByResourceTags__section855127144618"><h4 class="sectiontitle">Example Responses</h4><p id="ListInstancesByResourceTags__p185517154618"><strong id="ListInstancesByResourceTags__b97413163211">Status code: 200</strong></p>
<div class="section" id="ListInstancesByResourceTags__section855127144618"><h4 class="sectiontitle">Example Response</h4><p id="ListInstancesByResourceTags__p185517154618">Status code: 200</p>
<p id="ListInstancesByResourceTags__p25537184614">Success</p>
<pre class="screen" id="ListInstancesByResourceTags__screen75677124618">{
"total_count": 1,
@ -326,9 +335,9 @@
}]
}</pre>
</div>
<div class="section" id="ListInstancesByResourceTags__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ListInstancesByResourceTags__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="ListInstancesByResourceTags__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ListInstancesByResourceTags__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="ListInstancesByResourceTags__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ListInstancesByResourceTags__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="ListInstancesByResourceTags__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ListInstancesByResourceTags__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

197
docs/geminidb/api-ref/ListRestoreTime.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -234,9 +234,9 @@
} ]
}</pre>
</div>
<div class="section" id="ListSlowLogs__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ListSlowLogs__listapiversion_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">For details, 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__listapiversion_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">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -151,9 +151,9 @@
}
}</pre>
</div>
<div class="section" id="ShowApiVersion__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ShowApiVersion__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="ShowApiVersion__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ShowApiVersion__en-us_topic_0000001354223196_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="ShowApiVersion__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ShowApiVersion__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="ShowApiVersion__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ShowApiVersion__en-us_topic_0000001354223196_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -141,9 +141,9 @@
}
}</pre>
</div>
<div class="section" id="ShowQuotas__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ShowQuotas__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="ShowQuotas__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="ShowQuotas__en-us_topic_0000001354223196_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="ShowQuotas__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ShowQuotas__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="ShowQuotas__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="ShowQuotas__en-us_topic_0000001354223196_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

0
docs/geminidb/api-ref/en-us_image_0000001355018024.png → docs/geminidb/api-ref/en-us_image_0000002192228076.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

0
docs/geminidb/api-ref/en-us_image_0000001354858484.jpg → docs/geminidb/api-ref/en-us_image_0000002192387692.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 110 KiB

After

Width:  |  Height:  |  Size: 110 KiB

0
docs/geminidb/api-ref/en-us_image_0000001354698252.png → docs/geminidb/api-ref/en-us_image_0000002227713545.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

9
docs/geminidb/api-ref/nosql_05_0005.html
View File

@ -7,7 +7,7 @@
</li><li id="nosql_05_0005__en-us_topic_0169294976_li1564913617106">Region<p id="nosql_05_0005__en-us_topic_0169294976_p10588103711107"><a name="nosql_05_0005__en-us_topic_0169294976_li1564913617106"></a><a name="en-us_topic_0169294976_li1564913617106"></a>A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.</p>
</li><li id="nosql_05_0005__en-us_topic_0169294976_li1183783919109">AZ<p id="nosql_05_0005__en-us_topic_0169294976_p061084051014"><a name="nosql_05_0005__en-us_topic_0169294976_li1183783919109"></a><a name="en-us_topic_0169294976_li1183783919109"></a>An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are connected using high-speed optical fibers to support cross-AZ high-availability systems.</p>
</li><li id="nosql_05_0005__en-us_topic_0169294976_li3896216123113">Project<p id="nosql_05_0005__en-us_topic_0169294976_p10896181643118"><a name="nosql_05_0005__en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0169294976_li3896216123113"></a>A project corresponds to a region. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. Users can be granted permissions in a default project to access all resources in the region associated with the project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in specific subprojects.</p>
<div class="fignone" id="nosql_05_0005__fig624534017105"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="nosql_05_0005__image72455409107" src="en-us_image_0000001354698252.png"></span></div>
<div class="fignone" id="nosql_05_0005__fig624534017105"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="nosql_05_0005__image72455409107" src="en-us_image_0000002227713545.png" title="Click to enlarge" class="imgResize"></span></div>
</li><li id="nosql_05_0005__li6315139417">Enterprise Project<p id="nosql_05_0005__p1386212240416"><a name="nosql_05_0005__li6315139417"></a><a name="li6315139417"></a>Enterprise projects group and manage resources across regions. Resources in enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from the enterprise project.</p>
</li></ul>
</div>
@ -17,3 +17,10 @@
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

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

@ -1,7 +1,7 @@
<a name="nosql_05_0008"></a><a name="nosql_05_0008"></a>
<h1 class="topictitle1">Making an API Request</h1>
<div id="body0000001354698224"><p id="nosql_05_0008__en-us_topic_0121682347_p15648656678">This section describes the structure of a REST API, and uses the IAM API for <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a> as an example to describe how to call an API. The obtained token is used to authenticate the calling of other APIs.</p>
<div id="body0000001354698224"><p id="nosql_05_0008__en-us_topic_0121682347_p15648656678">This section describes the structure of a REST API, and uses the IAM API for <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a> as an example to describe how to call an API. The obtained token is used to authenticate other APIs.</p>
<div class="section" id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_section697653216219"><h4 class="sectiontitle">Request URI</h4><p id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_p1327834192114">A request URI consists of the following:</p>
<p id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_p015994616212"><strong id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_b11186155382110">{URI-scheme}://{Endpoint}/{resource-path}?{query-string}</strong></p>
<p id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_p16960034182113">Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be separately transmitted, rather than being conveyed in a request message separately.</p>
@ -19,7 +19,7 @@
</tr>
<tr id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_row444414692513"><td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.2.5.2.3.1.1 "><p id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_p7444194610257">Endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="80.52%" headers="mcps1.3.2.5.2.3.1.2 "><p id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_p244474613259">Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies depending on services and regions. It can be obtained from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<td class="cellrowborder" valign="top" width="80.52%" headers="mcps1.3.2.5.2.3.1.2 "><p id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_p244474613259">Domain name or IP address of a server where a REST service endpoint is hosted. The endpoint varies depending on services and regions. It can be obtained from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</td>
</tr>
<tr id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_row1744454612520"><td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.2.5.2.3.1.1 "><p id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_p14442468257">resource-path</p>
@ -86,7 +86,7 @@
</td>
<td class="cellrowborder" valign="top" width="26.5%" headers="mcps1.3.4.3.2.2.5.1.2 "><p id="nosql_05_0008__en-us_topic_0121682347_p1486815116337">MIME type of the request body. Use the default value <strong id="nosql_05_0008__b1455135481314">application/json</strong>. For APIs used to upload objects or images, the value varies depending on the flow type.</p>
</td>
<td class="cellrowborder" valign="top" width="20.11%" headers="mcps1.3.4.3.2.2.5.1.3 "><p id="nosql_05_0008__en-us_topic_0121682347_p1086812114335">Yes</p>
<td class="cellrowborder" valign="top" width="20.11%" headers="mcps1.3.4.3.2.2.5.1.3 "><p id="nosql_05_0008__p15299142111189">This field is optional for GET requests and mandatory for other requests.</p>
</td>
<td class="cellrowborder" valign="top" width="33.650000000000006%" headers="mcps1.3.4.3.2.2.5.1.4 "><p id="nosql_05_0008__en-us_topic_0121682347_p1186841163310">application/json</p>
</td>
@ -124,13 +124,13 @@
</table>
</div>
</div>
<p id="nosql_05_0008__en-us_topic_0121682347_p42118461957">The API used to <a href="https://docs.otc.t-systems.com/identity-access-management/api-ref/apis/token_management/obtaining_a_user_token.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> does not require authentication. Therefore, this API only requires adding the <span class="parmname" id="nosql_05_0008__parmname19616135601517"><b>Content-Type</b></span> field. The following is an example request:</p>
<p id="nosql_05_0008__en-us_topic_0121682347_p42118461957">The API used to <a href="https://docs.otc.t-systems.com/identity-access-management/api-ref/apis/token_management/obtaining_a_user_token.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> does not require authentication. Therefore, this API only requires adding the <span class="parmname" id="nosql_05_0008__parmname47288443416"><b>Content-Type</b></span> field. The following is an example request:</p>
<pre class="screen" id="nosql_05_0008__en-us_topic_0121682347_screen73731462616">POST https://{{endpoint}}/v3/auth/tokens
Content-Type: application/json</pre>
</div>
<div class="section" id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_section1437471411"><h4 class="sectiontitle">(Optional) Request Body</h4><p id="nosql_05_0008__en-us_topic_0121682347_en-us_topic_0113746487_p76011911717">This part is optional. The request body is often sent in a structured format (for example, JSON or XML) as specified in the <strong id="nosql_05_0008__b12517172619179">Content-Type</strong> header field. If the request body contains full-width characters, these characters must be coded in UTF-8.</p>
<p id="nosql_05_0008__en-us_topic_0121682347_p1847214711331">Request bodies vary depending on APIs. Some APIs do not require a request body, such as the APIs requested using the GET and DELETE methods.</p>
<p id="nosql_05_0008__en-us_topic_0121682347_p105261225101112">For the API of <a href="https://docs.otc.t-systems.com/identity-access-management/api-ref/apis/token_management/obtaining_a_user_token.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a>, request parameters and parameter description can be obtained from the API request. The following is an example request with a body included. Replace <em id="nosql_05_0008__i169965417294">username</em>, <em id="nosql_05_0008__i8101135419294">domianname</em>, <em id="nosql_05_0008__i151010546295">********</em> (login password), and <em id="nosql_05_0008__i1210465413296">xxxxxxxxxxxxxxxxxx</em> (project name) with required values. You can obtain the values from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<p id="nosql_05_0008__en-us_topic_0121682347_p105261225101112">For the API of <a href="https://docs.otc.t-systems.com/identity-access-management/api-ref/apis/token_management/obtaining_a_user_token.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a>, request parameters and parameter description can be obtained from the API request. The following is an example request with a body included. Replace <em id="nosql_05_0008__i289845615414">username</em>, <em id="nosql_05_0008__i1189819566414">domainname</em>, <em id="nosql_05_0008__i16898145644111">********</em> (login password), and <em id="nosql_05_0008__i18898195654115">xxxxxxxxxxxxxxxxxx</em> (project name) with required values. You can obtain the values from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<div class="note" id="nosql_05_0008__en-us_topic_0121682347_note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nosql_05_0008__en-us_topic_0121682347_p199011223194814">The <strong id="nosql_05_0008__b1638720387314">scope</strong> parameter specifies where a token takes effect. You can set <strong id="nosql_05_0008__b5388838163118">scope</strong> to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For details, see <a href="https://docs.otc.t-systems.com/identity-access-management/api-ref/apis/token_management/obtaining_a_user_token.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</p>
</div></div>
<pre class="screen" id="nosql_05_0008__en-us_topic_0121682347_screen6140617194816">
@ -148,7 +148,7 @@ Content-Type: application/json
"name": "<em id="nosql_05_0008__en-us_topic_0121682347_i315217719194"><strong id="nosql_05_0008__en-us_topic_0121682347_b14500116161919">username</strong></em>",
"password": "<strong id="nosql_05_0008__en-us_topic_0121682347_b2559181251918"><em id="nosql_05_0008__en-us_topic_0121682347_i12803128192">********</em></strong>",
"domain": {
"name": "<em id="nosql_05_0008__en-us_topic_0121682347_i1560271681911"><strong id="nosql_05_0008__en-us_topic_0121682347_b17173191614194">domianname</strong></em>"
"name": "<em id="nosql_05_0008__en-us_topic_0121682347_i1560271681911"><strong id="nosql_05_0008__en-us_topic_0121682347_b17173191614194">domainname</strong></em>"
}
}
}

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

@ -30,11 +30,10 @@
}
}
}</pre>
<p id="nosql_05_0009__p14474111714512">After a token is obtained, add field <strong id="nosql_05_0009__b086233514314">X-Auth-Token</strong> to the request header to specify the token when other APIs are called. For example, if the token is <strong id="nosql_05_0009__b13692125216435">ABCDEFJ....</strong>, add <strong id="nosql_05_0009__b669335284315">X-Auth-Token: ABCDEFJ....</strong> to a request header as follows:</p>
<pre class="screen" id="nosql_05_0009__screen1047431725116">
POST https://{{Endpoint}}/v3/auth/projects
<p id="nosql_05_0009__p14474111714512">After a token is obtained, add field <strong id="nosql_05_0009__b086233514314">X-Auth-Token</strong> to the request header to specify the token when other APIs are called. For example, if the token is <strong id="nosql_05_0009__b207157914015">ABCDEFG....</strong>, add <strong id="nosql_05_0009__b47152918017">X-Auth-Token: ABCDEFG....</strong> to a request as follows:</p>
<pre class="screen" id="nosql_05_0009__screen1047431725116">GET https://{{Endpoint}}/v3/auth/projects
Content-Type: application/json
<strong id="nosql_05_0009__b847411765114">X-Auth-Token: ABCDEFJ....</strong></pre>
<strong id="nosql_05_0009__b847411765114">X-Auth-Token: ABCDEFG....</strong></pre>
</div>
<div>
<div class="familylinks">

9
docs/geminidb/api-ref/nosql_05_0010.html
View File

@ -7,7 +7,7 @@
</div>
<div class="section" id="nosql_05_0010__en-us_topic_0170155703_en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Header</h4><p id="nosql_05_0010__en-us_topic_0170155703_p384320471837">Similar to a request, a response also has a header, for example, <span class="parmvalue" id="nosql_05_0010__parmvalue19700316194919"><b>Content-Type</b></span>.</p>
<p id="nosql_05_0010__en-us_topic_0170155703_p4430113619484"><a href="#nosql_05_0010__en-us_topic_0170155703_fig4865141011511">Figure 1</a> shows the response header for the API used to <a href="https://docs.otc.t-systems.com/identity-access-management/api-ref/apis/token_management/obtaining_a_user_token.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, in which <span class="parmname" id="nosql_05_0010__parmname1677102494912"><b>x-subject-token</b></span> is the required user token. Then, this token can be used to authenticate the calling of other APIs.</p>
<div class="fignone" id="nosql_05_0010__en-us_topic_0170155703_fig4865141011511"><a name="nosql_05_0010__en-us_topic_0170155703_fig4865141011511"></a><a name="en-us_topic_0170155703_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Response header for the API used to obtain a user token</span><br><span><img id="nosql_05_0010__en-us_topic_0170155703_image48651610135113" src="en-us_image_0000001355018024.png"></span></div>
<div class="fignone" id="nosql_05_0010__en-us_topic_0170155703_fig4865141011511"><a name="nosql_05_0010__en-us_topic_0170155703_fig4865141011511"></a><a name="en-us_topic_0170155703_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Response header for the API used to obtain a user token</span><br><span><img id="nosql_05_0010__en-us_topic_0170155703_image48651610135113" src="en-us_image_0000002192228076.png" title="Click to enlarge" class="imgResize"></span></div>
</div>
<div class="section" id="nosql_05_0010__en-us_topic_0170155703_en-us_topic_0113746487_section2045571671419"><h4 class="sectiontitle">(Optional) Response Body</h4><p id="nosql_05_0010__en-us_topic_0170155703_en-us_topic_0113746487_p64711881416">This part is optional. A response body is generally returned in a structured format (for example, JSON or XML), corresponding to <strong id="nosql_05_0010__b15821146115015">Content-Type</strong> in the response header, and is used to transfer content other than the response header.</p>
</div>
@ -37,3 +37,10 @@
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

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

File diff suppressed because it is too large Load Diff

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

@ -3,11 +3,11 @@
<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 supports 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 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>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0015__table59045845117" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0015__row2902489512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0015__p1490412819512">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0015__table59045845117" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0015__row2902489512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0015__p1490412819512">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_0015__p8905158185118">Mandatory</p>
</th>
@ -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 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>
<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>
</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>
@ -84,18 +84,18 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0015__section159386819516"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_05_0015__p1817918183245">URI example<pre class="screen" id="nosql_05_0015__screen17649159123315">DELETE https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02</pre>
<div class="section" id="nosql_05_0015__section159386819516"><h4 class="sectiontitle">Example Request</h4><div class="p" id="nosql_05_0015__p1817918183245">URI example<pre class="screen" id="nosql_05_0015__screen17649159123315">DELETE https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02</pre>
</div>
</div>
<div class="section" id="nosql_05_0015__section1694310814519"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0015__p11944989519"><strong id="nosql_05_0015__b15435046102111">Status code: 202</strong></p>
<div class="section" id="nosql_05_0015__section1694310814519"><h4 class="sectiontitle">Example Response</h4><p id="nosql_05_0015__p11944989519"><strong id="nosql_05_0015__b15435046102111">Status code: 202</strong></p>
<p id="nosql_05_0015__p179442328277">Accepted</p>
<pre class="screen" id="nosql_05_0015__screen59461384518">{
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}</pre>
</div>
<div class="section" id="nosql_05_0015__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0015__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_05_0015__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0015__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0015__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0015__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0015__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0015__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

20
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__nosql_05_0015_p153256865116">This API supports 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 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>Path 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>
<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>
</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,7 +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__p1912394610403"> </p>
<p id="nosql_05_0016__p1912394610403">If this parameter is not transferred, all database instances are queried.</p>
</td>
</tr>
<tr id="nosql_05_0016__row4283169165110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p43161698511">mode</p>
@ -78,7 +78,7 @@
<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__b1078155513189">Cluster</strong>, indicating that GeminiDB Cassandra cluster instances are queried.</p>
<p id="nosql_05_0016__p16547324105017"><strong id="nosql_05_0016__b1188612371543">Cluster</strong>: GeminiDB Cassandra cluster instances</p>
<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 +127,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 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>
<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>
</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>
@ -150,7 +150,7 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0016__section5370896516"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0016__p12371599514"><strong id="nosql_05_0016__b9266555103116">Status code: 200</strong></p>
<div class="section" id="nosql_05_0016__section5370896516"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0016__p12371599514">Status code: 200</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__response_ListInstancesResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_05_0016__row33721595518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0016__p1737316911512">Parameter</p>
</th>
@ -548,14 +548,14 @@
</table>
</div>
</div>
<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>
<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>
<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 Responses</h4><p id="nosql_05_0016__p122731085118"><strong id="nosql_05_0016__b93265207129">Status code: 200</strong></p>
<div class="section" id="nosql_05_0016__section32272103511"><h4 class="sectiontitle">Example Response</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" : [ {
@ -685,9 +685,9 @@
"total_count" : 2
}</pre>
</div>
<div class="section" id="nosql_05_0016__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0016__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_05_0016__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0016__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0016__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0016__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0016__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0016__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -3,11 +3,11 @@
<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__nosql_05_0014_p153256865116">This API supports 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 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>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0050__table1975611919515" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0050__row775413914513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0050__p147573915117">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0050__table1975611919515" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0050__row775413914513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0050__p147573915117">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_0050__p177584914519">Mandatory</p>
</th>
@ -40,23 +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 parameters</caption><thead align="left"><tr id="nosql_05_0050__row117690920511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0050__p147712092510">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0050__p117727965112">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_0002_p2369717883">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__p677329155118">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_0002_p93709171881">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__p167743955114">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0050__row3769149145112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0050__p1973515400519">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0050__p1677514910518">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_0002_p34785216504">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0050__p1477615945118">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_0002_p082192665218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0050__p67779911515">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_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>
</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>
</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>
<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>
<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>
</tr>
</tbody>
@ -109,21 +118,21 @@
</table>
</div>
</div>
<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>
<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>
</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 Responses</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 Response</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"
}</pre>
</div>
<div class="section" id="nosql_05_0050__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0050__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_05_0050__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0050__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0050__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0050__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0050__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0050__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -7,7 +7,7 @@
</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>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0051__table124431010135114" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0051__row1044291013510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0051__p17443110135111">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0051__table124431010135114" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0051__row1044291013510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0051__p17443110135111">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_0051__p244441013515">Mandatory</p>
</th>
@ -40,23 +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 parameters</caption><thead align="left"><tr id="nosql_05_0051__row11450201015117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0051__p945151020514">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0051__p18451151095117">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_0002_p2369717883">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__p11451710125113">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_0002_p93709171881">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__p94521110195113">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0051__row16450210165110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0051__p4459111075117">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0051__p04627104519">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_0002_p34785216504">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0051__p3463810175118">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_0002_p082192665218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0051__p1946321015120">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_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>
</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>
</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>
<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>
<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>
</tr>
</tbody>
@ -89,7 +98,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0051__p1747110107512">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0051__p6472111085111">ID of the subnet where the new node is deployed.</p>
<ul id="nosql_05_0051__ul11472710165115"><li id="nosql_05_0051__li347291065114">This parameter can be transferred when nodes are added to the <span id="nosql_05_0051__text1733917587219">GeminiDB Cassandra</span> database instances.</li><li id="nosql_05_0051__li1747321095115">The transferred subnet ID must belong to the VPC where the current instance is deployed.</li><li id="nosql_05_0051__li1447381025113">If this parameter is not transferred, the system will allocate a subnet with sufficient IP addresses for the new node.</li></ul>
<ul id="nosql_05_0051__ul11472710165115"><li id="nosql_05_0051__li347291065114">This parameter can be transferred when nodes are added for <span id="nosql_05_0051__text1733917587219">GeminiDB Cassandra</span> instances.</li><li id="nosql_05_0051__li1747321095115">The transferred subnet ID must belong to the VPC where the current instance is deployed.</li><li id="nosql_05_0051__li1447381025113">If this parameter is not transferred, the system will allocate a subnet with sufficient IP addresses for the new node.</li></ul>
</td>
</tr>
</tbody>
@ -117,21 +126,21 @@
</table>
</div>
</div>
<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>
<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>
</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 Responses</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 Response</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"
}</pre>
</div>
<div class="section" id="nosql_05_0051__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0051__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_05_0051__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0051__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0051__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0051__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0051__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0051__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -7,7 +7,7 @@
</div>
<div class="section" id="nosql_05_0052__section998251215347"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0052__p6985101220341">POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reduce-node</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0052__table20990131253413" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0052__row15987112173410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0052__p99931212113410">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0052__table20990131253413" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0052__row15987112173410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0052__p99931212113410">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_0052__p099541223412">Mandatory</p>
</th>
@ -40,23 +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 parameters</caption><thead align="left"><tr id="nosql_05_0052__row130151303411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0052__p83481393415">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0052__p183781310343">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_0002_p2369717883">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__p539191353418">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_0002_p93709171881">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__p143201320349">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0052__row7301313193418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0052__p88961341963">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0052__p1248131316346">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_0002_p34785216504">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0052__p135141323419">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_0002_p082192665218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0052__p14542013143412">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_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>
</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>
</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>
<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>
<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>
</tr>
</tbody>
@ -81,7 +90,7 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0052__p282113113415">Number of nodes to be deleted randomly.</p>
<p id="nosql_05_0052__p25672295316">For <span id="nosql_05_0052__text972403313236">GeminiDB Cassandra</span> instances, the value ranges from <strong id="nosql_05_0052__b1655041401920">1</strong> to <strong id="nosql_05_0052__b18562141417191">10</strong>.</p>
<div class="note" id="nosql_05_0052__note1294813133419"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="nosql_05_0052__p598181312347">If users connect to nodes using the client, do no choose to delete node randomly.</p>
<div class="note" id="nosql_05_0052__note1294813133419"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="nosql_05_0052__p598181312347">If the client is directly connected to a node, random scale-in is not recommended.</p>
</div></div>
</td>
</tr>
@ -93,7 +102,7 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0052__p3112613113417">ID of the node to be deleted. Make sure that the node can be deleted. If this parameter is not transferred, the number of nodes to be deleted is based on the internal policy of the system.</p>
<div class="note" id="nosql_05_0052__note111751311349"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="nosql_05_0052__ul1912113133344"><li id="nosql_05_0052__li1512216137349">Either <strong id="nosql_05_0052__b1981273019229">num</strong> or <strong id="nosql_05_0052__b3821330162216">node_list</strong> must be set.<ul id="nosql_05_0052__ul4851213161515"><li id="nosql_05_0052__li25211018125512">If <strong id="nosql_05_0052__b887634910211">node_list</strong> is transferred, its value can contain 1 to 10 characters for GeminiDB Cassandra.</li><li id="nosql_05_0052__li19520201015153">If <strong id="nosql_05_0052__b123611630192510">num</strong> and <strong id="nosql_05_0052__b2362143011254">node_list</strong> are both transferred, the value of <strong id="nosql_05_0052__b11362113042512">node_list</strong> takes effect.</li></ul>
</li><li id="nosql_05_0052__li13138413153418">If <strong id="nosql_05_0052__b1881133811251">node_list</strong> is empty, instance nodes are deleted randomly. If <strong id="nosql_05_0052__b118812387253">node_list</strong> is not empty, only the node whose ID is specified is deleted.</li><li id="nosql_05_0052__li3141181313419">Before a node is deleted, do not connect to the node directly to avoid service interruptions.</li></ul>
</li><li id="nosql_05_0052__li13138413153418">If <strong id="nosql_05_0052__b1881133811251">node_list</strong> is empty, instance nodes are deleted randomly. If <strong id="nosql_05_0052__b118812387253">node_list</strong> is not empty, only the node with a specified ID is is deleted.</li><li id="nosql_05_0052__li3141181313419">Before a node is deleted, do not connect to the node directly to avoid service interruptions.</li></ul>
</div></div>
</td>
</tr>
@ -122,22 +131,22 @@
</table>
</div>
</div>
<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>
<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>
</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 Responses</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 Response</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"
}</pre>
</div>
<div class="section" id="nosql_05_0052__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0052__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_05_0052__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0052__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0052__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0052__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0052__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0052__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -13,7 +13,7 @@
</div>
<div class="section" id="nosql_05_0100__section10286143614116"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0100__p12288143601114">PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/resize</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0100__table16293123616115" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0100__row629093618115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0100__p529419362116">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0100__table16293123616115" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0100__row629093618115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0100__p529419362116">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_0100__p1129711363118">Mandatory</p>
</th>
@ -46,23 +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 parameters</caption><thead align="left"><tr id="nosql_05_0100__row1232343651113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0100__p4327163620110">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0100__p632913631110">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_0002_p2369717883">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__p143311036111112">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_0002_p93709171881">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__p3334036101111">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0100__row193233369114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0100__p934545617613">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0100__p233893610119">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_0002_p34785216504">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0100__p2340113601120">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_0002_p082192665218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0100__p434223615114">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_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>
</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>
</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>
<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>
<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>
</tr>
</tbody>
@ -137,23 +146,23 @@
</table>
</div>
</div>
<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 | 64 GB<pre class="screen" id="nosql_05_0100__screen3461536141114">{
<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>
</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"
}
}</pre>
</li></ul>
</div>
<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>
<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>
<p id="nosql_05_0100__p647612364111">Accepted</p>
<pre class="screen" id="nosql_05_0100__screen1047913368112">{
"job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}</pre>
</div>
<div class="section" id="nosql_05_0100__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0100__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_05_0100__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0100__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0100__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0100__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0100__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0100__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -3,13 +3,13 @@
<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 supports 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 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>
<div class="section" id="nosql_05_0101__section151481412201611"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0101__p91516121164">PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/password</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__table1715791221619" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0101__row1615471261612"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0101__p161591812121615">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0101__table1715791221619" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0101__row1615471261612"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0101__p161591812121615">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_0101__p316261261612">Mandatory</p>
</th>
@ -42,30 +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 parameters</caption><thead align="left"><tr id="nosql_05_0101__row3194812151611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0101__p2019818127162">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0101__p120112127169">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_0002_p2369717883">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__p32031512111613">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_0002_p93709171881">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__p1720721212168">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0101__row1319410124169"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0101__p52091512111614">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0101__p12121312121615">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_0002_p34785216504">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0101__p0214151217166">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_0002_p082192665218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0101__p0217161218165">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_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>
</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>
</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>
<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>
<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>
</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 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>
<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>
</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>
@ -90,21 +99,21 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0101__section1624981215168"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0101__p4253171210166"><strong id="nosql_05_0101__b1835816141812">Status code: 204</strong></p>
<p id="nosql_05_0101__p125651291588">No response parameters</p>
<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 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>
<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>
</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 Responses</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 Response</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__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<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>
</div>
<div class="section" id="nosql_05_0101__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0101__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0101__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0101__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -3,12 +3,12 @@
<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 supports 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 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>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__table35583162222" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0102__row8555111622220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0102__p12558121610224">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0102__table35583162222" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0102__row8555111622220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0102__p12558121610224">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_0102__p85609163228">Mandatory</p>
</th>
@ -41,30 +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 parameters</caption><thead align="left"><tr id="nosql_05_0102__row1057771613225"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0102__p1357918168225">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0102__p165811316172210">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_0002_p2369717883">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__p258211692211">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_0002_p93709171881">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__p3583416152216">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0102__row3577616142214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0102__p752726193010">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0102__p2058631610224">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_0002_p34785216504">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0102__p15588131618228">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_0002_p082192665218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0102__p15901316152217">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_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>
</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>
</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>
<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>
<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>
</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 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>
<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>
</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>
@ -89,20 +98,20 @@
</table>
</div>
</div>
<div class="section" id="nosql_05_0102__section56112166225"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0102__p1231417042713"><strong id="nosql_05_0102__b194017251639">Status code: 204</strong></p>
<p id="nosql_05_0102__p1761341682219">No response parameters</p>
<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 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>
<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>
</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 Responses</h4><p id="nosql_05_0102__p363014169224">None</p>
<div class="section" id="nosql_05_0102__section5629416132219"><h4 class="sectiontitle">Example Response</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__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<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>
<div class="section" id="nosql_05_0102__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0102__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0102__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0102__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -3,13 +3,13 @@
<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 supports 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 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>
<div class="section" id="nosql_05_0103__section201211223162813"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0103__p612242319282">PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/security-group</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__table17124102312283" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0103__row111230231281"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0103__p91251223102816">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__table17124102312283" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_05_0103__row111230231281"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0103__p91251223102816">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_0103__p41271523132813">Mandatory</p>
</th>
@ -42,30 +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 parameters</caption><thead align="left"><tr id="nosql_05_0103__row813912312280"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0103__p1514114233288">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0103__p2142172316280">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_0002_p2369717883">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__p9143162382815">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_0002_p93709171881">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__p714414239281">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0103__row1913919235288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0103__p634911518305">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0103__p2014616239288">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_0002_p34785216504">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0103__p161476239282">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_0002_p082192665218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0103__p61493232281">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_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>
</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>
</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>
<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>
<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>
</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 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>
<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>
</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>
@ -90,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 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>
<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>
</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>
@ -109,21 +118,21 @@
</table>
</div>
</div>
<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>
<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>
</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 Responses</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 Response</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"
}</pre>
</div>
<div class="section" id="nosql_05_0103__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0103__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_05_0103__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0103__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0103__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0103__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0103__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0103__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

File diff suppressed because it is too large Load Diff

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

@ -134,9 +134,9 @@
}
}</pre>
</div>
<div class="section" id="nosql_05_0115__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0115__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_05_0115__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0115__en-us_topic_0000001354223196_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0115__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0115__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_05_0115__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0115__en-us_topic_0000001354223196_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

292
docs/geminidb/api-ref/nosql_05_0156.html Normal file
View File

File diff suppressed because it is too large Load Diff

13
docs/geminidb/api-ref/nosql_05_0203.html Normal file
View File

@ -0,0 +1,13 @@
<a name="nosql_05_0203"></a><a name="nosql_05_0203"></a>
<h1 class="topictitle1">Historical APIs</h1>
<div id="body0000001405869145"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_06_3001.html">Backup and Restoration</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_05_0205.html">Parameter Templates</a></strong><br>
</li>
</ul>
</div>

18
docs/geminidb/api-ref/nosql_05_0205.html Normal file
View File

@ -0,0 +1,18 @@
<a name="nosql_05_0205"></a><a name="nosql_05_0205"></a>
<h1 class="topictitle1">Parameter Templates</h1>
<div id="body0000001405668673"><p id="nosql_05_0205__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_06_0218.html">Applying a Parameter Template</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_06_0219.html">Modifying Parameters of a Specified Instance</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_05_0203.html">Historical APIs</a></div>
</div>
</div>

413
docs/geminidb/api-ref/nosql_05_0211.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@ -3,14 +3,14 @@
<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 supports GeminiDB Cassandra instances.</p>
<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>
<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>
<div class="section" id="nosql_06_0004__section1978614557105"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0004__p17867554108">PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}</p>
<div class="section" id="nosql_06_0004__section1978614557105"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0004__p1922171654618">PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0004__table16788855181016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0004__row7786175571016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0004__p6788955141011">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0004__table16788855181016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_06_0004__row7786175571016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0004__p6788955141011">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_0004__p1378815556109">Mandatory</p>
</th>
@ -43,23 +43,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 parameters</caption><thead align="left"><tr id="nosql_06_0004__row27921155121015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0004__p379310552102">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 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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0004__p079375551014">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_0002_p2369717883">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__p179315551013">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_0002_p93709171881">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__p167944556102">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_0002_p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0004__row879275571012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0004__p9794105551012">X-Auth-Token</p>
<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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0004__p177941355101016">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_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_0004__p1079595581014">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_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_0004__p147950557100">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_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>
</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>
</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>
<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>
<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>
</tr>
</tbody>
@ -107,10 +116,10 @@
</table>
</div>
</div>
<div class="section" id="nosql_06_0004__section4802105541012"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0004__p1823917276130"><strong id="nosql_06_0004__b852863216520">Status code: 200</strong></p>
<p id="nosql_06_0004__p18497183717132">No response parameters</p>
<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 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>
<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>
</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">{
@ -122,11 +131,11 @@
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_06_0004__section158121755141019"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0004__p198131955101018">None</p>
<div class="section" id="nosql_06_0004__section158121755141019"><h4 class="sectiontitle">Example Response</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__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<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>
<div class="section" id="nosql_06_0004__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0004__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_06_0004__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0004__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@ -3,11 +3,11 @@
<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 supports 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 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>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__table7781724182014" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0007__row37512249200"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0007__p38052418201">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__table7781724182014" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_06_0007__row37512249200"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0007__p38052418201">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_0007__p2835249206">Mandatory</p>
</th>
@ -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 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>
<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>
</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>
@ -63,7 +63,7 @@
</table>
</div>
</div>
<div class="section" id="nosql_06_0007__section9144102420202"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0007__p314762412208"><strong id="nosql_06_0007__b53023254368">Status code: 200</strong></p>
<div class="section" id="nosql_06_0007__section9144102420202"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0007__p314762412208">Status code: 200</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__response_ShowInstanceConfigurationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="nosql_06_0007__row8150524192014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_06_0007__p2015482482017">Parameter</p>
</th>
@ -116,7 +116,6 @@
</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__p11887521222"><strong id="nosql_06_0007__b572293311218">Cluster</strong>, indicating that the instance is of the <span id="nosql_06_0007__text1672642991919">GeminiDB Influx</span> cluster type.</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>
@ -193,10 +192,10 @@
</table>
</div>
</div>
<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 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>
</div>
<div class="section" id="nosql_06_0007__section15329202420203"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0007__p033217245208"><strong id="nosql_06_0007__b4532817425">Status code: 200</strong></p>
<div class="section" id="nosql_06_0007__section15329202420203"><h4 class="sectiontitle">Example Response</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",
@ -216,9 +215,9 @@
} ]
}</pre>
</div>
<div class="section" id="nosql_06_0007__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0007__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_06_0007__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0007__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0007__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0007__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_06_0007__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0007__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -3,11 +3,11 @@
<h1 class="topictitle1">Obtaining Parameters of a Specified Parameter Template</h1>
<div id="body457810374224"><div class="section" id="nosql_06_0008__section85798371226"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0008__p758012372225">This API is used to obtain information about parameters of a specified parameter template.</p>
</div>
<div class="section" id="nosql_06_0008__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0008__p12792357124410">This API supports GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_06_0008__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0008__p12792357124410">This API can be used for GeminiDB Cassandra instances.</p>
</div>
<div class="section" id="nosql_06_0008__section45931737162213"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0008__p165941137102217">GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__table145971374225" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0008__row65968372220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0008__p125981637192213">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__table145971374225" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_06_0008__row65968372220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0008__p125981637192213">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_0008__p17599183720227">Mandatory</p>
</th>
@ -40,7 +40,7 @@
</div>
</div>
<div class="section" id="nosql_06_0008__section20613173712213"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0008__row1561433732215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0008__p4616143782218">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_06_0008__row1561433732215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0008__p4616143782218">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_0008__p146171737162218">Mandatory</p>
</th>
@ -63,7 +63,7 @@
</table>
</div>
</div>
<div class="section" id="nosql_06_0008__section0625153752220"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0008__p1262653772219"><strong id="nosql_06_0008__b15182133812444">Status code: 200</strong></p>
<div class="section" id="nosql_06_0008__section0625153752220"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0008__p1262653772219">Status code: 200</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__response_ShowConfigurationDetailResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="nosql_06_0008__row16281637122214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_06_0008__p663118372229">Parameter</p>
</th>
@ -198,10 +198,10 @@
</table>
</div>
</div>
<div class="section" id="nosql_06_0008__section177104373224"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_06_0008__p14641639152813">URI example<pre class="screen" id="nosql_06_0008__screen39602134018">GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06</pre>
<div class="section" id="nosql_06_0008__section177104373224"><h4 class="sectiontitle">Example Request</h4><div class="p" id="nosql_06_0008__p14641639152813">URI example<pre class="screen" id="nosql_06_0008__screen39602134018">GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06</pre>
</div>
</div>
<div class="section" id="nosql_06_0008__section77181537142220"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0008__p8719637122210"><strong id="nosql_06_0008__b53351345144915">Status code: 200</strong></p>
<div class="section" id="nosql_06_0008__section77181537142220"><h4 class="sectiontitle">Example Response</h4><p id="nosql_06_0008__p8719637122210">Status code: 200</p>
<p id="nosql_06_0008__p197201037142217">Success</p>
<pre class="screen" id="nosql_06_0008__screen9723153712219">{
"id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr06",
@ -222,9 +222,9 @@
} ]
}</pre>
</div>
<div class="section" id="nosql_06_0008__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0008__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_06_0008__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0008__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0008__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0008__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_06_0008__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0008__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -3,11 +3,11 @@
<h1 class="topictitle1">Deleting a Parameter Template</h1>
<div id="body1271015486247"><div class="section" id="nosql_06_0009__section137101448132411"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0009__p1271216483246">This API is used to delete a specified parameter template.</p>
</div>
<div class="section" id="nosql_06_0009__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0009__p12792357124410">This API supports GeminiDB Cassandra instances.</p>
<div class="section" id="nosql_06_0009__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0009__p12792357124410">This API can be used for GeminiDB Cassandra instances.</p>
</div>
<div class="section" id="nosql_06_0009__section3722448152417"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0009__p1722184819242">DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0009__table1572584818244" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0009__row17723748202418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0009__p11725948132411">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0009__table1572584818244" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_06_0009__row17723748202418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0009__p11725948132411">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_0009__p772614818248">Mandatory</p>
</th>
@ -40,7 +40,7 @@
</div>
</div>
<div class="section" id="nosql_06_0009__section6735144817243"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0009__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0009__row167361448152413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0009__p373844882414">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0009__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_06_0009__row167361448152413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0009__p373844882414">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_0009__p167391948142413">Mandatory</p>
</th>
@ -64,16 +64,16 @@
</div>
</div>
<div class="section" id="nosql_06_0009__section15745134811244"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0009__p184809582140"><strong id="nosql_06_0009__b11722133584520">Status code: 200</strong></p>
<p id="nosql_06_0009__p10745204818241">No response parameters</p>
<p id="nosql_06_0009__p10745204818241">None</p>
</div>
<div class="section" id="nosql_06_0009__section1674644810249"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_06_0009__p55380575282">URI example<pre class="screen" id="nosql_06_0009__screen71551514144312">DELETE https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06</pre>
<div class="section" id="nosql_06_0009__section1674644810249"><h4 class="sectiontitle">Example Request</h4><div class="p" id="nosql_06_0009__p55380575282">URI example<pre class="screen" id="nosql_06_0009__screen71551514144312">DELETE https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06</pre>
</div>
</div>
<div class="section" id="nosql_06_0009__section2754184822415"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0009__p6755648142419">None</p>
<div class="section" id="nosql_06_0009__section2754184822415"><h4 class="sectiontitle">Example Response</h4><p id="nosql_06_0009__p6755648142419">None</p>
</div>
<div class="section" id="nosql_06_0009__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0009__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_06_0009__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0009__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0009__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0009__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_06_0009__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0009__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

144
docs/geminidb/api-ref/nosql_06_0218.html Normal file
View File

File diff suppressed because it is too large Load Diff

147
docs/geminidb/api-ref/nosql_06_0219.html Normal file
View File

File diff suppressed because it is too large Load Diff

15
docs/geminidb/api-ref/nosql_06_3001.html Normal file
View File

@ -0,0 +1,15 @@
<a name="nosql_06_3001"></a><a name="nosql_06_3001"></a>
<h1 class="topictitle1">Backup and Restoration</h1>
<div id="body0000002079865465"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_06_3002.html">Querying an Automated Backup Policy</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_05_0203.html">Historical APIs</a></div>
</div>
</div>

230
docs/geminidb/api-ref/nosql_06_3002.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -145,7 +145,7 @@
</thead>
<tbody><tr id="nosql_10_0100__row19535171415411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="nosql_10_0100__p17927133962513">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nosql_10_0100__p29271396253">Array of objects (<a href="#nosql_10_0100__response_SlowlogResult">Table 5</a>)</p>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nosql_10_0100__p29271396253">Array of objects in <a href="#nosql_10_0100__response_SlowlogResult">Table 5</a></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="nosql_10_0100__p199272039192515">Task list.</p>
</td>
@ -195,7 +195,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p17684181512713">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p868417156271">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="nosql_10_0100__p14684131512716"><strong id="nosql_10_0100__b34500619895746">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_10_0100__b188302476295746">Z</strong> indicates the time zone offset. For example, in the Beijing time zone, the offset is <strong id="nosql_10_0100__b69732997395746">+0800</strong>.</p>
<p id="nosql_10_0100__p14684131512716"><strong id="nosql_10_0100__b1312021964316">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="nosql_10_0100__b112031915435">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_10_0100__row65558141443"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p18685141519277">end_time</p>
@ -203,7 +203,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p1685315172713">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p2685131522716">End time in the yyyy-mm-ddThh:mm:ssZ format.</p>
<p id="nosql_10_0100__p186853156279"><strong id="nosql_10_0100__b114983881495746">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_10_0100__b181477973595746">Z</strong> indicates the time zone offset. For example, in the Beijing time zone, the offset is <strong id="nosql_10_0100__b72672384795746">+0800</strong>.</p>
<p id="nosql_10_0100__p186853156279"><strong id="nosql_10_0100__b1177732216439">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="nosql_10_0100__b177771122114310">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_10_0100__row12753631275"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p166851615112718">progress</p>
@ -281,9 +281,9 @@
} ]
}</pre>
</div>
<div class="section" id="nosql_10_0100__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_10_0100__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<div class="section" id="nosql_10_0100__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_10_0100__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_10_0100__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_10_0100__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
<div class="section" id="nosql_10_0100__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_10_0100__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>

18
docs/geminidb/api-ref/nosql_12_0005.html Normal file
View File

@ -0,0 +1,18 @@
<a name="nosql_12_0005"></a><a name="nosql_12_0005"></a>
<h1 class="topictitle1">APIs v3.1</h1>
<div id="body0000002252637753"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_12_0006.html">Versions and Specifications</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_12_0007.html">Backup and Restoration</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_12_0008.html">Parameter Templates</a></strong><br>
</li>
</ul>
</div>

18
docs/geminidb/api-ref/nosql_12_0006.html Normal file
View File

@ -0,0 +1,18 @@
<a name="nosql_12_0006"></a><a name="nosql_12_0006"></a>
<h1 class="topictitle1">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>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_12_0005.html">APIs v3.1</a></div>
</div>
</div>

20
docs/geminidb/api-ref/nosql_12_0007.html Normal file
View File

@ -0,0 +1,20 @@
<a name="nosql_12_0007"></a><a name="nosql_12_0007"></a>
<h1 class="topictitle1">Backup and Restoration</h1>
<div id="body0000002217518104"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_05_0211.html">Querying Backups (Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_api_0030.html">Querying an Automated Backup Policy</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_12_0005.html">APIs v3.1</a></div>
</div>
</div>

19
docs/geminidb/api-ref/nosql_12_0008.html Normal file
View File

@ -0,0 +1,19 @@
<a name="nosql_12_0008"></a><a name="nosql_12_0008"></a>
<h1 class="topictitle1">Parameter Templates</h1>
<div id="body0000002217677916"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_06_0002.html">Obtaining Parameter Templates</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_06_0005.html">Applying a Parameter Template</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_06_0006.html">Modifying Parameters of a Specified Instance</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_12_0005.html">APIs v3.1</a></div>
</div>
</div>

14
docs/geminidb/api-ref/nosql_12_0012.html Normal file
View File

@ -0,0 +1,14 @@
<a name="nosql_12_0012"></a><a name="nosql_12_0012"></a>
<h1 class="topictitle1">API v4</h1>
<div id="body0000002295317545"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_12_0013.html">Querying Backups</a></strong><br>
</li>
</ul>
</div>

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